Skip to Content

Changes for page 8 Hierarchy

Last modified by Artur on 2025/09/10 11:19
From version 8.1
edited by Helena
on 2025/05/22 14:09
Change comment: There is no comment for this version
To version 6.2
edited by Helena
on 2025/05/16 23:20
Change comment: There is no comment for this version

Summary

Details

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