StreamElementInfo

Overview

The StreamElementInfo class is a base abstract class that represents a serializer/deserializer for the DataStreamer-specific data stream format.

This class is used as the base class for the Bin2ElementInfo, BinElementInfo and JsonElementInfo class used by the according Data Streamers (Bin2DataStreamer, BinDataStreamer and JsonDataStreamer).

For internal use only.

Location


 

constructor (String, StreamElementType, INameChangeNotification)  protected

 

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

 

StreamElementInfo(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

 

constructor(source: Object; notification: INameChangeNotification)

 

StreamElementInfo(Object source, INameChangeNotification notification)

 

Sub New(source As Object, notification As INameChangeNotification)

Parameters:

  • source:
  • notification:

ElementType

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

Gets the SchemaField collection associated with the current StreamElementInfo object.

 

property Fields: SchemaFieldCollection read;

 

SchemaFieldCollection Fields { get; }

 

ReadOnly Property Fields() As SchemaFieldCollection

Key

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

 

method Read(source: Object)

 

void Read(Object source)

 

Sub Read(source As Object)

Parameters:

  • source:

ReadAndApplySchema  protected

Reads element data from the source data stream and applies the read schema to the target data table

 

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: Source data stream
  • element: Stream element
  • destination: Target data table

Write

 

method Write(source: Object)

 

void Write(Object source)

 

Sub Write(source As Object)

Parameters:

  • source:

 

ElementType

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

Gets the SchemaField collection associated with the current StreamElementInfo object.

 

property Fields: SchemaFieldCollection read;

 

SchemaFieldCollection Fields { get; }

 

ReadOnly Property Fields() As SchemaFieldCollection

Key

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, StreamElementType, INameChangeNotification)  protected

 

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

 

StreamElementInfo(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

 

constructor(source: Object; notification: INameChangeNotification)

 

StreamElementInfo(Object source, INameChangeNotification notification)

 

Sub New(source As Object, notification As INameChangeNotification)

Parameters:

  • source:
  • notification:

Read

 

method Read(source: Object)

 

void Read(Object source)

 

Sub Read(source As Object)

Parameters:

  • source:

ReadAndApplySchema  protected

Reads element data from the source data stream and applies the read schema to the target data table

 

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: Source data stream
  • element: Stream element
  • destination: Target data table

Write

 

method Write(source: Object)

 

void Write(Object source)

 

Sub Write(source As Object)

Parameters:

  • source: