\r\n

51Degrees Pipeline .NET  4.1Newer Version 4.4

51Degrees Pipeline for .NET
Search

FiftyOne.Pipeline.JsonBuilder.FlowElement.JsonBuilderElement Class Reference

Detailed Description

The JsonBuilderElement takes accessible properties and adds the property key:values to the Json object.

The element will also add any errors which have been recorded in the FlowData.

Inheritance diagram for FiftyOne.Pipeline.JsonBuilder.FlowElement.JsonBuilderElement:

[legend]

Collaboration diagram for FiftyOne.Pipeline.JsonBuilder.FlowElement.JsonBuilderElement:

[legend]

Public Member Functions

 JsonBuilderElement (ILogger< JsonBuilderElement > logger, Func< IFlowData, FlowElementBase< IJsonBuilderElementData, IElementPropertyMetaData >, IJsonBuilderElementData > elementDataFactory)

Public Member Functions inherited from FiftyOne.Pipeline.Core.FlowElements.FlowElementBase< IJsonBuilderElementData, IElementPropertyMetaData >

 FlowElementBase (ILogger< FlowElementBase< T, TMeta >> logger)
Constructor More...
 FlowElementBase (ILogger< FlowElementBase< T, TMeta >> logger, Func< IFlowData, FlowElementBase< T, TMeta >, T > elementDataFactory)
Constructor More...
virtual void  Process (IFlowData data)
Process the given IFlowData with this FlowElement. More...
virtual void  AddPipeline (IPipeline pipeline)
Called when this element is added to a pipeline. More...
void  Dispose ()
Dispose More...

Public Attributes

override string  ElementDataKey => "json-builder"
override IEvidenceKeyFilter  EvidenceKeyFilter
override IList< IElementPropertyMetaData >  Properties

Protected Member Functions

override void  ManagedResourcesCleanup ()
Cleanup any managed resources that the element is using More...
override void  ProcessInternal (IFlowData data)
virtual string  BuildJson (IFlowData data)
Create and populate a JSON string from the specified data. More...
virtual void  AddNullValueReasons (IFlowData data, Dictionary< string, object > allProperties) string  BuildJson (Dictionary< string, object > allProperties) void  AddErrors (IFlowData data, Dictionary< String, object > allProperties)
Add any errors in the flow data object to the dictionary More...
int  GetSequenceNumber (IFlowData data)
Get the sequence number from the evidence. More...
override void  UnmanagedResourcesCleanup ()
Cleanup any unmanaged resources that the element is using More...
virtual Dictionary< String, object >  GetAllProperties (IFlowData data) virtual IList< string >  GetJavaScriptProperties (IFlowData data, IList< string > availableProperties)

Protected Member Functions inherited from FiftyOne.Pipeline.Core.FlowElements.FlowElementBase< IJsonBuilderElementData, IElementPropertyMetaData >

abstract void  ProcessInternal (IFlowData data)
Abstract method called by Process(IFlowData). More...
virtual T  CreateElementData (IFlowData flowData)
Method used to create element data instances that are populated by this flow element More...
virtual void  Dispose (bool disposing)
Dispose of any resources. More...

Member Function Documentation

◆ AddErrors()

void FiftyOne.Pipeline.JsonBuilder.FlowElement.JsonBuilderElement.AddErrors ( IFlowData   data,
Dictionary< String, object >   allProperties  
)
protected

Add any errors in the flow data object to the dictionary

Parameters
data -
allProperties -

◆ BuildJson()

virtual string FiftyOne.Pipeline.JsonBuilder.FlowElement.JsonBuilderElement.BuildJson ( IFlowData   data )
protected virtual

Create and populate a JSON string from the specified data.

Parameters
data -
allProperties -
javascriptProperties -
Returns
A string containing the data in JSON format.

◆ GetSequenceNumber()

int FiftyOne.Pipeline.JsonBuilder.FlowElement.JsonBuilderElement.GetSequenceNumber ( IFlowData   data )
protected

Get the sequence number from the evidence.

Parameters
data -
Returns

◆ ManagedResourcesCleanup()

override void FiftyOne.Pipeline.JsonBuilder.FlowElement.JsonBuilderElement.ManagedResourcesCleanup ( )
protected virtual

Cleanup any managed resources that the element is using

Implements FiftyOne.Pipeline.Core.FlowElements.FlowElementBase< IJsonBuilderElementData, IElementPropertyMetaData >.

◆ UnmanagedResourcesCleanup()

override void FiftyOne.Pipeline.JsonBuilder.FlowElement.JsonBuilderElement.UnmanagedResourcesCleanup ( )
protected virtual

Cleanup any unmanaged resources that the element is using

Implements FiftyOne.Pipeline.Core.FlowElements.FlowElementBase< IJsonBuilderElementData, IElementPropertyMetaData >.

Member Data Documentation

◆ EvidenceKeyFilter

override IEvidenceKeyFilter FiftyOne.Pipeline.JsonBuilder.FlowElement.JsonBuilderElement.EvidenceKeyFilter
Initial value:
=>
_evidenceKeyFilter

◆ Properties

override IList<IElementPropertyMetaData> FiftyOne.Pipeline.JsonBuilder.FlowElement.JsonBuilderElement.Properties
Initial value:
=>
_properties
On This Page

Generated by doxygen 1.8.15