51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

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

Detailed Description

AspectEngines are a subset of FlowElements which follow a certain defined structure.

They have defined inputs, outputs and other common methods/properties. They use certain pieces of evidence contained within the FlowData (e.g. User-Agent) to determine the properties of an Aspect (e.g. hardware device). By defining an AspectEngine, 51Degrees FlowElements can easily share common functionality through base classes and convention.

Third parties can also benefit by extending AspectEngineBase to make use of its generic methods.

A major defining feature of an AspectEngine is that it uses a data file which will be kept up to date by the DataUpdateService.

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

[legend]

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

[legend]

Public Member Functions

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

Public Member Functions inherited from fiftyone.pipeline.core.flowelements.FlowElement< TData extends ElementData, TProperty extends ElementPropertyMetaData >

void  process (FlowData data) throws Exception
Carry out whatever operations this element is designed to do using the FlowData passed. More...
void  addPipeline (Pipeline pipeline)
Called when this element is added to a pipeline. More...
EvidenceKeyFilter  getEvidenceKeyFilter ()
Get a filter that will only include the evidence keys that this element can make use of. More...
String  getElementDataKey ()
Get the string name of the key used to access the data populated by this element in the FlowData. More...
TypedKey< TData >  getTypedDataKey ()
Get the typed data key used for retrieving strongly typed element data. More...
List< TProperty >  getProperties ()
Get details of the properties that this element can populate. More...
TProperty  getProperty (String name)
Get a property from the properties that this element can populate using its name. More...
boolean  isConcurrent ()
if true, requires that the Pipeline guards against concurrent access to FlowData structures More...
boolean  isClosed ()
Indicates whether the element has been closed using the close() method, either explicitly or as a result of a 'try with resource'. More...
DataFactory< TData >  getDataFactory ()
Get the factory used to create the element data instances that are populated by this flow element. More...

Member Function Documentation