51Degrees Pipeline Node.js  4.2

51Degrees Pipeline for Node.js

AspectData Class Reference

Detailed Description

Extension of elementData which allows for a missing property service to be called when an accessed property isn't available.

Engines, an extension of flowElements also allow a restricted property list so certain properties can be excluded

Inheritance diagram for AspectData:

[legend]

Collaboration diagram for AspectData:

[legend]

Public Member Functions

 constructor ({ flowElement, missingPropertyService=new MissingPropertyServiceBase() })
Constructor for AspectData. More...
 get (key)
The aspectData getter runs a series of actions if a property has / has not been found. More...

Member Function Documentation

◆ constructor()

AspectData::constructor (   { flowElement, missingPropertyService=new MissingPropertyServiceBase() } )
inline

Constructor for AspectData.

Parameters
{object} - options options object
{FlowElement} - options.flowElement FlowElement the data is for
{MissingPropertyService} - options.missingPropertyService a missing property service to use when the property is in a FlowElement's property list but not in the data

◆ get()

AspectData::get (   key )
inline

The aspectData getter runs a series of actions if a property has / has not been found.

If it hasn't been found it runs the missing property service if the property is referenced by the flowElement/engine. If the property is found a further check to see if it is restricted by a list passed into the flowElement/engine.

Parameters
{string} - key the property key to lookup
Returns
{mixed} result