Detailed Description

The Pipeline groups together FlowElements and is a factory for FlowData which serves as the evidence, results, and a means to access the Pipeline's processing capabilities.

A FlowData is linked to the Pipeline which created it, and cannot function without it.

Inheritance diagram for fiftyone.pipeline.core.flowelements.Pipeline:

[legend]

Collaboration diagram for fiftyone.pipeline.core.flowelements.Pipeline:

[legend]

Public Member Functions

FlowData	createFlowData () Create a new FlowData instance linked to this Pipeline. More...
EvidenceKeyFilter	getEvidenceKeyFilter () Get the evidence keys used by all the FlowElements in the Pipeline. More...
boolean	isConcurrent () True if any of the FlowElements in this pipeline will create multiple threads and execute in parallel. More...
boolean	isClosed () Indicates whether the Pipeline has been closed using the close() method, either explicitly or as a result of a 'try with resource'. More...
void	addService (PipelineService service) Add a service to be used by this Pipeline. More...
boolean	addServices (Collection< PipelineService > services) Add a collection of services. More...
List< PipelineService >	getServices () Returns the an unmodified list of services that this Pipeline is monitoring. More...
< T extends FlowElement > T	getElement (Class< T > type) Get the specified element from the pipeline. More...
List< FlowElement >	getFlowElements () Get list of the flow elements that are part of this pipeline. More...
Map< String, Map< String, ElementPropertyMetaData > >	getElementAvailableProperties () Get the map of available properties for an FlowElement#getElementDataKey(). More...

Member Function Documentation

◆ addService()

void fiftyone.pipeline.core.flowelements.Pipeline.addService

(

PipelineService

service

)

Add a service to be used by this Pipeline.

If the service supports Closeable or AutoCloseable, it will be closed automatically when the pipeline is closed.

Parameters: service -

◆ addServices()

boolean fiftyone.pipeline.core.flowelements.Pipeline.addServices

(

Collection< PipelineService >

services

)

Add a collection of services.

If the services support Closeable or AutoCloseable, they will be closed automatically when the pipeline is closed.

Parameters: services - to be added

Returns: true if successfully added

◆ createFlowData()

FlowData fiftyone.pipeline.core.flowelements.Pipeline.createFlowData

(

)

Create a new FlowData instance linked to this Pipeline.

The resulting FlowData's FlowData#process() method will cause the FlowData to be processed.

Returns: a new FlowData linked to this Pipeline

◆ getElement()

<T extends FlowElement> T fiftyone.pipeline.core.flowelements.Pipeline.getElement

(

Class< T >

type

)

Get the specified element from the pipeline.

If the pipeline contains multiple elements of the requested type, this method will return null.

Parameters: type - the type of the FlowElement to get; <T> - the type of the FlowElement to get

Returns: An instance of the specified FlowElement if the pipeline contains one. Null is returned if there is no such instance or there are multiple instances of that type.

◆ getElementAvailableProperties()

Map<String, Map<String, ElementPropertyMetaData> > fiftyone.pipeline.core.flowelements.Pipeline.getElementAvailableProperties

(

)

Get the map of available properties for an FlowElement#getElementDataKey().

The map returned contains the ElementPropertyMetaDatas keyed on the name field.

Returns: an immutable map of available properties

◆ getEvidenceKeyFilter()

EvidenceKeyFilter fiftyone.pipeline.core.flowelements.Pipeline.getEvidenceKeyFilter

(

)

Get the evidence keys used by all the FlowElements in the Pipeline.

Returns: merged list of evidence keys

◆ getFlowElements()

List<FlowElement> fiftyone.pipeline.core.flowelements.Pipeline.getFlowElements

(

)

Get list of the flow elements that are part of this pipeline.

Returns: an immutable list of the flow elements

◆ getServices()

List<PipelineService> fiftyone.pipeline.core.flowelements.Pipeline.getServices

(

)

Returns the an unmodified list of services that this Pipeline is monitoring.

Returns: immutable list of pipeline services

◆ isClosed()

boolean fiftyone.pipeline.core.flowelements.Pipeline.isClosed

(

)

Indicates whether the Pipeline has been closed using the close() method, either explicitly or as a result of a 'try with resource'.

Returns: true if the Pipeline has been closed

◆ isConcurrent()

boolean fiftyone.pipeline.core.flowelements.Pipeline.isConcurrent

(

)

True if any of the FlowElements in this pipeline will create multiple threads and execute in parallel.

False otherwise.

Returns: true if any FlowElements are concurrent

51Degrees Pipeline Java 4.4

fiftyone.pipeline.core.flowelements.Pipeline Interface Reference