\r\n

51Degrees Pipeline Python  4.3

51Degrees Pipeline for Python
  • pipeline-python
  • fiftyone_pipeline_core
  • fiftyone_pipeline_core
  • flowelement
  • FlowElement

pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement Class Reference

Detailed Description

A FlowElement is placed inside a Pipeline It receives Evidence via a FlowData object It uses this to optionally create ElementData on the FlowData Any errors in processing are caught in the FlowData's errors object.

Inheritance diagram for pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement:

[legend]

Collaboration diagram for pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement:

[legend]

Public Member Functions

def  __init__ (self)
List of Pipelines the FlowElement has been added to. More...
def  process (self, flowdata)
Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method. More...
def  on_registration (self, pipeline)
Function called when an element is added to the pipeline. More...
def  get_evidence_key_filter (self)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
def  filter_evidence (self, flowdata)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
def  filter_evidence_key (self, key)
Filter FlowData.evidence using the flowElement's EvidenceKeyFilter with the property key of evidence of interest. More...
def  process_internal (self, flowdata)
The method behind FlowElement.Process - it is called by the process() function. More...
def  get_properties (self)
Get the FlowElement.properties of a FlowElement. More...

Public Attributes

 pipelines
 properties
 datakey
 exclude_from_messages

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ filter_evidence()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement.filter_evidence (   self,
  flowdata  
)

Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.

@type flowdata: FlowData

Parameters
flowdata - a FlowData that has some Evidence set

@rtype: dict

Returns
: Returns a dictionary of evidence that has passed the filter

◆ filter_evidence_key()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement.filter_evidence_key (   self,
  key  
)

Filter FlowData.evidence using the flowElement's EvidenceKeyFilter with the property key of evidence of interest.

@type key: string

Parameters
key - the property key being sought within FlowData.evidence

@rtype: dict

Returns
: Returns a dictionary containing the property key and the evidence related to it as its value

◆ get_evidence_key_filter()

◆ get_properties()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement.get_properties (   self )

Get the FlowElement.properties of a FlowElement.

This is usually overridden by specific flowElements.

@rtype: DataPropertyDictionary

Returns
: Returns dictionary of the FlowElement's properties

◆ on_registration()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement.on_registration (   self,
  pipeline  
)

Function called when an element is added to the pipeline.

Used for example, for elements that depend on other elements in a pipeline

@type pipeline: Pipeline

Parameters
pipeline - Pipeline the element has been added to

◆ process()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement.process (   self,
  flowdata  
)

Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method.

@type flowdata: FlowData

Parameters
flowdata - FlowData to be processed

@rtype: mixed

Returns
: Returns whatever the self.processInternal method is set to return

◆ process_internal()

def pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.flowelement.FlowElement.process_internal (   self,
  flowdata  
)

The method behind FlowElement.Process - it is called by the process() function.

It is usually overridden by specific flowElements to do their core work.

@type flowdata: FlowData

Parameters
flowdata - FlowData to be processed

@rtype: bool

Returns
: Returns True

Reimplemented in pipeline-python.fiftyone_pipeline_core.tests.test_javascriptbuilder.DelayedExecutionEngine3, pipeline-python.fiftyone_pipeline_core.tests.test_javascriptbuilder.DelayedExecutionEngine2, pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.javascriptbuilder.JavascriptBuilderElement, pipeline-python.fiftyone_pipeline_core.examples.client_side_evidence_custom_flow_element.AstrologyFlowElement, pipeline-python.fiftyone_pipeline_core.tests.test_javascriptbuilder.DelayedExecutionEngine1, pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.sequenceelement.SequenceElement, pipeline-python.fiftyone_pipeline_core.tests.test_javascriptbuilder.TestEngine, pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.jsonbundler.JSONBundlerElement, pipeline-python.fiftyone_pipeline_core.fiftyone_pipeline_core.setheaderelement.SetHeaderElement, pipeline-python.fiftyone_pipeline_core.tests.classes.apvflowelement.APVFlowElement, pipeline-python.fiftyone_pipeline_core.tests.classes.exampleflowelement1.ExampleFlowElement1, pipeline-python.fiftyone_pipeline_core.tests.classes.exampleflowelement2.ExampleFlowElement2, pipeline-python.fiftyone_pipeline_core.tests.classes.errorflowdata.ErrorFlowData, and pipeline-python.fiftyone_pipeline_core.tests.classes.stopflowdata.StopFlowData.