Show / Hide Table of Contents

Class ClassificationIndex

A Classification Index is an ordered list (alphabetical, in code order etc) of Classification Index Entries. A Classification Index can relate to one particular or to several Statistical Classifications. A Classification Index shows the relationship between text found in statistical data sources (responses to survey questionnaires, administrative records) and one or more Statistical Classifications. A Classification Index may be used to assign the codes for Classification Items to observations in statistical collections.

Inheritance
object
NotificationObject
IdentifiableBase
VersionableBase
DescribableBase
ClassificationIndex
Implements
INotifyPropertyChanged
IVersionable
IIdentifiable
IHasCustomFields
IDescribable
IVisitable
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 ClassificationIndex : DescribableBase, INotifyPropertyChanged, IVersionable, IIdentifiable, IHasCustomFields, IDescribable, IVisitable

Properties

CodingInstructions

Additional information which drives the coding process for all entries in a Classification Index. Supports the use of multiple languages and structured content.

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

ContactPerson

Person(s) who may be contacted for additional information about the Classification Index.

Declaration
public ObservableCollection<Organization> ContactPerson { get; set; }
Property Value
Type Description
ObservableCollection<Organization>

Corrections

Summary description of corrections, which have occurred within the Classification Index. Corrections include changing the item code associated with a Classification Index Entry.

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

Entries

An ordered list (alphabetical, in code order etc.) of Classification Index Entries.

Declaration
public ObservableCollection<ClassificationIndexEntry> Entries { get; set; }
Property Value
Type Description
ObservableCollection<ClassificationIndexEntry>

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

Languages

A Classification Index can exist in several languages. Indicates the languages available. If a Classification Index exists in several languages, the number of entries in each language may be different, as the number of terms describing the same phenomenon can change from one language to another. However, the same phenomena should be described in each language. Language is expressed using standard RFC 1766 language codes (for example: fr, en) and may be extended with the use of specific locations (en-UK).

Declaration
public ObservableCollection<string> Languages { get; set; }
Property Value
Type Description
ObservableCollection<string>

MaintenanceUnit

The unit or group of persons within the organization responsible for the Classification Index, i.e. for adding, changing or deleting Classification Index Entries.

Declaration
public ObservableCollection<Organization> MaintenanceUnit { get; set; }
Property Value
Type Description
ObservableCollection<Organization>

Publications

A list of the publications in which the Classification Index has been published.

Declaration
public ObservableCollection<OtherMaterial> Publications { get; set; }
Property Value
Type Description
ObservableCollection<OtherMaterial>

ReleaseDate

Date when the current version of the Classification Index was released.

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

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()
Overrides
DescribableBase.WatchProperties()

Implements

INotifyPropertyChanged
IVersionable
IIdentifiable
IHasCustomFields
IDescribable
IVisitable

Extension Methods

VersionableCustomFieldExtensions.GetCustomFieldMultilingualStringValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.GetCustomFieldStringValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.GetCustomFieldUriValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, MultilingualString, IVersionable)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, MultilingualString, string)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, string, IVersionable)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, string, string)
Extensions.GetDdi32FragmentRepresentation(IVersionable, Ddi32Serializer)
Extensions.GetDdi33FragmentRepresentation(IVersionable, Ddi33Serializer)
Extensions.GetDdiFragmentRepresentation(IVersionable, DDIWorkflowSerializer, XmlDocument)
Extensions.GetMultilingualStrings(IVersionable)
NamingHelper.GetBaseFileNameForItem(IVersionable)
VersionableExtensions.GetHeader(IVersionable, bool)
VersionableExtensions.GetMetadata(IVersionable)
VersionableExtensions.GetUserAttribute(IVersionable, string)
VersionableExtensions.GetUserAttributeInt(IVersionable, string)
VersionableExtensions.SetUserAttribute(IVersionable, string, string)
VersionableUserIdExtensions.SetUserId(IVersionable, string, string)
In this article
Back to top Generated by DocFX