51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.core.flowelements.FlowElement< TData extends ElementData, TProperty extends ElementPropertyMetaData > Interface Template Reference

Detailed Description

A component that processes a FlowData (by examining its evidence, or by examining data processed by other FlowElements).

It MAY contribute to the FlowData by adding its own data, and if it does, getElementDataKey() MUST be non-null.

This class is primarily of use to creators of FlowElements, end users of Pipelines are unlikely to use this interface in its raw form.

The type parameter indicates the type of the data structure created by this element

Parameters
<TData> - the type of element 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.core.flowelements.FlowElement< TData extends ElementData, TProperty extends ElementPropertyMetaData >:

[legend]

Collaboration diagram for fiftyone.pipeline.core.flowelements.FlowElement< TData extends ElementData, TProperty extends ElementPropertyMetaData >:

[legend]

Classes

interface  DataFactory
Data factory interface which needs an implementation specific to a FlowElement implementation in order to construct element data when calling the FlowData#getOrAdd(String, DataFactory) method. More...

Public Member Functions

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

◆ process()

void fiftyone.pipeline.core.flowelements.FlowElement< TData extends ElementData, TProperty extends ElementPropertyMetaData >.process ( FlowData   data ) throws Exception

Carry out whatever operations this element is designed to do using the FlowData passed.

Parameters
data - the FlowData instance that provides input evidence and carries the output data to the user.
Exceptions
Exception - if there was an error while processing. Note that the internal errors will only result in an exception if the Pipeline has been configured not to suppress exceptions using the PipelineBuilder#setSuppressProcessException(boolean) option