JsonElementInfo

Overview

The JsonElementInfo class is derived from the StreamElementInfo class and is used internally in the JsonDataStreamer data streamers.

The JsonElementInfo class is used to hold a single JsonObject instance when the JsonDataStreamer instance serializes or deserializes data in the JSON format.

There is no need to instantiate this class directly.

For internal use only.

Location


 

constructor (String, JsonObject, StreamElementType)

Creates a new instance of the JsonElementInfo class and initializes its parameter values with the corresponding parameters values.

 

constructor(elementName: String; source: JsonObject; elementType: StreamElementType)

 

JsonElementInfo(String elementName, JsonObject source, StreamElementType elementType)

 

Sub New(elementName As String, source As JsonObject, elementType As StreamElementType)

Parameters:

  • elementName: Element name (f.e. table name)
  • source: JSON source element
  • elementType: Element type (f.e. Dataset type)

constructor (String, StreamElementType, INameChangeNotification)  protected    (declared in StreamElementInfo)

 

constructor(name: String; elementType: StreamElementType; notification: INameChangeNotification)

 

JsonElementInfo(String name, StreamElementType elementType, INameChangeNotification notification)

 

Sub New(name As String, elementType As StreamElementType, notification As INameChangeNotification)

Parameters:

  • name:
  • elementType:
  • notification:

constructor (Object, INameChangeNotification)  protected    (declared in StreamElementInfo)

 

constructor(source: Object; notification: INameChangeNotification)

 

JsonElementInfo(Object source, INameChangeNotification notification)

 

Sub New(source As Object, notification As INameChangeNotification)

Parameters:

  • source:
  • notification:

ElementType    (declared in StreamElementInfo)

Represents the current element type. Can be either Dataset or Delta.

 

property ElementType: StreamElementType read write;

 

StreamElementType ElementType { get; set; }

 

Property ElementType() As StreamElementType

Fields    (declared in StreamElementInfo)

Gets the SchemaField collection associated with the current StreamElementInfo object.

 

property Fields: SchemaFieldCollection read;

 

SchemaFieldCollection Fields { get; }

 

ReadOnly Property Fields() As SchemaFieldCollection

JsonElementDefinition

Gets the single JsonObject object contained in the current JsonElementInfoinstance.

 

property JsonElementDefinition: JsonObject read;

 

JsonObject JsonElementDefinition { get; }

 

ReadOnly Property JsonElementDefinition() As JsonObject

Key    (declared in StreamElementInfo)

Gets the lower-cased Name value prefixed with t# if the ElementType equals Dataset or d# if the ElementType equals Delta.

This value is used to uniquely identify an object in the DataStreamer's data stream.

 

property Key: String read;

 

String Key { get; }

 

ReadOnly Property Key() As String

Read

Empty method intended to read data from the provided object.

 

method Read(source: Object)

 

void Read(Object source)

 

Sub Read(source As Object)

Parameters:

  • source:

ReadAndApplySchema (Object, StreamElementInfo, DataTable)  protected    (declared in StreamElementInfo)

 

method ReadAndApplySchema(source: Object; element: StreamElementInfo; destination: DataTable)

 

void ReadAndApplySchema(Object source, StreamElementInfo element, DataTable destination)

 

Sub ReadAndApplySchema(source As Object, element As StreamElementInfo, destination As DataTable)

Parameters:

  • source:
  • element:
  • destination:

ReadAndApplySchema (Object, StreamElementInfo, DataTable)  protected

Empty method intended to read data from the provided object and apply a read Schema to the data held internally by the current instance.

 

method ReadAndApplySchema(source: Object; element: StreamElementInfo; table: DataTable)

 

void ReadAndApplySchema(Object source, StreamElementInfo element, DataTable table)

 

Sub ReadAndApplySchema(source As Object, element As StreamElementInfo, table As DataTable)

Parameters:

  • source:
  • element:
  • table:

