\r\n

51Degrees Pipeline Java  4.4

51Degrees Pipeline for Java

fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneAspectEngine< TData extends AspectData, TProperty extends FiftyOneAspectPropertyMetaData > Interface Template Reference

Detailed Description

51Degrees specific Engine interface.

This adds the concept of license keys to the standard Engine interface.

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

[legend]

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

[legend]

Public Member Functions

CloseableIterableProfileMetaData >  getProfiles ()
Get all profiles contained in the data set which the engine is using. More...
ProfileMetaData  getProfile (int profileId) throws Exception
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) throws Exception
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) throws Exception
Get the component with the specified property and value name from the data set. More...

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

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

◆ getValue()

ValueMetaData fiftyone.pipeline.engines.fiftyone.flowelements.FiftyOneAspectEngine< TData extends AspectData, TProperty extends FiftyOneAspectPropertyMetaData >.getValue ( String   propertyName,
String   valueName  
) throws Exception

Get the component with the specified property and value name from the data set.

Parameters
propertyName - the name of the property which the value belongs to
valueName - the name of the value
Returns
the value or, null if not found
Exceptions
Exception - if an exception was thrown internally