Click or drag to resize

IUntypedRecord Interface

Interface defining a record; it refers to string representations of items contained in the record

Namespace:  Mavidian.DataConveyer.Entities.KeyVal
Assembly:  DataConveyer (in DataConveyer.dll) Version: 3.4.6+1324144ff7
Syntax
public interface IUntypedRecord : IRecordBase

The IUntypedRecord type exposes the following members.

Properties
  NameDescription
Public propertyClstrNo
1-based sequential cluster number (on intake it is 0 (undetermined), unless assigned in case of XML intake); the actual number is assigned at clustering block.
(Inherited from IRecordBase.)
Public propertyCount
Number of items contained in the record
(Inherited from IRecordBase.)
Public propertyGlobalCache
A set of key value pairs that are common to all records and clusters throughout the process execution. Elements of global cache are defined via the GlobalCacheElements seting. Global cache also allows signals to synchronize thread of Data Conveyer processing.
(Inherited from IRecordBase.)
Public propertyItemInt32
A value of an item at a specified index position (attempt to set a value of a non-existing item has no effect)
Public propertyItemString
A value of an item for a specified key (attempt to set a value of a non-existing item has no effect)
Public propertyItems
A collection of items contained in the record.
(Inherited from IRecordBase.)
Public propertyKeys
A collection of keys contained in the record.
(Inherited from IRecordBase.)
Public propertyPropertyBin
The property bin associated with the record. Property bin is a dictionary containing arbitrary set of key value pairs that can be added and removed throughout of DataConveyer processing. In order to have records contain property bin objects, the PropertyBinEntities setting must contain the Records flag; otherwise the property bin will be null.
(Inherited from IRecordBase.)
Public propertyRecNo
Sequence number of the record on intake (1 based). This number remains unchanged throughout the processing; for example in case of record cloning, the clone will inherit RecNo from the original record.
(Inherited from IRecordBase.)
Public propertySourceNo
Index number of the intake source that supplied the record (1 based). This number remains unchanged throughout the processing; for example in case of record cloning, the clone will inherit SourceNo from the original record.
(Inherited from IRecordBase.)
Public propertyTargetNo
Index number of the output target that the record is sent to (1 based). Before output phase (ClusterRouter function), the value is 0, which means not yet determined.
(Inherited from IRecordBase.)
Public propertyTraceBin
The trace bin object associated with the record. It can be set up in the RecordInitiator function. Trace bin is a dictionary intended to contain key value pairs collected during processing of preceding records on intake. Note that for efficiency empty trace bin objects are not attached; in such cases, TraceBin values are null.
(Inherited from IRecordBase.)
Top
Methods
  NameDescription
Public methodAddItem
Add an item for a given key and value at the end of the record
Public methodAddOrReplaceItem
Include the item in the record by either adding it or replacing existing item with the same key.
(Inherited from IRecordBase.)
Public methodContainsKey
Verify if the record contains an item with a given key.
(Inherited from IRecordBase.)
Public methodCreateEmptyX12Segment
Return an empty X12 segment for a given name and number of elements.
Public methodCreateFilledX12Segment
Return an X12 segment based on provided contents.
Public methodGetClone
Return a copy (deep clone) of current record. The cloned record will have the same characteristics (e.g. RecNo and also TraceBin and PropertyBin) as the current record.
Public methodGetEmptyClone

Return an empty record (i.e. record with no items) with the same characteristics (e.g. RecNo and also TraceBin and PropertyBin) as the current record.

Caution note Caution
GetEmptyClone method typically requires AllowTransformToAlterFields setting to be true (to allow field additions). Otherwise (i.e. when AllowTransformToAlterFields is false, which is a default value), the record returned by this method is unmaintainable, i.e. it will remain empty forever.
Public methodGetItem(Int32)
Obtain an item at a specified index position.
(Inherited from IRecordBase.)
Public methodGetItem(String)
Obtain an item for a specified key.
(Inherited from IRecordBase.)
Public methodGetItemClone
Obtain a clone of a given item with a new value.
Public methodGetProcessingStatus
Return processing status of a given phase.
(Inherited from IRecordBase.)
Public methodRemoveItem
Remove item for a specified key.
(Inherited from IRecordBase.)
Public methodReplaceItem
Replace an existing item with a new one.
(Inherited from IRecordBase.)
Top
See Also