Skip to content

CLASS ndi.database.ingestion_help

  A class that provides helper methods for ingesting raw data files into the database

Superclasses

none

Properties

none

Methods

Method Description
ingest create new documents that produce the ingestion of an ingestion_help_obj
ingestion_class the name of the ingestion class for this object
ingestion_help helper class with methods to help ingest raw data files

Methods help

ingest - create new documents that produce the ingestion of an ingestion_help_obj

[DOCS_OUT, DOC_IDS_REMOVE] = INGEST(INGESTION_HELP_OBJ)

  Perform the actions necessary to make a database-ingested representation of
  an INGESTION_HELP_OBJ object.

  DOCS_OUT is a cell array of ndi.document objects that comprise the new representation.
  DOCS_IDS_REMOVE are a cell array of ndi.document id numbers that should be removed
  (or not copied) from the existing database when creating the ingested version.

  In the abstract class, an empty cell array is returned for all outputs.

ingestion_class - the name of the ingestion class for this object

CNAME = INGESTION_CLASS(INGESTION_HELP_OBJ)

  Returns the class name of the object that should be created if this
  object class is ingested into the database (and won't have access to any raw
  data).

  For the base class, this simply returns empty.

ingestion_help - helper class with methods to help ingest raw data files

OBJ = ndi.database.ingestion_help()

    Documentation for ndi.database.ingestion_help/ingestion_help
       doc ndi.database.ingestion_help