\r\n

51Degrees Pipeline Python  4.4

51Degrees Pipeline for Python

Search

Documentation

• fiftyone_pipeline_core
• flowelement
• FlowElement

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 fiftyone_pipeline_core.flowelement.FlowElement:

Collaboration diagram for fiftyone_pipeline_core.flowelement.FlowElement:

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__()

def fiftyone_pipeline_core.flowelement.FlowElement.__init__

(

self

)

List of Pipelines the FlowElement has been added to.

Reimplemented in tests.test_javascriptbuilder.DelayedExecutionEngine3, tests.test_javascriptbuilder.DelayedExecutionEngine2, tests.test_javascriptbuilder.DelayedExecutionEngine1, tests.test_javascriptbuilder.CookieEngine, examples.client_side_evidence_custom_flow_element.AstrologyFlowElement, tests.test_engines.ExampleAspectEngine, fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine, fiftyone_pipeline_core.sequenceelement.SequenceElement, fiftyone_pipeline_core.jsonbundler.JSONBundlerElement, fiftyone_pipeline_core.setheaderelement.SetHeaderElement, tests.test_javascriptbuilder.TestEngine, tests.classes.apvflowelement.APVFlowElement, tests.classes.exampleflowelement2.ExampleFlowElement2, tests.classes.errorflowdata.ErrorFlowData, and tests.classes.stopflowdata.StopFlowData.

Member Function Documentation

◆ filter_evidence()

def 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 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()

def fiftyone_pipeline_core.flowelement.FlowElement.get_evidence_key_filter

(

self

)

Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.

@rtype: EvidenceKeyFilter

Returns

: Returns an EvidenceKeyFilter

Reimplemented in fiftyone_pipeline_engines_fiftyone.share_usage.ShareUsage, examples.client_side_evidence_custom_flow_element.AstrologyFlowElement, fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine, fiftyone_pipeline_core.javascriptbuilder.JavascriptBuilderElement, tests.test_engines.ExampleAspectEngine, fiftyone_pipeline_core.sequenceelement.SequenceElement, tests.classes.apvflowelement.APVFlowElement, tests.classes.exampleflowelement2.ExampleFlowElement2, tests.classes.exampleflowelement1.ExampleFlowElement1, tests.classes.errorflowdata.ErrorFlowData, and tests.classes.stopflowdata.StopFlowData.

◆ get_properties()

def 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 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

Reimplemented in fiftyone_pipeline_engines.engine.Engine, and fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine.

◆ process()

def 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

Reimplemented in fiftyone_pipeline_engines.engine.Engine.

◆ process_internal()

def 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 fiftyone_pipeline_engines_fiftyone.share_usage.ShareUsage, fiftyone_pipeline_cloudrequestengine.cloudrequestengine.CloudRequestEngine, tests.test_javascriptbuilder.DelayedExecutionEngine3, tests.test_javascriptbuilder.DelayedExecutionEngine2, fiftyone_pipeline_core.javascriptbuilder.JavascriptBuilderElement, tests.test_javascriptbuilder.DelayedExecutionEngine1, examples.client_side_evidence_custom_flow_element.AstrologyFlowElement, tests.test_javascriptbuilder.CookieEngine, fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine, tests.test_engines.ExampleAspectEngine, fiftyone_pipeline_core.sequenceelement.SequenceElement, tests.test_javascriptbuilder.TestEngine, fiftyone_pipeline_core.jsonbundler.JSONBundlerElement, fiftyone_pipeline_core.setheaderelement.SetHeaderElement, tests.classes.apvflowelement.APVFlowElement, tests.classes.exampleflowelement1.ExampleFlowElement1, tests.classes.exampleflowelement2.ExampleFlowElement2, tests.classes.errorflowdata.ErrorFlowData, and tests.classes.stopflowdata.StopFlowData.

Member Data Documentation

◆ datakey

fiftyone_pipeline_core.flowelement.FlowElement.datakey

◆ exclude_from_messages

fiftyone_pipeline_core.flowelement.FlowElement.exclude_from_messages

◆ pipelines

fiftyone_pipeline_core.flowelement.FlowElement.pipelines

◆ properties

fiftyone_pipeline_core.flowelement.FlowElement.properties

On This Page

• Public Member Functions
• Public Attributes
• List of all members

Generated by doxygen 1.8.15