Changes for page 8 Hierarchy

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -29,9 +29,9 @@
29	29
30	30	==== 8.2.2.1 Narrative ====
31	31
32		-The [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] and //HierarchyAssociation// inherit from //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// and thus have identification, naming, versioning and a [[maintenance agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]]. The Level is a //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// and therefore has an Id, multi-lingual [[name>>doc:IMElements.name.WebHome]] and multi-lingual [[description>>doc:IMElements.description.WebHome]]. A //HierachicalCode// is an //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]//.
	32	+The [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] and //HierarchyAssociation// inherit from //MaintainableArtefact// and thus have identification, naming, versioning and a [[maintenance agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]]. The (% style="color:#e74c3c" %)Level(%%) is a //NameableArtefact// and therefore has an Id, multi-lingual name and multi-lingual description. A //HierachicalCode// is an //IdentifiableArtefact//.
33	33
34		-It is important to understand that the Codes participating in a [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] are not themselves contained in the list – they are referenced from the list and are maintained in one or more [[Codelists>>doc:sdmx:Glossary 2\.1.Code list.WebHome]]. This is explained in the narrative of the relationship class diagram below.
	34	+It is important to understand that the [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] participating in a [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] are not themselves contained in the list – they are referenced from the list and are maintained in one or more [[Codelists>>doc:sdmx:Glossary 2\.1.Code list.WebHome]]. This is explained in the narrative of the relationship class diagram below.
35	35
36	36	==== 8.2.2.2 Definitions ====
37	37
...	...	@@ -51,57 +51,59 @@
51	51
52	52	The basic principles of the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] are:
53	53
54		-1. The [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] is a specification of the [[structure>>doc:IMElements.structure.WebHome]] of the Codes.
55		-1. The Codes in the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] are not themselves a part of the [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], rather they are [[references>>doc:IMElements.references.WebHome]] to Codes in one or more external [[Codelists>>doc:sdmx:Glossary 2\.1.Code list.WebHome]].
56		-1. The [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] of Codes is specified in HierarchicalCode. This [[references>>doc:IMElements.references.WebHome]] the [[Code>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Code.WebHome]] and its immediate [[child>>doc:IMElements.child.WebHome]] HierarchicalCodes.
	54	+1. The [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] is a specification of the structure of the [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]].
	55	+1. The [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] in the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] are not themselves a part of the [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], rather they are references to [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] in one or more external [[Codelists>>doc:sdmx:Glossary 2\.1.Code list.WebHome]].
	56	+1. The [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] of [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] is specified in HierarchicalCode. This references the [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]] and its immediate child HierarchicalCodes.
57	57
58		-A [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] can have formal levels (hasFormalLevels="true"). However, even if hasFormalLevels="false" the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] can still have one or more Levels associated in order to document information about the HierarchicalCodes.
	58	+A [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] can have formal (% style="color:#e74c3c" %)levels(%%) (hasFormalLevels="true"). However, even if hasFormalLevels="false" the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] can still have one or more (% style="color:#e74c3c" %)Levels(%%) associated in order to document information about the HierarchicalCodes.
59	59
60		-If hasFormalLevels="false" the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] is “[[value>>doc:IMElements.value.WebHome]] based” comprising a [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] of codes with no formal Levels. If hasFormalLevels="true" then the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] is “level based” where each Level is a formal Level in the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]], such as those present in [[statistical classifications>>doc:sdmx:Glossary 2\.1.Statistical Classification.WebHome]]. In a “level based” [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] each HierarchicalCode is linked to the Level in which it resides. It is expected that all HierarchicalCodes at the same hierarchic level defined by the +[[parent>>doc:IMElements.parent.WebHome]]/+[[child>>doc:IMElements.child.WebHome]] association will be linked to the same Level. Note that the +level association need only be specified if the HierarchicalCode is at a different hierarchical level (implied by the HierarchicalCode [[parent>>doc:IMElements.parent.WebHome]]/[[child>>doc:IMElements.child.WebHome]] association) than the actual Level in the level [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] (implied by the Level [[parent>>doc:IMElements.parent.WebHome]]/[[child>>doc:IMElements.child.WebHome]] association).
	60	+If hasFormalLevels="false" the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] is “value based” comprising a [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] of [[codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] with no formal (% style="color:#e74c3c" %)Levels(%%). If hasFormalLevels="true" then the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] is “(% style="color:#e74c3c" %)level(%%) based” where each (% style="color:#e74c3c" %)Level(%%) is a formal (% style="color:#e74c3c" %)Level(%%) in the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]], such as those present in [[statistical classifications>>doc:sdmx:Glossary 2\.1.Statistical Classification.WebHome]]. In a “(% style="color:#e74c3c" %)level(%%) based” [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] each HierarchicalCode is linked to the (% style="color:#e74c3c" %)Level(%%) in which it resides. It is expected that all HierarchicalCodes at the same hierarchic (% style="color:#e74c3c" %)level(%%) defined by the +parent/+child association will be linked to the same (% style="color:#e74c3c" %)Level(%%). Note that the +(% style="color:#e74c3c" %)level(%%) association need only be specified if the HierarchicalCode is at a different hierarchical (% style="color:#e74c3c" %)level(%%) (implied by the HierarchicalCode parent/child association) than the actual (% style="color:#e74c3c" %)Level(%%) in the (% style="color:#e74c3c" %)level(%%) [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] (implied by the (% style="color:#e74c3c" %)Level(%%) parent/child association).
