Detailed Description

Base class for on-premise aspect engines.

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.OnPremiseAspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >:

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

Public Member Functions

	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...

Protected Member Functions

void	setTempDataDirPath (String tempDataDirPath)
void	managedResourcesCleanup ()
Protected Member Functions inherited from fiftyone.pipeline.engines.flowelements.AspectEngineBase< TData, TProperty >
abstract void	processEngine (FlowData flowData, TData aspectData) throws Exception Extending classes must implement this method. More...
final void	processInternal (FlowData flowData) throws Exception Implementation of method from the base class FlowElementBase. More...
void	managedResourcesCleanup ()

Constructor & Destructor Documentation

◆ OnPremiseAspectEngineBase()

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.

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

Member Function Documentation

◆ getDataFilePublishedDate() [1/2]

abstract Date fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >.getDataFilePublishedDate

(

String

dataFileIdentifier

)

abstract

Get the date/time that the specified data file was published.

Parameters: dataFileIdentifier - the identifier of the data file to get meta data for. This parameter is ignored if the engine only has one data files

Returns: data the data file was published

◆ getDataFilePublishedDate() [2/2]

Date fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >.getDataFilePublishedDate

(

)

Get the date/time that the default data file was published.

This takes no identifier and is designed for engines which only use a single data file.

Returns: data the data file was published

◆ getDataFileUpdateAvailableTime() [1/2]

abstract Date fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >.getDataFileUpdateAvailableTime

(

String

dataFileIdentifier

)

abstract

Get the date/time that an update is expected to be available for the specified data file.

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: date the next data file update is available

◆ getDataFileUpdateAvailableTime() [2/2]

Date fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >.getDataFileUpdateAvailableTime

(

)

Get the date/time that an update is expected to be available for the default data file.

This takes no identifier and is designed for engines which only use a single data file.

Returns: date the next data file update is available

51Degrees Pipeline Java 4.1Newer Version 4.2

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