51Degrees Pipeline for Node.js

ElementData Class Reference

Detailed Description

Stores information created by a flowElement based on flowData.

Stored in flowData

Inheritance diagram for ElementData:

[legend]

Public Member Functions

 constructor ({ flowElement })
 Constructor for elementData.
 getInternal (key)
 Internal get method for elementData to retrieve an element from it called via the elementData's get method This method is overriden by classes inheriting from elementData.
 getInternalIgnoringCase (key)
 Looks for a key again ignoring its letter case, after getInternal found nothing for the key as given, because property names are compared ignoring case.
 get (key)
 A wrapper that performs actions before passing on processing (or skipping) the getInternal method.
 getAsString (key)
 Return string value of property.
 getAsFloat (key)
 Return float value of property.
 getAsInteger (key)
 Return int value of property.

Member Function Documentation

◆ constructor()

ElementData::constructor ( { flowElement })
inline

Constructor for elementData.

Parameters
{object}options the options object
{FlowElement}options.flowElement the FlowElement this data is part of

◆ get()

ElementData::get ( key)
inline

A wrapper that performs actions before passing on processing (or skipping) the getInternal method.

A key that finds nothing as given is looked for again ignoring its letter case, so a read that found its value before costs no more.

Parameters
{string}key the key to retrieve a property value for
Returns
{FlowData} value

◆ getAsFloat()

ElementData::getAsFloat ( key)
inline

Return float value of property.

Parameters
{string}key the key to retreive a property value for
Returns
{number} float value

◆ getAsInteger()

ElementData::getAsInteger ( key)
inline

Return int value of property.

Parameters
{string}key the key to retreive a property value for
Returns
{number} int value

◆ getAsString()

ElementData::getAsString ( key)
inline

Return string value of property.

Parameters
{string}key the key to retreive a property value for
Returns
{string} value

◆ getInternal()

ElementData::getInternal ( key)
inline

Internal get method for elementData to retrieve an element from it called via the elementData's get method This method is overriden by classes inheriting from elementData.

Parameters
{string}key the key to retrieve a property value for

◆ getInternalIgnoringCase()

ElementData::getInternalIgnoringCase ( key)
inline

Looks for a key again ignoring its letter case, after getInternal found nothing for the key as given, because property names are compared ignoring case.

Classes inheriting from elementData override this, and this one finds nothing.

Parameters
{string}key the key to retrieve a property value for
Returns
{*} the value, or undefined if there is none