51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData > Interface Template Reference

Detailed Description

Aspect engine interface which processes data internally using a data file and populates the results.

Parameters
<TData> - the type of aspect data that the flow element will write to
<TProperty> - the type of meta data that the flow element will supply about the properties it populates.

Inheritance diagram for fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >:

[legend]

Collaboration diagram for fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >:

[legend]

Public Member Functions

List< AspectEngineDataFile >  getDataFiles ()
Details of the data files used by this engine. More...
void  refreshData (String dataFileIdentifier)
Causes the engine to reload data from the file at AspectEngineDataFile#getDataFilePath() for the data file matching the given identifier. More...
void  refreshData (String dataFileIdentifier, byte[] data)
Causes the engine to reload data from the specified byte[]. More...
String  getTempDataDirPath ()
The complete file path to the directory that is used by the engine to store temporary copies of any data files that it uses. More...
AspectEngineDataFile  getDataFileMetaData (String dataFileIdentifier)
Get the details of a specific data file used by this engine. More...
AspectEngineDataFile  getDataFileMetaData ()
Get the details the default data file used by this engine. More...
void  addDataFile (AspectEngineDataFile dataFile)
Add the specified data file to the engine. More...

Public Member Functions inherited from fiftyone.pipeline.engines.flowelements.AspectEngine< TData, TProperty >

void  setCache (FlowCache cache)
Set the results cache. More...
String  getDataSourceTier ()
Get the tier to which the current data source belongs. More...
void  setLazyLoading (LazyLoadingConfiguration configuration)
Configure lazy loading of results. More...
LazyLoadingConfiguration  getLazyLoadingConfiguration ()
Get the lazy loading configuration used for loading of results. More...
ExecutorService  getExecutor ()
Get the executor service to use when starting processing threads which are lazily loaded. More...

Member Function Documentation

◆ getDataFileMetaData() [1/2]

AspectEngineDataFile fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >.getDataFileMetaData ( String   dataFileIdentifier )

Get the details of a specific data file used by this engine.

Parameters
dataFileIdentifier - the identifier of the data file to get meta data for. This parameter is ignored if the engine only has one data file
Returns
the meta data associated with the specified data file, or null if the engine has no associated data files

◆ refreshData() [1/2]

void fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >.refreshData ( String   dataFileIdentifier )

Causes the engine to reload data from the file at AspectEngineDataFile#getDataFilePath() for the data file matching the given identifier.

Where the engine is built from a byte[], the overload with the byte[] parameter should be called instead. This method is thread-safe so parallel calls to process(FlowData) will resolve as normal.

Parameters
dataFileIdentifier - the identifier of the data file to update. Must match the value in AspectEngineDataFile#getIdentifier(). If the engine only has a single data file, this parameter is ignored

◆ refreshData() [2/2]

void fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngine< TData extends AspectData, TProperty extends AspectPropertyMetaData >.refreshData ( String   dataFileIdentifier,
byte []   data  
)

Causes the engine to reload data from the specified byte[].

Where the engine is built from a data file on disk, this will also update the data file with the new data. This method is thread-safe so parallel calls to 'Process' will resolve as normal.

Parameters
dataFileIdentifier - the identifier of the data file to update. Must match the value in AspectEngineDataFile#getIdentifier(). If the engine only has a single data file, this parameter is ignored
data - an in-memory representation of the new data file contents