61	61
62		-[Note that organisations wishing to be compliant with accepted models for [[statistical classifications>>doc:sdmx:Glossary 2\.1.Statistical Classification.WebHome]] should ensure that the Id is the number associated with the Level, where Levels are numbered consecutively starting with level 1 at the highest Level].
	62	+[Note that organisations wishing to be compliant with accepted models for [[statistical classifications>>doc:sdmx:Glossary 2\.1.Statistical Classification.WebHome]] should ensure that the Id is the number associated with the (% style="color:#e74c3c" %)Level(%%), where (% style="color:#e74c3c" %)Levels(%%) are numbered consecutively starting with (% style="color:#e74c3c" %)level(%%) 1 at the highest (% style="color:#e74c3c" %)Level(%%)].
63	63
64		-The Level may have CodingFormat information defined (e.g. coding [[type>>doc:IMElements.type.WebHome]] at that level).
	64	+The (% style="color:#e74c3c" %)Level(%%) may have CodingFormat information defined (e.g. coding type at that (% style="color:#e74c3c" %)level(%%)).
65	65
66		-A HierarchyAssociation links an [[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]] (+linkedObject), that needs a [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]], with the latter (+linkedHierarchy). The association is performed in a certain context (+contextObject), e.g. a [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]] in the context of a [[Dataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Dataflow.WebHome]].
	66	+A HierarchyAssociation links an IdentifiableArtefact (+linkedObject), that needs a [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]], with the latter (+linkedHierarchy). The association is performed in a certain context (+contextObject), e.g. a [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] in the context of a [[Dataflow>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]].
67	67
68		-==== 8.3.2.2 Definitions ====
	68	+==== 8.3.2.2 ====
69	69
	70	+==== Definitions ====
	71	+
70	70	(% style="width:901.835px" %)
71	71	|**Class**|**Feature**|(% style="width:564px" %)**Description**
72	72	|[[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]]|(((
73	73	Inherits from:
74		-//[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]//
75		-)))|(% style="width:564px" %)A [[classification>>doc:sdmx:Glossary 2\.1.Statistical Classification.WebHome]] structure arranged in levels of detail from the broadest to the most detailed level.
	76	+//MaintainableArtefact//
	77	+)))|(% style="width:564px" %)A [[classification>>doc:sdmx:Glossary 2\.1.Statistical Classification.WebHome]] structure arranged in (% style="color:#e74c3c" %)levels(%%) of detail from the broadest to the most detailed (% style="color:#e74c3c" %)level(%%).
