51Degrees Pipeline Node.js
4.4
An Engine is an extension of a FlowElement which adds options such as restricting to a subset of properties and a cache and the ability to load property data from a datafile of the DataFile class.
| constructor ({ cache, restrictedProperties, dataFile }={}) | |
| inCache (flowData)
Checks cache and returns cached result if found. More...
| |
| process (flowData)
An engine's process function checks cache for an item (calling inCache) If found it returns the cached object If not found it runs the standard processInternal function and adds it to the cache (if a cache is present) More...
| |
| refresh () | |
| registerDataFile (dataFile)
Function to attach a DataFile to the engine and register it with a DataFileUpdateService if needed. More...
| |
Public Member Functions inherited from FlowElement | |
| constructor ({ processInternal, dataKey, properties={}, evidenceKeyFilter }={})
Constructor for flowElement class. More...
| |
| onRegistration (pipeline, flowElement)
Internal function to be called when a FlowElement is added to pipeline, runs through any registrationCallbacks on the FlowElement. More...
| |
| ready ()
Function called to check if a FlowElement is ready Used when there are asynchronous initialisation steps. More...
| |
| processInternal (flowData)
Internal process function for a particular flowElement called (via the flowElement.process() method) when flowData generated by a pipleline is processsed. More...
| |
| process (flowData)
To allow actions to take place before and after a FlowElement's processInternal function runs, a process wrapper is run first. More...
| |
| updateProperties ()
Call this function to update the properties meta database in all the pipelines this flowElement has been added to. More...
| |
| getProperties ()
Get a flowElement's properties. More...
| |
| _log (type, message) | |
| Engine::constructor | ( | { cache, restrictedProperties, dataFile } = {}
| ) |
Constructor for an Engine.
| Engine::inCache | ( | flowData | ) |
Checks cache and returns cached result if found.
| Engine::process | ( | flowData | ) |
An engine's process function checks cache for an item (calling inCache) If found it returns the cached object If not found it runs the standard processInternal function and adds it to the cache (if a cache is present)
| Engine::refresh | ( | ) |
Callback which runs when an attached DataFile is updated Needs to be overriden by a specific engine to do anything.
| Engine::registerDataFile | ( | dataFile | ) |
Function to attach a DataFile to the engine and register it with a DataFileUpdateService if needed.