Write

Empty method intended to write data to the provided object.

 

method Write(source: Object)

 

void Write(Object source)

 

Sub Write(source As Object)

Parameters:

  • source:

 

ElementType    (declared in StreamElementInfo)

Represents the current element type. Can be either Dataset or Delta.

 

property ElementType: StreamElementType read write;

 

StreamElementType ElementType { get; set; }

 

Property ElementType() As StreamElementType

Fields    (declared in StreamElementInfo)

Gets the SchemaField collection associated with the current StreamElementInfo object.

 

property Fields: SchemaFieldCollection read;

 

SchemaFieldCollection Fields { get; }

 

ReadOnly Property Fields() As SchemaFieldCollection

JsonElementDefinition

Gets the single JsonObject object contained in the current JsonElementInfoinstance.

 

property JsonElementDefinition: JsonObject read;

 

JsonObject JsonElementDefinition { get; }

 

ReadOnly Property JsonElementDefinition() As JsonObject

Key    (declared in StreamElementInfo)

Gets the lower-cased Name value prefixed with t# if the ElementType equals Dataset or d# if the ElementType equals Delta.

This value is used to uniquely identify an object in the DataStreamer's data stream.

 

property Key: String read;

 

String Key { get; }

 

ReadOnly Property Key() As String

 

constructor (String, JsonObject, StreamElementType)

Creates a new instance of the JsonElementInfo class and initializes its parameter values with the corresponding parameters values.

 

constructor(elementName: String; source: JsonObject; elementType: StreamElementType)

 

JsonElementInfo(String elementName, JsonObject source, StreamElementType elementType)

 

Sub New(elementName As String, source As JsonObject, elementType As StreamElementType)

Parameters:

  • elementName: Element name (f.e. table name)
  • source: JSON source element
  • elementType: Element type (f.e. Dataset type)

constructor (String, StreamElementType, INameChangeNotification)  protected    (declared in StreamElementInfo)

 

constructor(name: String; elementType: StreamElementType; notification: INameChangeNotification)

 

JsonElementInfo(String name, StreamElementType elementType, INameChangeNotification notification)

 

Sub New(name As String, elementType As StreamElementType, notification As INameChangeNotification)

Parameters:

  • name:
  • elementType:
  • notification:

constructor (Object, INameChangeNotification)  protected    (declared in StreamElementInfo)

 

constructor(source: Object; notification: INameChangeNotification)

 

JsonElementInfo(Object source, INameChangeNotification notification)

 

Sub New(source As Object, notification As INameChangeNotification)

Parameters:

  • source:
  • notification:

Read

Empty method intended to read data from the provided object.

 

method Read(source: Object)

 

void Read(Object source)

 

Sub Read(source As Object)

Parameters:

  • source:

ReadAndApplySchema (Object, StreamElementInfo, DataTable)  protected    (declared in StreamElementInfo)

 

method ReadAndApplySchema(source: Object; element: StreamElementInfo; destination: DataTable)

 

void ReadAndApplySchema(Object source, StreamElementInfo element, DataTable destination)

 

Sub ReadAndApplySchema(source As Object, element As StreamElementInfo, destination As DataTable)

Parameters:

  • source:
  • element:
  • destination:

ReadAndApplySchema (Object, StreamElementInfo, DataTable)  protected

Empty method intended to read data from the provided object and apply a read Schema to the data held internally by the current instance.

 

method ReadAndApplySchema(source: Object; element: StreamElementInfo; table: DataTable)

 

void ReadAndApplySchema(Object source, StreamElementInfo element, DataTable table)

 

Sub ReadAndApplySchema(source As Object, element As StreamElementInfo, table As DataTable)

Parameters:

  • source:
  • element:
  • table:

Write

Empty method intended to write data to the provided object.

 

method Write(source: Object)

 

void Write(Object source)

 

Sub Write(source As Object)

Parameters:

  • source: