Class LogicalRecord

Describes a data record.

Inheritance

System.Object

NotificationObject

IdentifiableBase

LogicalRecord

Ddi31LogicalRecord

Inherited Members

IdentifiableBase.DefaultAgencyId

IdentifiableBase.AgencyId

IdentifiableBase.Identifier

IdentifiableBase.UserIds

IdentifiableBase.GetUserIdValue(String)

NotificationObject.PropertyChanged

NotificationObject.RaisePropertyChanged(String)

NotificationObject.RaisePropertyChanged(String[])

Algenta.Colectica.Model.NotificationObject.RaisePropertyChanged<T>(Expression<>)

NotificationObject.OnPropertyChanged(String)

NotificationObject.ResumePropertyEvents()

NotificationObject.SuspendPropertyEvents()

NotificationObject.PropertyEventsSuspended

NotificationObject.PropagateChildChanges(INotifyCollectionChanged, String)

Namespace: Algenta.Colectica.Model.Ddi

Assembly: Algenta.Colectica.Model.Ddi.dll

Syntax

public class LogicalRecord : IdentifiableBase, IIdentifiable, IDescribable, IVisitable

Constructors

LogicalRecord()

Initializes a new instance of the LogicalRecord class.

Declaration

public LogicalRecord()

Properties

CaseIdentifiers

Gets the variables used to uniquely identify a case in the data.

Declaration

public ObservableCollection<Variable> CaseIdentifiers { get; }

Property Value

Type	Description
ObservableCollection<Variable>

ChildTypesAccepted

Gets the child types that may be added to this item type.

Declaration

public virtual Collection<Guid> ChildTypesAccepted { get; }

Property Value

Type	Description
Collection<Guid>	The child types that may be added to this item type.

Description

Gets the description.

Declaration

public virtual MultilingualString Description { get; }

Property Value

Type	Description
MultilingualString

Implements

IDescribable.Description

DisplayLabel

Gets the display label.

Declaration

public string DisplayLabel { get; }

Property Value

Type	Description
System.String

Remarks

The display label returns text to be displayed in a user interface or in generated documentation.

HasLocator

Gets or sets a value indicating whether this instance has locator used to determine the record type.

Declaration

public bool HasLocator { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance has locator; otherwise, false.

Remarks

When multiple types of records are stored in the same file, a locator variable is often used to determine which record type is specified. For example, a locator variable may contain "H" for a household record or "P" for a person record. If possible, consider structuring your data so a single record contains data for a single analysis unit.

ItemName

Gets the name of the item.

Declaration

public virtual MultilingualString ItemName { get; }

Property Value

Type	Description
MultilingualString	The name of the item.

Implements

IDescribable.ItemName

Label

Gets the label.

Declaration

public MultilingualString Label { get; }

Property Value

Type	Description
MultilingualString

Implements

IDescribable.Label

LocatorVariableValue

Gets or sets the locator variable value, used to determine the record type.

Declaration

public VariableValue LocatorVariableValue { get; set; }

Property Value

Type	Description
VariableValue	The locator variable value.

Remarks

When multiple types of records are stored in the same file, a locator variable is often used to determine which record type is specified. For example, a locator variable may contain "H" for a household record or "P" for a person record. ///

NCubeInRecord

The NCube describing the cube of data held in the record.

Declaration

public NCube NCubeInRecord { get; set; }

Property Value

Type	Description
NCube

Remarks

DDI supports multiple cubes per record, but such data would not be well-structured.

VariableSchemesInRecord

Gets the variable schemes in record. The VariablesInRecord property should be preferred.

Declaration

public ObservableCollection<VariableScheme> VariableSchemesInRecord { get; }

Property Value

Type	Description
ObservableCollection<VariableScheme>

VariablesInRecord

Gets the variables in the record.

Declaration

public ObservableCollection<Variable> VariablesInRecord { get; }

Property Value

Type	Description
ObservableCollection<Variable>

Methods

Accept(IVersionableVisitor)

Accepts the specified visitor.

Declaration

public virtual void Accept(IVersionableVisitor visitor)

Parameters

Type	Name	Description
IVersionableVisitor	visitor	The visitor.

AddChild(IVersionable)

Adds the provided child to this item.

Declaration

public virtual void AddChild(IVersionable child)

Parameters

Type	Name	Description
IVersionable	child	The item to be added as a child of this item.

GetChildren()

Gets the identifiers of the item's children.

Declaration

public virtual ChildItemCollection GetChildren()

Returns

Type	Description
ChildItemCollection	The identifiers of the item's children.

RemoveChild(IdentifierTriple)

Removes the specified child.

Declaration

public virtual int RemoveChild(IdentifierTriple child)

Parameters

Type	Name	Description
IdentifierTriple	child	The child to be removed.

Returns

Type	Description
System.Int32	The number of children removed from the item.

ReplaceChild(IdentifierTriple, IVersionable)

Replaces the child with the specified identifier with the provided item.

Declaration

public virtual int ReplaceChild(IdentifierTriple toReplace, IVersionable child)

Parameters

Type	Name	Description
IdentifierTriple	toReplace	The identifier of the child to replace.
IVersionable	child	The new child.

Returns

Type	Description
System.Int32	The number of children replaced.

Extension Methods

Extensions.Yield<T>(T)