Skip to Content

Changes for page 11 ItemSchemeMap

Last modified by Artur on 2025/09/10 11:19
From version 3.1
edited by Helena
on 2025/05/15 09:59
Change comment: There is no comment for this version
To version 6.5
edited by Helena
on 2025/05/19 14:26
Change comment: Update document after refactoring.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Methodology.SDMX 3\.0 Standards\. Section 2\. Information model\: UML conceptual design.WebHome
Content
... ... @@ -1,8 +1,10 @@
1 -= 11 ItemSchemeMap =
1 +{{box title="**Contents**"}}
2 +{{toc/}}
3 +{{/box}}
2 2  
3 3  == 11.1 Scope ==
4 4  
5 -An //ItemSchemeMap// is an abstract container to describe mapping rules between any item scheme, with the exception of Codelists and ValueLists which are mapped using the RepresentationMap. A single source //ItemScheme// is mapped to a single target //ItemScheme//. The //ItemSchemeMap// then contains the rules for how the values from the source //ItemScheme// map to the values in the target //ItemScheme//. Each source value may match a substring of the original data (using startIndex and/or endIndex) or define a pattern matching rule described by a regular expression. The target value is provided as an absolute string, although it can make use of regular expression groups to carry across values from the source string to the target string without having to explicitly state the value to carry. An example is a regular expression which states ‘match a value starting with AB followed by anything, where the //anything// is marked a capture group’, the target can state ‘take the //anything// value and postfix it with AB’ thus enabling the mapping of ABX to XAB and ABY to YAB.
7 +An //ItemSchemeMap// is an abstract container to describe mapping rules between any [[item scheme>>doc:xwiki:Glossary.Item scheme.WebHome]], with the exception of Codelists and ValueLists which are (% style="color:#2ecc71" %)mapped(%%) using the RepresentationMap. A single source //ItemScheme// is (% style="color:#2ecc71" %)mapped(%%) to a single target //ItemScheme//. The //ItemSchemeMap// then contains the rules for how the values from the source //ItemScheme// (% style="color:#2ecc71" %)map(%%) to the values in the target //ItemScheme//. Each source value may match a substring of the original data (using startIndex and/or endIndex) or define a pattern matching rule described by a regular expression. The target value is provided as an absolute string, although it can make use of regular expression groups to carry across values from the source string to the target string without having to explicitly state the value to carry. An example is a regular expression which states ‘match a value starting with AB followed by anything, where the //anything// is marked a capture group’, the target can state ‘take the //anything// value and postfix it with AB’ thus enabling the mapping of ABX to XAB and ABY to YAB.
6 6  
7 7  The absence of an output for an input is interpreted as ‘no output value for the given source value(s)’.
8 8  
... ... @@ -21,65 +21,57 @@
21 21  * CategorySchemeMap
22 22  * ReportingTaxonomyMap
23 23  
24 -An OrganisationSchemeMap maps a source AgencyScheme, DataProviderScheme, DataConsumerScheme or OrganisationUnitScheme to a target AgencyScheme, DataProviderScheme, DataConsumerScheme or OrganisationUnitScheme. It is permissible to mix source and target types to define an equivalence between Organisations of different roles. The mapped items refer to the Organisations in the source/target schemes.
26 +An OrganisationSchemeMap (% style="color:#2ecc71" %)maps(%%) a source AgencyScheme, DataProviderScheme, DataConsumerScheme or OrganisationUnitScheme to a target AgencyScheme, DataProviderScheme, DataConsumerScheme or OrganisationUnitScheme. It is permissible to mix source and target types to define an equivalence between Organisations of different roles. The (% style="color:#2ecc71" %)mapped(%%) items refer to the Organisations in the source/target schemes.
25 25  
26 -A ConceptSchemeMap maps a source ConceptScheme to a target ConceptScheme. The mapped items refer to the Concepts in the source/target schemes.
28 +A ConceptSchemeMap (% style="color:#2ecc71" %)maps(%%) a source ConceptScheme to a target ConceptScheme. The (% style="color:#2ecc71" %)mapped(%%) items refer to the (% style="color:#2ecc71" %)Concepts(%%) in the source/target schemes.
27 27  
28 -A CategorySchemeMap maps a source CategoryScheme to a target CategoryScheme. The mapped Items refer to the Categories in the source/target schemes.
30 +A CategorySchemeMap (% style="color:#2ecc71" %)maps(%%) a source CategoryScheme to a target CategoryScheme. The (% style="color:#2ecc71" %)mapped(%%) Items refer to the [[Categories>>doc:xwiki:Glossary.Category.WebHome]] in the source/target schemes.
29 29  
30 -A ReportingTaxonomyMap maps a source ReportingTaxonomy to a target ReportingTaxonomy. The mapped Items refer to the ReportingCategory in the source/target schemes.
32 +A ReportingTaxonomyMap (% style="color:#2ecc71" %)maps(%%) a source ReportingTaxonomy to a target ReportingTaxonomy. The (% style="color:#2ecc71" %)mapped(%%) Items refer to the ReportingCategory in the source/target schemes.
31 31  
32 32  ==== 11.1.1.2 Definitions ====
33 33  
34 -|**Class**|**Feature**|(% colspan="2" %)**Description**
35 -|//ItemSchemeMap//|(((
36 +(% style="width:808.294px" %)
37 +|(% style="width:205px" %)**Class**|(% style="width:216px" %)**Feature**|(% colspan="2" style="width:385px" %)**Description**
38 +|(% style="width:205px" %)//ItemSchemeMap//|(% style="width:216px" %)(((
36 36  Inherits from
37 -
38 -//MaintainableArtef act//
39 -)))|(% colspan="2" %)(((
40 +//MaintainableArtefact//
41 +)))|(% colspan="2" style="width:385px" %)(((
40 40  Links source and target
41 -
42 42  //ItemSchemes//
43 43  )))
44 -||+source|(% colspan="2" %)(((
45 +|(% style="width:205px" %) |(% style="width:216px" %)+source|(% colspan="2" style="width:385px" %)(((
45 45  Association to a source
46 -
47 47  //ItemScheme//
48 48  )))
49 -||+target|(% colspan="2" %)(((
49 +|(% style="width:205px" %) |(% style="width:216px" %)+target|(% colspan="2" style="width:385px" %)(((
50 50  Association to a target
51 -
52 52  //ItemScheme//
53 53  )))
54 -|ItemMap|(((
53 +|(% style="width:205px" %)ItemMap|(% style="width:216px" %)(((
55 55  Inherits from
56 -
57 57  //AnnotableArtefact//
58 -)))|(% colspan="2" %)Describes how the source value maps to the target value
59 -||validFrom|(% colspan="2" %)Optional period describing when the mapping is applicable
60 -||validTo|(% colspan="2" %)Optional period describing which the mapping is no longer applicable.
61 -||sourceValue|(% colspan="2" %)Input value for source
62 -||targetValue|(% colspan="2" %)Output value for each mapped target
63 -||isRegEx|(% colspan="2" %)If true, the sourceValue field should be treated as a regular expression when comparing with the source data
64 -||startIndex|(% colspan="2" %)If provided, a substring of the source data should be taken, starting from this index (starting at zero) before comparing with the //value// field for matching
65 -||endIndex|(% colspan="2" %)If provided, a substring of the source data should be taken, ending at this index (starting at zero) before comparing with the //value// field for matching
66 -|OrganisationSchemeMap|(% colspan="2" %)(((
56 +)))|(% colspan="2" style="width:385px" %)Describes how the source value (% style="color:#2ecc71" %)maps(%%) to the target value
57 +|(% style="width:205px" %) |(% style="width:216px" %)validFrom|(% colspan="2" style="width:385px" %)Optional period describing when the mapping is applicable
58 +|(% style="width:205px" %) |(% style="width:216px" %)validTo|(% colspan="2" style="width:385px" %)Optional period describing which the mapping is no longer applicable.
59 +|(% style="width:205px" %) |(% style="width:216px" %)sourceValue|(% colspan="2" style="width:385px" %)Input value for source
60 +|(% style="width:205px" %) |(% style="width:216px" %)targetValue|(% colspan="2" style="width:385px" %)Output value for each (% style="color:#2ecc71" %)mapped(%%) target
61 +|(% style="width:205px" %) |(% style="width:216px" %)isRegEx|(% colspan="2" style="width:385px" %)If true, the sourceValue field should be treated as a regular expression when comparing with the source data
62 +|(% style="width:205px" %) |(% style="width:216px" %)startIndex|(% colspan="2" style="width:385px" %)If provided, a substring of the source data should be taken, starting from this index (starting at zero) before comparing with the //value// field for matching
63 +|(% style="width:205px" %) |(% style="width:216px" %)endIndex|(% colspan="2" style="width:385px" %)If provided, a substring of the source data should be taken, ending at this index (starting at zero) before comparing with the //value// field for matching
64 +|(% style="width:205px" %)OrganisationSchemeMap|(% colspan="2" style="width:192px" %)(((
67 67  Inherits from
68 -
69 69  //ItemSchemeMap//
70 -)))|Concrete //Maintainable// subtype of //ItemSchemeMap//
71 -|ConceptSchemeMap**    **|(% colspan="2" %)(((
67 +)))|(% style="width:407px" %)Concrete //Maintainable// subtype of //ItemSchemeMap//
68 +|(% style="width:205px" %)ConceptSchemeMap|(% colspan="2" style="width:192px" %)(((
72 72  Inherits from
73 -
74 74  //ItemSchemeMap//
75 -)))|Concrete //Maintainable// subtype of //ItemSchemeMap//
76 -|CategorySchemeMap|(% colspan="2" %)(((
71 +)))|(% style="width:407px" %)Concrete //Maintainable// subtype of //ItemSchemeMap//
72 +|(% style="width:205px" %)CategorySchemeMap|(% colspan="2" style="width:192px" %)(((
77 77  Inherits from
78 -
79 79  //ItemSchemeMap//
80 -)))|Concrete //Maintainable// subtype of //ItemSchemeMap//
81 -|ReportingTaxonomyMap|(% colspan="2" %)(((
75 +)))|(% style="width:407px" %)Concrete //Maintainable// subtype of //ItemSchemeMap//
76 +|(% style="width:205px" %)ReportingTaxonomyMap|(% colspan="2" style="width:192px" %)(((
82 82  Inherits from
83 -
84 84  //ItemSchemeMap//
85 -)))|Concrete //Maintainable// subtype of //ItemSchemeMap//
79 +)))|(% style="width:407px" %)Concrete //Maintainable// subtype of //ItemSchemeMap//