Class Variable

Represents the logical description of a column of data.

Inheritance

object

NotificationObject

IdentifiableBase

VersionableBase

DescribableBase

Variable

Implements

INotifyPropertyChanged

Inherited Members

DescribableBase.ItemName

DescribableBase.Label

DescribableBase.Description

DescribableBase.DisplayLabel

VersionableBase.Accept(IVersionableVisitor)

VersionableBase.IsDirty

VersionableBase.IsPublished

VersionableBase.ChildrenDereferenced

VersionableBase.IsPopulated

VersionableBase.Version

VersionableBase.VersionDate

VersionableBase.VersionResponsibility

VersionableBase.VersionRationale

VersionableBase.CompositeId

VersionableBase.OtherMaterials

VersionableBase.BasedOn

VersionableBase.SucceededBy

VersionableBase.Attachments

VersionableBase.ThumbnailImageUri

VersionableBase.BannerImageUri

VersionableBase.DisableChangeTracking

VersionableBase.RemoveChildHelper(IVersionable, params IList[])

VersionableBase.AddChild(IVersionable)

VersionableBase.ChildTypesAccepted

VersionableBase.TryReplaceChild<T>(Func<T>, Action<T>, IdentifierTriple, IVersionable)

VersionableBase.ToString()

IdentifiableBase.DefaultAgencyId

IdentifiableBase.AgencyId

IdentifiableBase.Identifier

IdentifiableBase.UserIds

IdentifiableBase.CustomFields

IdentifiableBase.UserAttributes

IdentifiableBase.GetUserIdValue(string)

IdentifiableBase.RemoveChildHelper(IdentifierTriple, params IList[])

NotificationObject.PropertyChanged

NotificationObject.RaisePropertyChanged(string)

NotificationObject.OnPropertyChanged(string)

NotificationObject.ResumePropertyEvents()

NotificationObject.SuspendPropertyEvents()

NotificationObject.PropertyEventsSuspended

NotificationObject.PropagateChildChanges(INotifyCollectionChanged, string)

NotificationObject.WatchProperty(INotifyPropertyChanged, string)

NotificationObject.WatchCollection(INotifyCollectionChanged, string)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Algenta.Colectica.Model.Ddi

Assembly: Algenta.Colectica.Model.Ddi.dll

Syntax

public class Variable : DescribableBase, INotifyPropertyChanged, IVersionable, IIdentifiable, IHasCustomFields, IDescribable, IVisitable

Constructors

Variable()

Initializes a new instance of the Variable class.

Declaration

public Variable()

Properties

ActiveRepresentation

Gets the representation type.

Declaration

[JsonIgnore]
public ResponseDomain ActiveRepresentation { get; }

Property Value

Type	Description
ResponseDomain

Additivity

Gets or sets the ability of the number to be meaningfully added.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public AdditivityType Additivity { get; set; }

Property Value

Type	Description
AdditivityType

AdditivityTypes

Gets an array of the supported additivity types.

Declaration

[UIHint("skip")]
public static Array AdditivityTypes { get; }

Property Value

Type	Description
Array

AggregationMethod

For aggregate variables, gets or sets the method used to tabulate other variables into this variable.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public AggregationMethodType AggregationMethod { get; set; }

Property Value

Type	Description
AggregationMethodType

AnalysisUnit

Gets or sets the entity to which the data refer, for example, individuals, families or households, groups, institutions or organizations, administrative units, etc.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public string AnalysisUnit { get; set; }

Property Value

Type	Description
string

ArrayPosition

Array number of the data item for delimited files.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public int? ArrayPosition { get; set; }

Property Value

Type	Description
int?

CodeRepresentation

Gets or sets the code representation.

Declaration

public CodeDomain CodeRepresentation { get; set; }

Property Value

Type	Description
CodeDomain

Concept

Gets or sets the concept measured by this variable.

Declaration

[Display(GroupName = "Basic", Order = 400)]
public Concept Concept { get; set; }

Property Value

Type	Description
Concept

ConceptualVariable

Gets or sets the conceptual variable that represents the core of this variable, including the universe and concept of the variable.

Declaration

[Display(GroupName = "Concept", Order = 500)]
public ConceptualVariable ConceptualVariable { get; set; }

Property Value

Type	Description
ConceptualVariable

DateTimeRepresentation

Gets or sets the date time representation.

Declaration

public DateTimeDomain DateTimeRepresentation { get; set; }

Property Value

Type	Description
DateTimeDomain

EndPosition

Position of the last character of the data item in a fixed format. Should be specified if a value for Width is not provided.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public int? EndPosition { get; set; }

Property Value

Type	Description
int?

Imputation

Gets or sets instructions that were used to calculate the values of data for this variable.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public GeneralInstructionCoding Imputation { get; set; }

Property Value

Type	Description
GeneralInstructionCoding

IsGeographic

Gets or sets if the variable is a geographic variable

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public bool IsGeographic { get; set; }

Property Value

Type	Description
bool

IsTemporal

Gets or sets if the variable is a geographic variable

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public bool IsTemporal { get; set; }

Property Value

Type	Description
bool

IsValid

Gets a value indicating whether the variable has a specified representation type.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
bool

IsWeight

Gets or sets if the Variable is a weight

Declaration

public bool IsWeight { get; set; }

Property Value

Type	Description
bool

ItemType

Gets the universally unique identifier representing the item's type.

Declaration

public override Guid ItemType { get; }

Property Value

Type	Description
Guid	The identifier representing the item's type.

Overrides

VersionableBase.ItemType

MeasurementUnit

Gets or sets the measurement unit of the data described by this variable.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public string MeasurementUnit { get; set; }

