Class PhysicalInstance

Provides information about a data file, database, or other store of data.

Inheritance
object
NotificationObject
IdentifiableBase
VersionableBase
PhysicalInstance
Implements
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class PhysicalInstance : VersionableBase, INotifyPropertyChanged, IVersionable, IIdentifiable, IHasCustomFields, IVisitable, IDescribable, IDublinCoreDescribable, IHasCoverage

Constructors

PhysicalInstance()

Initializes a new instance of the PhysicalInstance class.

Declaration
public PhysicalInstance()

Properties

ByteOrder

Gets or sets the byte order of the file.

Declaration
[UIHint("skip")]
public CodeValue ByteOrder { get; set; }
Property Value
Type Description
CodeValue

ChildTypesAccepted

Child types that can be added to this Physical Instance

Declaration
public override Collection<Guid> ChildTypesAccepted { get; }
Property Value
Type Description
Collection<Guid>
Overrides

Coverage

Gets information about the different topics, areas, and times covered by the data.

Declaration
public Coverage Coverage { get; set; }
Property Value
Type Description
Coverage

DataFileVersionDate

Date of the business version of the data file.

Declaration
public Date DataFileVersionDate { get; set; }
Property Value
Type Description
Date

DataFileVersionNumber

Business version of the data file. This is required if other data file version properties are used for DDI serialization.

Declaration
public string DataFileVersionNumber { get; set; }
Property Value
Type Description
string

DataFileVersionRationale

Gets the log message for the rationale or purpose of this version of the item.

Declaration
public MultilingualString DataFileVersionRationale { get; }
Property Value
Type Description
MultilingualString

DataFileVersionType

Gets or sets the data file version type of the file.

Declaration
public string DataFileVersionType { get; set; }
Property Value
Type Description
string

DataRelationships

Gets the DataRelationships which describe the record(s) contained in the dataset.

Declaration
[UIHint("skip")]
public ObservableCollection<DataRelationship> DataRelationships { get; }
Property Value
Type Description
ObservableCollection<DataRelationship>

Delimiter

Gets or sets the delimiter used to separate records in text-based data files.

Declaration
[UIHint("skip")]
public string Delimiter { get; set; }
Property Value
Type Description
string

Description

Gets the description.

Declaration
[Display(GroupName = "Basic", Order = 400)]
public MultilingualString Description { get; }
Property Value
Type Description
MultilingualString

DisplayLabel

Gets the display label.

Declaration
public override string DisplayLabel { get; }
Property Value
Type Description
string
Overrides

DublinCoreMetadata

Gets the Dublin Core citation for the data.

Declaration
public DublinCore DublinCoreMetadata { get; set; }
Property Value
Type Description
DublinCore

FileIdentifications

Gets descriptions of the locations where the data reside.

Declaration
[UIHint("skip")]
public ObservableCollection<DataFileIdentification> FileIdentifications { get; }
Property Value
Type Description
ObservableCollection<DataFileIdentification>

FileStructure

Gets or sets the gross file structure. This is not required.

Declaration
public GrossFileStructure FileStructure { get; set; }
Property Value
Type Description
GrossFileStructure

Fingerprints

Gets the digital fingerprints of the file.

Declaration
[UIHint("skip")]
public ObservableCollection<Fingerprint> Fingerprints { get; }
Property Value
Type Description
ObservableCollection<Fingerprint>

Format

Gets or sets the format of the file.

Declaration
[UIHint("skip")]
public string Format { get; set; }
Property Value
Type Description
string

InformationClassificationType

Gets or sets the type of information classification

Declaration
public CodeValue InformationClassificationType { get; set; }
Property Value
Type Description
CodeValue

InformationClassifications

Gets a collection of Information Classification associated with the physical instance.

Declaration
public ObservableCollection<InformationClassification> InformationClassifications { get; }
Property Value
Type Description
ObservableCollection<InformationClassification>

ItemName

Gets the name of the item.

Declaration
[UIHint("skip")]
public MultilingualString ItemName { get; }
Property Value
Type Description
MultilingualString

The name of the item.

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

Label

Gets the label.

Declaration
[UIHint("skip")]
public MultilingualString Label { get; }
Property Value
Type Description
MultilingualString

LevelOfInformationClassification

Gets or sets the level of information classification

Declaration
public CodeValue LevelOfInformationClassification { get; set; }
Property Value
Type Description
CodeValue

RecordLayouts

Gets the descriptions of the records stored in the data file. This can be skipped in favor of the DataRelationships property.

Declaration
[UIHint("skip")]
public ObservableCollection<RecordLayout> RecordLayouts { get; }
Property Value
Type Description
ObservableCollection<RecordLayout>

Statistics

Gets summary statistics describing the data in the file.

Declaration
[UIHint("skip")]
public ObservableCollection<VariableStatistic> Statistics { get; }
Property Value
Type Description
ObservableCollection<VariableStatistic>

VariableGroups

Gets the VariableGroup which organizes Variables contained in the dataset.

Declaration
[Display(GroupName = "Variable Groups", Order = 400)]
public ObservableCollection<VariableGroup> VariableGroups { get; }
Property Value
Type Description
ObservableCollection<VariableGroup>

Methods

AddChild(IVersionable)

Add an item as a child to this Physical Instance

Declaration
public override void AddChild(IVersionable child)
Parameters
Type Name Description
IVersionable child

Versionable child to add
Overrides

FindStatisticsForVariable(Variable)

Gets the summary statistics for the specified variable.

Declaration
public VariableStatistic FindStatisticsForVariable(Variable variable)
Parameters
Type Name Description
Variable variable

The variable.
Returns
Type Description
VariableStatistic

Summary statistics for the variable.

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

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

WatchProperties()

Watch for property changed events

Declaration
protected override void WatchProperties()
Overrides

Implements

Extension Methods