Click or drag to resize

ICluster Interface

Interface defining a record cluster

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

The ICluster type exposes the following members.

Properties
  NameDescription
Public propertyClstrNo
Sequence number of the cluster on intake (1 based). This number remains unchanged throughout the processing; for example in case of cluster cloning, the clone will inherit ClstrNo from the original cluster.
Public propertyCount
Number of records contained in the cluster.
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 setting. Global cache also allows signals to synchronize thread of Data Conveyer processing.
Public propertyItem
A record at a specified index position (0-based).
Public propertyPropertyBin
The property bin associated with the cluster. 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 clusters contain property bin objects, the PropertyBinEntities setting must contain the Clusters flag; otherwise the property bin will be null.
Public propertyRecords
A collection of records contained in the cluster.
Public propertyStartRecNo
Sequence number of the first record in cluster on intake (1 based). This number remains unchanged throughout the processing; for example in case of cluster cloning, the clone will inherit StartRecNo from the original cluster. There are 2 special values: 0 (HeadClusterRecNo) means head cluster and -1 (FootClusterRecNo) means foot cluster.
Public propertyStartSourceNo
Index number (1 based) of the intake source that supplied the first record of the cluster. This number remains unchanged throughout the processing; for example in case of record cloning, the clone will inherit SourceNo from the original cluster.
Top
Methods
  NameDescription
Public methodAddRecord
Add a given record at the end of the cluster.
Public methodGetClone
Return a copy (deep clone) of the cluster. The cloned cluster will have the same characteristics (e.g. ClstrNo and PropertyBin) as the current cluster.
Public methodGetEmptyClone
Return an empty cluster, i.e. cluster with no records, but the same characteristics (e.g. ClstrNo and PropertyBin) as the current cluster.
Public methodGetProcessingStatus
Return processing status of a given phase.
Public methodGetRecord
Return a record at a specified index position.
Public methodObtainEmptyRecord
Return an empty record (template) that is suitable to be contained in the current cluster.
Caution note Caution
This method should only be used in case of an empty cluster, such as a head cluster. Otherwise, one of the records contained in the cluster should be cloned instead.
Public methodRemoveRecord
Remove record at a specified index position from the cluster.
Top
See Also