Property Value

Type	Description
string

MissingValues

Gets or sets a description of missing values for the variable.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public ManagedMissingValuesRepresentation MissingValues { get; set; }

Property Value

Type	Description
ManagedMissingValuesRepresentation

Remarks

For the missing value to be saved, the variable must have a representation set.

NumericRepresentation

Gets or sets the numeric representation.

Declaration

public NumericDomain NumericRepresentation { get; set; }

Property Value

Type	Description
NumericDomain

RepresentationType

Gets or sets the type of the data described by the variable.

Declaration

public RepresentationType RepresentationType { get; set; }

Property Value

Type	Description
RepresentationType	The type of the representation.

RepresentedVariable

Gets or sets the represented variable that represents the core of this variable, possibly including the universe, concept, and data type of the variable.

Declaration

[Display(GroupName = "Concept", Order = 500)]
public RepresentedVariable RepresentedVariable { get; set; }

Property Value

Type	Description
RepresentedVariable

ResponseUnit

Gets or sets the who provided information contained by the variable (e.g., respondent, proxy, interviewer).

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public string ResponseUnit { get; set; }

Property Value

Type	Description
string

Role

Gets or sets the specific function of the variable, such as identity, weight, geographic variable, etc.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public CodeValue Role { get; set; }

Property Value

Type	Description
CodeValue

ShouldCalculateFrequenciesForInvalidValues

Specify if frequencies should be calculated for Missing/Invalid values

Declaration

public bool ShouldCalculateFrequenciesForInvalidValues { get; set; }

Property Value

Type	Description
bool

ShouldCalculateFrequenciesForValidValues

Specify if frequencies should be calculated for all valid (non-missing) values

Declaration

public bool ShouldCalculateFrequenciesForValidValues { get; set; }

Property Value

Type	Description
bool

SourceParameter

Gets or sets the source parameter from which data for this variable were gathered.

Declaration

[Display(GroupName = "Misc", Order = 1000)]
public Parameter SourceParameter { get; set; }

Property Value

Type	Description
Parameter

SourceQuestionBlocks

Gets any source question blocks that may have collected data described by this variable.

Declaration

[Display(GroupName = "Sources", Order = 520)]
public ObservableCollection<QuestionBlock> SourceQuestionBlocks { get; }

Property Value

Type	Description
ObservableCollection<QuestionBlock>

SourceQuestionGrids

Gets any source question grids that may have collected data described by this variable.

Declaration

[Display(GroupName = "Sources", Order = 510)]
public ObservableCollection<QuestionGrid> SourceQuestionGrids { get; }

Property Value

Type	Description
ObservableCollection<QuestionGrid>

SourceQuestions

Gets any source questions that may have collected data described by this variable.

Declaration

[Display(GroupName = "Sources", Order = 500)]
public ObservableCollection<Question> SourceQuestions { get; }

Property Value

Type	Description
ObservableCollection<Question>

SourceVariables

Gets a collection of variables representing data from which data for this variable were computed.

Declaration

[Display(GroupName = "Sources", Order = 530)]
public ObservableCollection<Variable> SourceVariables { get; }

Property Value

Type	Description
ObservableCollection<Variable>

StandardWeight

Gets or sets a standard weight that may be used in analyzing this variable.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public StandardWeightCoding StandardWeight { get; set; }

Property Value

Type	Description
StandardWeightCoding

StartPosition

Position of the first character of the data item in a fixed format file.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public int? StartPosition { get; set; }

Property Value

Type	Description
int?

StorageFormat

An explicit definition of the data storage format.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public CodeValue StorageFormat { get; set; }

Property Value

Type	Description
CodeValue

TextRepresentation

Gets or sets the text representation.

Declaration

public TextDomain TextRepresentation { get; set; }

Property Value

Type	Description
TextDomain

UnitType

Gets or sets the type of entity the data refer to.

Declaration

[Display(GroupName = "Basic", Order = 500)]
public UnitType UnitType { get; set; }

Property Value

Type	Description
UnitType

Universes

Gets the universes that describe the persons or other elements that this variable refers to, and to which any analytic results refer.

Declaration

[Display(GroupName = "Basic", Order = 500)]
public ObservableCollection<Universe> Universes { get; }

Property Value

Type	Description
ObservableCollection<Universe>

WeightVariableReference

Gets or sets a weight variable that may be used in analyzing this variable.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public Variable WeightVariableReference { get; set; }

Property Value

Type	Description
Variable

Width

Data item width for fixed format file. Should be specified if a value for EndPosition is not provided.

Declaration

[Display(GroupName = "Basic:Metadata", Order = 500)]
public int? Width { get; set; }

Property Value

Type	Description
int?

Methods

GetChildren()

Gets the identifiers of the item's children.

Declaration

public override ChildItemCollection GetChildren()

Returns

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

Overrides

VersionableBase.GetChildren()

RemoveChild(IdentifierTriple)

Removes the specified child.

Declaration

public override int RemoveChild(IdentifierTriple child)

Parameters

Type	Name	Description
IdentifierTriple	child	The child to be removed.

Returns

Type	Description
int	The number of children removed from the item.

Overrides

VersionableBase.RemoveChild(IdentifierTriple)

Exceptions

Type	Condition
ArgumentNullException	child

ReplaceChild(IdentifierTriple, IVersionable)

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

Declaration

public override 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
int	The number of children replaced.

Overrides

VersionableBase.ReplaceChild(IdentifierTriple, IVersionable)

Exceptions

Type	Condition
ArgumentNullException	child

WatchProperties()

Watch for property changed events

Declaration

protected override void WatchProperties()