51Degrees Pipeline for Python

accepteverykeyelement.AcceptEveryKeyElement Class Reference

Detailed Description

An element that accepts every evidence key and does nothing else.

A pipeline keeps only the evidence one of its elements accepts, and the stand-in service accepts query.User-Agent alone, so a test of how the cloud request engine treats other evidence adds this element to keep that evidence in the flow data.

Inheritance diagram for accepteverykeyelement.AcceptEveryKeyElement:

[legend]

Collaboration diagram for accepteverykeyelement.AcceptEveryKeyElement:

[legend]

Public Member Functions

 __init__ (self)
 get_evidence_key_filter (self)
 The evidence this element accepts.
 process_internal (self, flowdata)
 The method behind FlowElement.Process - it is called by the process() function.

Public Member Functions inherited from fiftyone_pipeline_core.flowelement.FlowElement

 __init__ (self)
 List of Pipelines the FlowElement has been added to.
 process (self, flowdata)
 Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method.
 on_registration (self, pipeline)
 Function called when an element is added to the pipeline.
 close (self)
 Release the resources the element holds.
 filter_evidence (self, flowdata)
 Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.
 filter_evidence_key (self, key)
 Filter FlowData.evidence using the flowElement's EvidenceKeyFilter with the property key of evidence of interest.
 get_properties (self)
 Get the FlowElement.properties of a FlowElement.

Additional Inherited Members

Public Attributes inherited from fiftyone_pipeline_core.flowelement.FlowElement

list pipelines = []
dict properties = {}
str datakey = ""
bool exclude_from_messages = False

Protected Member Functions inherited from fiftyone_pipeline_core.flowelement.FlowElement

 _log (self, level, message)

Constructor & Destructor Documentation

◆ __init__()

accepteverykeyelement.AcceptEveryKeyElement.__init__ ( self)

Member Function Documentation

◆ get_evidence_key_filter()

accepteverykeyelement.AcceptEveryKeyElement.get_evidence_key_filter ( self)

The evidence this element accepts.

An element overrides this to name the evidence that can change its results. One that does not accepts no evidence, so it never widens what the pipeline keeps.

@rtype: EvidenceKeyFilter

Returns
: Returns an EvidenceKeyFilter

Reimplemented from fiftyone_pipeline_core.flowelement.FlowElement.

◆ process_internal()

accepteverykeyelement.AcceptEveryKeyElement.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
flowdataFlowData to be processed

@rtype: bool

Returns
: Returns True

Reimplemented from fiftyone_pipeline_core.flowelement.FlowElement.