76	76	| |hasFormalLevels|(% style="width:564px" %)(((
77		-If “true”, this indicates a [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] where the structure is arranged in levels of detail from the broadest to the most detailed level.
	79	+If “true”, this indicates a [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] where the structure is arranged in (% style="color:#e74c3c" %)levels(%%) of detail from the broadest to the most detailed (% style="color:#e74c3c" %)level(%%).
78	78
79		-If “false”, this indicates a [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] structure where the items in the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] have no formal level structure.
	81	+If “false”, this indicates a [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] structure where the items in the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] have no formal (% style="color:#e74c3c" %)level(%%) structure.
80	80	)))
81		-| |+codes|(% style="width:564px" %)Association to the top-level [[Hierarchical Codes>>doc:sdmx:Glossary 2\.1.Hierarchical code.WebHome]] in the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
82		-| |+level|(% style="width:564px" %)Association to the top Level in the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
83		-|Level|(((
	83	+| |+[[codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]]|(% style="width:564px" %)Association to the top-(% style="color:#e74c3c" %)level(%%) [[Hierarchical Codes>>doc:sdmx:Glossary 2\.1.Hierarchical code.WebHome]] in the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
	84	+| |+(% style="color:#e74c3c" %)level|(% style="width:564px" %)Association to the top (% style="color:#e74c3c" %)Level(%%) in the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
	85	+|(%%)(% style="color:#e74c3c" %)Level|(((
84	84	Inherits from
85		-//[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//
	87	+//NameableArtefact//
86	86	)))|(% style="width:564px" %)(((
87		-In a “level based” [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] this describes a group of Codes which are characterised by homogeneous coding, and where the parent of each Code in the group is at the same higher level of the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
88		-In a “value based’ [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] this describes information about the [[Hierarchical Codes>>doc:sdmx:Glossary 2\.1.Hierarchical code.WebHome]] at the specified nesting level.
	89	+In a “(% style="color:#e74c3c" %)level(%%) based” [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] this describes a group of [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] which are characterised by homogeneous coding, and where the parent of each [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]] in the group is at the same higher (% style="color:#e74c3c" %)level(%%) of the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
	90	+In a “value based’ [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] this describes information about the [[Hierarchical Codes>>doc:sdmx:Glossary 2\.1.Hierarchical code.WebHome]] at the specified nesting (% style="color:#e74c3c" %)level(%%).
89	89	)))
90	90	| |+codeFormat|(% style="width:564px" %)Association to the [[Coding Format>>doc:sdmx:Glossary 2\.1.Coding format.WebHome]].
91		-| |+[[child>>doc:IMElements.child.WebHome]]|(% style="width:564px" %)Association to a child Level of Level.
92		-|CodingFormat| |(% style="width:564px" %)Specifies format information for the codes at this level in the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] such as whether the codes at the level are alphabetic, numeric or alphanumeric and the code length.
93		-|HierarchicalCode| |(% style="width:564px" %)A hierarchic structure of code references.
94		-| |[[validFrom>>doc:IMElements.validFrom.WebHome]]|(% style="width:564px" %)Date from which the construct is valid
95		-| |[[validTo>>doc:IMElements.validTo.WebHome]]|(% style="width:564px" %)Date from which construct is superseded.
96		-| |+code|(% style="width:564px" %)Association to the Code that is used at the specific point in the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
97		-| |+[[child>>doc:IMElements.child.WebHome]]|(% style="width:564px" %)Association to a child Code in the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
98		-| |+level|(% style="width:564px" %)Association to a Level where levels have been defined for the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
99		-|[[Code>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Code.WebHome]]| |(% style="width:564px" %)The Code to be used at this point in the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
100		-| |/[[items>>doc:IMElements.items.WebHome]]|(% style="width:564px" %)Association to the [[Code list>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] containing the Code.
101		-|[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]]| |(% style="width:564px" %)The [[Code list>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] containing the Code.
	93	+| |+child|(% style="width:564px" %)Association to a child (% style="color:#e74c3c" %)Level(%%) of (% style="color:#e74c3c" %)Level(%%).
	94	+|CodingFormat| |(% style="width:564px" %)Specifies format information for the [[codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] at this (% style="color:#e74c3c" %)level(%%) in the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]] such as whether the [[codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]] at the (% style="color:#e74c3c" %)level(%%) are alphabetic, numeric or alphanumeric and the [[code>>doc:sdmx:Glossary 2\.1.Code.WebHome]] length.
	95	+|HierarchicalCode| |(% style="width:564px" %)A hierarchic structure of [[code>>doc:sdmx:Glossary 2\.1.Code.WebHome]] references.
	96	+| |validFrom|(% style="width:564px" %)Date from which the construct is valid
	97	+| |validTo|(% style="width:564px" %)Date from which construct is superseded.
	98	+| |+[[code>>doc:sdmx:Glossary 2\.1.Code.WebHome]]|(% style="width:564px" %)Association to the [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]] that is used at the specific point in the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
	99	+| |+child|(% style="width:564px" %)Association to a child [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]] in the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
	100	+| |+(% style="color:#e74c3c" %)level|(% style="width:564px" %)Association to a (% style="color:#e74c3c" %)Level(%%) where (% style="color:#e74c3c" %)levels(%%) have been defined for the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
	101	+|[[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]]| |(% style="width:564px" %)The [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]] to be used at this point in the [[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].
	102	+| |/items|(% style="width:564px" %)Association to the [[Code list>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] containing the [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]].
	103	+|[[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]]| |(% style="width:564px" %)The [[Code list>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] containing the [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]].
102	102	|HierarchyAssociation|(((
103	103	Inherits from:
104		-//[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]//
	106	+//MaintainableArtefact//
105	105	)))|(% style="width:564px" %)An association between an [[Identifiable Artefact>>doc:sdmx:Glossary 2\.1.Identifiable artefact.WebHome]] and a [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]], within a specific context.
106	106	| |+contextObject|(% style="width:564px" %)The context within which the association is performed.
107	107	| |+linkedObject|(% style="width:564px" %)Associates the [[Identifiable Artefact>>doc:sdmx:Glossary 2\.1.Identifiable artefact.WebHome]] that needs the [[Hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]].