Bin2ElementInfo

Overview

The Bin2ElementInfo class, derived from the StreamElementInfo class, represents a data element serialized in binary format. It is used to represent raw data stream content as a list of structure units described with a name, a type (either delta or table) and an offset in the stream where the object placed.

The Bin2ElementInfo class is used internally by the Bin2DataStreamer class.

Location

 

constructor (Object, INameChangeNotification)

 

constructor(source: Object; notification: INameChangeNotification)

 

Bin2ElementInfo(Object source, INameChangeNotification notification)

 

Sub New (source As Object, notification As INameChangeNotification)

Parameters:

  • source:
  • notification:

constructor (String, StreamElementType, Int64, INameChangeNotification)

Creates a new instance of the BinElementInfo class and readis its properties from the next element in the provided raw data stream.

 

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

 

Bin2ElementInfo(String name, StreamElementType elementType, Int64 offset, INameChangeNotification notification)

 

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

Parameters:

  • name:
  • elementType:
  • offset:
  • notification: Listener of the element name change event

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

 

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

 

Bin2ElementInfo(String name, StreamElementType elementType, INameChangeNotification notification)

 

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

Parameters:

  • name:
  • elementType:
  • 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; }

 

Property ReadOnly Fields As SchemaFieldCollection

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; }

 

Property ReadOnly Key As String

Offset

Gets or sets an offset of the serialized element data in the underlying data stream.

 

property Offset: Int64 read write;

 

Int64 Offset { get; set; }

 

Property Offset As Int64

Read

Reads instance properties (ie BinElementInfo and BinElementInfo) from the provided data source object.

 

method Read(source: Object)

 

void Read(Object source)

 

Sub Read(source As Object)

Parameters:

  • source: Source data stream

ReadAndApplySchema  protected

Reads element data from the source data stream and applies the read schema to the target data table. Raises a DAException exception if the schema for the specified table cannot be found. Restores the data stream position after the data is loaded.

 

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

Writes the element data to the provided data stream.

 

method Write(source: Object)

 

void Write(Object source)

 

Sub Write(source As Object)

Parameters:

  • source: Destination data stream

 

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; }

 

Property ReadOnly Fields As SchemaFieldCollection

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; }

 

Property ReadOnly Key As String

Offset

Gets or sets an offset of the serialized element data in the underlying data stream.

 

property Offset: Int64 read write;

 

Int64 Offset { get; set; }

 

Property Offset As Int64

 

constructor (Object, INameChangeNotification)

 

constructor(source: Object; notification: INameChangeNotification)

 

Bin2ElementInfo(Object source, INameChangeNotification notification)

 

Sub New (source As Object, notification As INameChangeNotification)

Parameters:

  • source:
  • notification:

constructor (String, StreamElementType, Int64, INameChangeNotification)

Creates a new instance of the BinElementInfo class and readis its properties from the next element in the provided raw data stream.

 

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

 

Bin2ElementInfo(String name, StreamElementType elementType, Int64 offset, INameChangeNotification notification)

 

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

Parameters:

  • name:
  • elementType:
  • offset:
  • notification: Listener of the element name change event

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

 

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

 

Bin2ElementInfo(String name, StreamElementType elementType, INameChangeNotification notification)

 

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

Parameters:

  • name:
  • elementType:
  • notification:

Read

Reads instance properties (ie BinElementInfo and BinElementInfo) from the provided data source object.

 

method Read(source: Object)

 

void Read(Object source)

 

Sub Read(source As Object)

Parameters:

  • source: Source data stream

ReadAndApplySchema  protected

Reads element data from the source data stream and applies the read schema to the target data table. Raises a DAException exception if the schema for the specified table cannot be found. Restores the data stream position after the data is loaded.

 

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

Writes the element data to the provided data stream.

 

method Write(source: Object)

 

void Write(Object source)

 

Sub Write(source As Object)

Parameters:

  • source: Destination data stream

See Also

  • BinDataStreamer