\r\n

51Degrees Pipeline Java  4.4

51Degrees Pipeline for Java

fiftyone.pipeline.jsonbuilder.flowelements.JsonBuilderElement Class Reference

Detailed Description

[class] [constructor]

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

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. More...
String  getElementDataKey ()
Get the string name of the key used to access the data populated by this element in the FlowData. More...
EvidenceKeyFilter  getEvidenceKeyFilter ()
Get a filter that will only include the evidence keys that this element can make use of. More...
List< ElementPropertyMetaData >  getProperties ()
Get details of the properties that this element can populate. More...

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.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...
TypedKey< TData >  getTypedDataKey ()
Get the typed data key used for retrieving strongly typed element data. 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...

Protected Member Functions

void  processInternal (FlowData data) throws Exception
void  managedResourcesCleanup () void  unmanagedResourcesCleanup ()

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)

Constructor & Destructor Documentation

◆ JsonBuilderElement()

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

Default constructor.

Parameters
logger - The logger.
elementDataFactory - The element data factory.

Member Function Documentation

◆ getElementDataKey()

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

Get the string name of the key used to access the data populated by this element in the FlowData.

Returns
this element's data key string

Implements fiftyone.pipeline.core.flowelements.FlowElement< TData extends ElementData, TProperty extends ElementPropertyMetaData >.

◆ getEvidenceKeyFilter()

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

Get a filter that will only include the evidence keys that this element can make use of.

Returns
this element's EvidenceKeyFilter

Implements fiftyone.pipeline.core.flowelements.FlowElement< TData extends ElementData, TProperty extends ElementPropertyMetaData >.

◆ getProperties()

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

Get details of the properties that this element can populate.

Returns
this element's properties as a list

Implements fiftyone.pipeline.core.flowelements.FlowElement< TData extends ElementData, TProperty extends ElementPropertyMetaData >.

On This Page

Generated by doxygen 1.8.15