\r\n

51Degrees Pipeline Java 4.4

51Degrees Pipeline for Java

Detailed Description

Base class for AspectEngines to extend.

This implements the data update service and missing property service along with everything already implemented by FlowElementBase.

See also: Specification

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

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

Public Member Functions

	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.core.flowelements.FlowElementBase< TData extends ElementData, TProperty extends ElementPropertyMetaData >

FlowElementBase (Logger logger, ElementDataFactory< TData > elementDataFactory)

Construct a new instance of the FlowElement. More...

void addPipeline (Pipeline pipeline) List< Pipeline > getPipelines ()

Get a unmodifiable list of the Pipelines that this element has been added to. More...

abstract String getElementDataKey () abstract EvidenceKeyFilter getEvidenceKeyFilter () abstract List< TProperty > getProperties () TProperty getProperty (String name) TypedKey< TData > getTypedDataKey () void process (FlowData data) throws Exception DataFactory< TData > getDataFactory () boolean isConcurrent () boolean isClosed () void close () throws Exception

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

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

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

Protected Member Functions

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 ()

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

abstract void processInternal (FlowData data) throws Exception

Abstract method to be overridden by a FlowElement author. More...

abstract void managedResourcesCleanup ()

Cleanup any managed resources that the element is using.

abstract void unmanagedResourcesCleanup ()

Cleanup any unmanaged resources that the element is using.

void close (boolean closing)

Protected Attributes

MissingPropertyService missingPropertyService

FlowCache cache = null

Protected Attributes inherited from fiftyone.pipeline.core.flowelements.FlowElementBase< TData extends ElementData, TProperty extends ElementPropertyMetaData >

final Logger logger TypedKey< TData > typedKey = null

Constructor & Destructor Documentation

◆ AspectEngineBase()

fiftyone.pipeline.engines.flowelements.AspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >.AspectEngineBase	(	Logger	logger,
		ElementDataFactory< TData >	aspectDataFactory
	)

Construct a new instance of the AspectEngine.

Parameters: logger - logger instance to use for logging; aspectDataFactory - the factory to use when creating a TData instance

Member Function Documentation

◆ processEngine()

abstract void fiftyone.pipeline.engines.flowelements.AspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >.processEngine	(	FlowData	flowData,
		TData	aspectData
	)		throws Exception

abstract protected

Extending classes must implement this method.

It should perform the required processing and update the specified aspect data instance.

Parameters: flowData - the FlowData instance that provides the evidence; aspectData - the AspectData instance to populate with the results of processing

Exceptions: Exception - if there was an exception during processing

◆ processInternal()

final void fiftyone.pipeline.engines.flowelements.AspectEngineBase< TData extends AspectData, TProperty extends AspectPropertyMetaData >.processInternal

(

flowData

)

throws Exception

protected

Implementation of method from the base class FlowElementBase.

This exists to centralise the results caching logic.

Parameters: flowData - the FlowData instance that provides the evidence and holds the result.

Exceptions: Exception - if there was an exception during processing