Detailed Description

The JSONBundler aggregates all properties from FlowElements into a JSON object It is used for retrieving via an endpoint from the client side via the JavaScriptBuilder and also used inside the JavaScriptBuilder itself to pass properties to the client side.

Both this and the JavaScriptBuilder element are automatically added to a pipeline unless specifically ommited in the PipelineBuilder

Inheritance diagram for JSONBundlerElement:

[legend]

Collaboration diagram for JSONBundlerElement:

[legend]

Public Member Functions
	constructor ()
	getSequence (flowData)
	The sequence number the Sequence Element produced, which is its Element Data or, as a whole number a caller put in the evidence, query.sequence.
	processInternal (flowData)
	The JSON Builder extracts all properties and serializes them into JSON.
Public Member Functions inherited from FlowElement
	constructor ({ processInternal, dataKey, properties={}, evidenceKeyFilter, keptEvidenceKeyFilter }={})
	Constructor for flowElement class.
	onRegistration (pipeline, flowElement)
	Internal function to be called when a FlowElement is added to pipeline, runs through any registrationCallbacks on the FlowElement.
	ready ()
	Function called to check if a FlowElement is ready Used when there are asynchronous initialisation steps.
	processInternal (flowData)
	Internal process function for a particular flowElement called (via the flowElement.process() method) when flowData generated by a pipleline is processsed.
	process (flowData)
	To allow actions to take place before and after a FlowElement's processInternal function runs, a process wrapper is run first.
	updateProperties ()
	Call this function to update the properties meta database in all the pipelines this flowElement has been added to.
	getProperties ()
	Get a flowElement's properties.
	_log (type, message)
	Internal log.

Member Function Documentation

◆ getSequence()

JSONBundlerElement::getSequence

(

flowData

)

inline

The sequence number the Sequence Element produced, which is its Element Data or, as a whole number a caller put in the evidence, query.sequence.

Text from a query string does not count.

Parameters

{FlowData} flowData the FlowData being processed

Returns: {number} the sequence number

◆ processInternal()

JSONBundlerElement::processInternal

(