51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBase< TData extends AspectData, TProperty extends FiftyOneAspectPropertyMetaData > Class Template Reference abstract

Detailed Description

51Degrees specific engine base class.

This adds the concept of license keys to the standard Engine base class.

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.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBase< TData extends AspectData, TProperty extends FiftyOneAspectPropertyMetaData >:

[legend]

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

[legend]

Public Member Functions

 FiftyOneOnPremiseAspectEngineBase (Logger logger, ElementDataFactory< TData > aspectDataFactory, String tempDataFilePath)
Construct a new instance of the FiftyOneOnPremiseAspectEngineBase. More...
TypedKey< TData >  getTypedDataKey ()
abstract CloseableIterableProfileMetaData >  getProfiles ()
ProfileMetaData  getProfile (int profileId)
abstract CloseableIterableComponentMetaData >  getComponents ()
ComponentMetaData  getComponent (String name)
abstract CloseableIterableValueMetaData >  getValues ()
ValueMetaData  getValue (String propertyName, String valueName)

Public Member Functions inherited from fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >

 OnPremiseAspectEngineBase (Logger logger, ElementDataFactory< TData > aspectDataFactory, String tempDataDirPath)
Construct a new instance of the OnPremiseAspectEngine. More...
List< AspectEngineDataFile >  getDataFiles ()
String  getTempDataDirPath ()
AspectEngineDataFile  getDataFileMetaData (String dataFileIdentifier)
AspectEngineDataFile  getDataFileMetaData ()
abstract Date  getDataFilePublishedDate (String dataFileIdentifier)
Get the date/time that the specified data file was published. More...
Date  getDataFilePublishedDate ()
Get the date/time that the default data file was published. More...
abstract Date  getDataFileUpdateAvailableTime (String dataFileIdentifier)
Get the date/time that an update is expected to be available for the specified data file. More...
Date  getDataFileUpdateAvailableTime ()
Get the date/time that an update is expected to be available for the default data file. More...
abstract void  refreshData (String dataFileIdentifier)
abstract void  refreshData (String dataFileIdentifier, byte[] data)
void  addDataFile (AspectEngineDataFile dataFile)
TypedKey< TData >  getTypedDataKey ()

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

 AspectEngineBase (Logger logger, ElementDataFactory< TData > aspectDataFactory)
Construct a new instance of the AspectEngine. More...
TypedKey< TData >  getTypedDataKey ()
abstract List< TProperty >  getProperties ()
abstract String  getDataSourceTier ()
void  setCache (FlowCache cache)
void  setLazyLoading (LazyLoadingConfiguration configuration)
LazyLoadingConfiguration  getLazyLoadingConfiguration ()
ExecutorService  getExecutor ()

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

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.fiftyone.flowelements.FiftyOneAspectEngine< TData, TProperty >

CloseableIterableProfileMetaData >  getProfiles ()
Get all profiles contained in the data set which the engine is using. More...
ProfileMetaData  getProfile (int profileId)
Get the profile with the unique profile id from the data set. More...
CloseableIterableComponentMetaData >  getComponents ()
Get all data components contained in the data set which the engine is using e.g. More...
ComponentMetaData  getComponent (String name)
Get the component with the specified name from the data set. More...
CloseableIterableValueMetaData >  getValues ()
Get all property values contained in the data set which the engine is using. More...
ValueMetaData  getValue (String propertyName, String valueName)
Get the component with the specified property and value name from the data set. More...

Constructor & Destructor Documentation

◆ FiftyOneOnPremiseAspectEngineBase()

fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneOnPremiseAspectEngineBase< TData extends AspectData, TProperty extends FiftyOneAspectPropertyMetaData >.FiftyOneOnPremiseAspectEngineBase ( Logger   logger,
ElementDataFactory< TData >   aspectDataFactory,
String   tempDataFilePath  
)

Construct a new instance of the FiftyOneOnPremiseAspectEngineBase.

Parameters
logger - logger instance to use for logging
aspectDataFactory - the factory to use when creating a TData instance
tempDataFilePath - the file where a temporary data file copy will be stored if one is created