Class PhysicalInstance
Provides information about a data file, database, or other store of data.
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, IDublinCoreDescribableConstructors
PhysicalInstance()
Initializes a new instance of the PhysicalInstance class.
Declaration
public PhysicalInstance()Properties
ByteOrder
Gets or sets the byte order of the file.
Declaration
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 |
DataRelationships
Gets the DataRelationships which describe the record(s) contained in the dataset.
Declaration
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
public string Delimiter { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Description
Gets the description.
Declaration
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
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
public ObservableCollection<Fingerprint> Fingerprints { get; }Property Value
| Type | Description |
|---|---|
| ObservableCollection<Fingerprint> |
Format
Gets or sets the format of the file.
Declaration
public string Format { get; set; }Property Value
| Type | Description |
|---|---|
| String |
ItemName
Gets the name of the item.
Declaration
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
public MultilingualString Label { get; }Property Value
| Type | Description |
|---|---|
| MultilingualString |
RecordLayouts
Gets the descriptions of the records stored in the data file. This can be skipped in favor of the DataRelationships property.
Declaration
public ObservableCollection<RecordLayout> RecordLayouts { get; }Property Value
| Type | Description |
|---|---|
| ObservableCollection<RecordLayout> |
Statistics
Gets summary statistics describing the data in the file.
Declaration
public ObservableCollection<VariableStatistic> Statistics { get; }Property Value
| Type | Description |
|---|---|
| ObservableCollection<VariableStatistic> |
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 |
|---|---|
| Int32 | 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 |
|---|---|
| Int32 | The number of children replaced. |