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:
Collaboration diagram for fiftyone.pipeline.core.flowelements.Pipeline:
Public Member Functions
FlowData | createFlowData () |
EvidenceKeyFilter | getEvidenceKeyFilter () |
boolean | isConcurrent ()
True if any of the FlowElements in this pipeline will create multiple threads and execute in parallel. More...
|
boolean | isClosed () |
< 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
◆ 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
◆ isClosed()
◆ 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