Package com.vernaio.aivis.engine.v2.base.sdk

Interface EngineTabularData

public interface EngineTabularData

Interface for handling engine tabular data.

Method Summary

Modifier and Type	Method	Description
void	addBooleanColumn(String columnId, List<? extends IDtoBooleanCell> data)	Add boolean column to this tabular data context.
void	addFloatColumn(String columnId, List<? extends IDtoFloatCell> data)	Add float column to this tabular data context.
void	addStringColumn(String columnId, List<? extends IDtoStringCell> data)	Add string column to this tabular data context.
void	destroy()	Destroy this tabular data context and all its data.
List<? extends IDtoBooleanCell>	getBooleanColumn(String columnId)	Get boolean data of a column with given columnId from this tabular data context.
List<? extends IDtoFloatCell>	getFloatColumn(String columnId)	Get float data of a column with given columnId from this tabular data context.
List<? extends IDtoStringCell>	getStringColumn(String columnId)	Get string data of a column with given columnId from this tabular data context.
void	readFiles(IDtoTabularFilesReaderConfig config)	Read and ingest files to tabular data context.

Method Details

destroy

void destroy()
      throws WrongFlavourException,
MissingLibraryException,
EngineException

Destroy this tabular data context and all its data. It's always safe to destroy a data context. Internally the destruction only takes place after all references to this context have been released.

Throws:

WrongFlavourException

MissingLibraryException

EngineException

addBooleanColumn

void addBooleanColumn(String columnId,
 List<? extends IDtoBooleanCell> data)
               throws WrongFlavourException,
MissingLibraryException,
EngineException

Add boolean column to this tabular data context. Calling this method on an existing column with respective type allows to add data to this column (overriding duplicated row ids; for duplicated row ids in the given List, the last one will determine the value). Trying to add data to an already existing synthesized column or a column of wrong type will result in an exception.

Parameters:

columnId - Column-ID as string

data - List of DtoBooleanCell

Throws:

WrongFlavourException

MissingLibraryException

EngineException

addFloatColumn

void addFloatColumn(String columnId,
 List<? extends IDtoFloatCell> data)
             throws EngineException,
MissingLibraryException,
WrongFlavourException

Add float column to this tabular data context. Calling this method on an existing column with respective type allows to add data to this column (overriding duplicated row ids; for duplicated row ids in the given List, the last one will determine the value). Trying to add data to an already existing synthesized column or a column of wrong type will result in an exception.

Parameters:

columnId - Column-ID as string

data - List of DtoFloatCell

Throws:

EngineException

MissingLibraryException

WrongFlavourException

addStringColumn

void addStringColumn(String columnId,
 List<? extends IDtoStringCell> data)
              throws EngineException,
MissingLibraryException,
WrongFlavourException

Add string column to this tabular data context. Calling this method on an existing column with respective type allows to add data to this column (overriding duplicated row ids; for duplicated row ids in the given List, the last one will determine the value). Trying to add data to an already existing synthesized column or a column of wrong type will result in an exception.

Parameters:

columnId - Column-ID as string

data - List of DtoStringCell

Throws:

EngineException

MissingLibraryException

WrongFlavourException

getBooleanColumn

List<? extends IDtoBooleanCell> getBooleanColumn(String columnId)
                                          throws EngineException,
MissingLibraryException,
WrongFlavourException

Get boolean data of a column with given columnId from this tabular data context. Requesting a non-existing column or a column of wrong type will result in an exception.

Parameters:

columnId - Column-ID as string

Returns:

List of DtoBooleanCell

Throws:

EngineException

MissingLibraryException

WrongFlavourException

getFloatColumn

List<? extends IDtoFloatCell> getFloatColumn(String columnId)
                                      throws EngineException,
MissingLibraryException,
WrongFlavourException

Get float data of a column with given columnId from this tabular data context. Requesting a non-existing column or a column of wrong type will result in an exception.

Parameters:

columnId - Column-ID as String

Returns:

List of DtoFloatCell

Throws:

EngineException

MissingLibraryException

WrongFlavourException

getStringColumn

List<? extends IDtoStringCell> getStringColumn(String columnId)
                                        throws WrongFlavourException,
MissingLibraryException,
EngineException

Get string data of a column with given columnId from this tabular data context. Requesting a non-existing column or a column of wrong type will result in an exception.

Parameters:

columnId - Column-ID as string

Returns:

List of DtoStringCell

Throws:

WrongFlavourException

MissingLibraryException

EngineException

readFiles

void readFiles(IDtoTabularFilesReaderConfig config)
        throws WrongFlavourException,
MissingLibraryException,
EngineException

Read and ingest files to tabular data context.

Parameters:

config - Instance of tabular files reader config

Throws:

WrongFlavourException

MissingLibraryException

EngineException