51Degrees Pipeline for Java

fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement Class Reference

Detailed Description

The JsonBuilderElement takes accessible properties and adds the property key:values to the Json object.

[class] [constructor]

See also
Specification

Inheritance diagram for fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement:

[legend]

Collaboration diagram for fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement:

[legend]

Classes

class  PipelineConfig
 [constructor] More...

Public Member Functions

 JsonBuilderElement (Logger logger, ElementDataFactory< JsonBuilderData > elementDataFactory)
 Default constructor.
String getElementDataKey ()
EvidenceKeyFilter getEvidenceKeyFilter ()
List< ElementPropertyMetaData > getProperties ()

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.
void addPipeline (Pipeline pipeline)
List< Pipeline > getPipelines ()
 Get a unmodifiable list of the Pipelines that this element has been added to.
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.
void addPipeline (Pipeline pipeline)
 Called when this element is added to a pipeline.
EvidenceKeyFilter getEvidenceKeyFilter ()
 Get a filter that will only include the evidence keys that this element can make use of.
String getElementDataKey ()
 Get the string name of the key used to access the data populated by this element in the FlowData.
TypedKey< TData > getTypedDataKey ()
 Get the typed data key used for retrieving strongly typed element data.
List< TProperty > getProperties ()
 Get details of the properties that this element can populate.
TProperty getProperty (String name)
 Get a property from the properties that this element can populate using its name.
boolean isConcurrent ()
 if true, requires that the Pipeline guards against concurrent access to FlowData structures
default boolean hasLoadedProperties ()
 Whether the element knows all the property metadata and accepted Evidence it will expose.
boolean isClosed ()
 Indicates whether the element has been closed using the close() method, either explicitly or as a result of a 'try with resource'.
DataFactory< TData > getDataFactory ()
 Get the factory used to create the element data instances that are populated by this flow element.

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.
void addPipeline (Pipeline pipeline)
 Called when this element is added to a pipeline.
TypedKey< TData > getTypedDataKey ()
 Get the typed data key used for retrieving strongly typed element data.
TProperty getProperty (String name)
 Get a property from the properties that this element can populate using its name.
boolean isConcurrent ()
 if true, requires that the Pipeline guards against concurrent access to FlowData structures
default boolean hasLoadedProperties ()
 Whether the element knows all the property metadata and accepted Evidence it will expose.
boolean isClosed ()
 Indicates whether the element has been closed using the close() method, either explicitly or as a result of a 'try with resource'.
DataFactory< TData > getDataFactory ()
 Get the factory used to create the element data instances that are populated by this flow element.

Protected Member Functions

void processInternal (FlowData data) throws Exception
 Abstract method to be overridden by a FlowElement author.
void managedResourcesCleanup ()
 Cleanup any managed resources that the element is using.
void unmanagedResourcesCleanup ()
 Cleanup any unmanaged resources that the element is using.

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

void close (boolean closing)

Additional Inherited Members

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

◆ JsonBuilderElement()

fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement.JsonBuilderElement ( Logger logger,
ElementDataFactory< JsonBuilderData > elementDataFactory )

Default constructor.

Parameters
loggerThe logger.
elementDataFactoryThe element data factory.

Member Function Documentation

◆ getElementDataKey()

String fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement.getElementDataKey ( )

◆ getEvidenceKeyFilter()

EvidenceKeyFilter fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement.getEvidenceKeyFilter ( )

◆ getProperties()

List< ElementPropertyMetaData > fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement.getProperties ( )

◆ managedResourcesCleanup()

void fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement.managedResourcesCleanup ( )
protected

◆ processInternal()

void fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement.processInternal ( FlowData data) throws Exception
protected

Abstract method to be overridden by a FlowElement author.

This is the where the main processing happens, and is called by the process(FlowData) method of the base class.

Parameters
datacontaining evidence to process
Exceptions
Exceptionto be caught by process(FlowData)

Reimplemented from fiftyone.pipeline.core.flowelements.FlowElementBase< TData extends ElementData, TProperty extends ElementPropertyMetaData >.

◆ unmanagedResourcesCleanup()

void fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement.unmanagedResourcesCleanup ( )
protected