Wiki source code of 11 ItemSchemeMap
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | == 11.1 Scope == | ||
| 6 | |||
| 7 | An //ItemSchemeMap// is an abstract container to describe mapping rules between any [[item scheme>>doc:sdmx:Glossary 2\.1.Item scheme.WebHome]], with the exception of [[Codelists>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] and ValueLists which are mapped using the RepresentationMap. A single source //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is mapped to a single target //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//. The //ItemSchemeMap// then contains the rules for how the values from the source //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// map to the values in the target //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//. Each source [[value>>doc:IMElements.value.WebHome]] 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>>doc:IMElements.value.WebHome]] 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>>doc:IMElements.value.WebHome]] to carry. An example is a regular expression which states ‘match a [[value>>doc:IMElements.value.WebHome]] starting with AB followed by anything, where the //anything// is marked a capture group’, the target can state ‘take the //anything// [[value>>doc:IMElements.value.WebHome]] and postfix it with AB’ thus enabling the mapping of ABX to XAB and ABY to YAB. | ||
| 8 | |||
| 9 | The absence of an output for an input is interpreted as ‘no output [[value>>doc:IMElements.value.WebHome]] for the given source [[value>>doc:IMElements.value.WebHome]](s)’. | ||
| 10 | |||
| 11 | [[image:image66.png]] | ||
| 12 | |||
| 13 | **Figure 40: Item Scheme Map** | ||
| 14 | |||
| 15 | === 11.1.1 Explanation of the Diagram === | ||
| 16 | |||
| 17 | ==== 11.1.1.1 Narrative ==== | ||
| 18 | |||
| 19 | An ItemSchemeMap is an abstract [[type>>doc:IMElements.type.WebHome]] which inherits from Maintainable. It is subclassed by the 4 concrete classes: | ||
| 20 | |||
| 21 | * OrganisationSchemeMap | ||
| 22 | * ConceptSchemeMap | ||
| 23 | * CategorySchemeMap | ||
| 24 | * ReportingTaxonomyMap | ||
| 25 | |||
| 26 | An OrganisationSchemeMap maps a source [[AgencyScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.AgencyScheme.WebHome]], [[DataProviderScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.DataProviderScheme.WebHome]], [[DataConsumerScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.DataConsumerScheme.WebHome]] or [[OrganisationUnitScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.OrganisationUnitScheme.WebHome]] to a target [[AgencyScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.AgencyScheme.WebHome]], [[DataProviderScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.DataProviderScheme.WebHome]], [[DataConsumerScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.DataConsumerScheme.WebHome]] or [[OrganisationUnitScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.OrganisationUnitScheme.WebHome]]. It is permissible to mix source and target types to define an equivalence between Organisations of different roles. The mapped [[items>>doc:IMElements.items.WebHome]] refer to the Organisations in the source/target schemes. | ||
| 27 | |||
| 28 | A ConceptSchemeMap maps a source [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]] to a target [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]]. | ||
| 29 | |||
| 30 | The mapped [[items>>doc:IMElements.items.WebHome]] refer to the Concepts in the source/target schemes. | ||
| 31 | |||
| 32 | A CategorySchemeMap maps a source [[CategoryScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.CategoryScheme.WebHome]] to a target [[CategoryScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.CategoryScheme.WebHome]]. | ||
| 33 | |||
| 34 | The mapped Items refer to the Categories in the source/target schemes. | ||
| 35 | |||
| 36 | A ReportingTaxonomyMap maps a source [[ReportingTaxonomy>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ReportingTaxonomy.WebHome]] to a target [[ReportingTaxonomy>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ReportingTaxonomy.WebHome]]. The mapped Items refer to the [[ReportingCategory>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.ReportingCategory.WebHome]] in the source/target schemes. | ||
| 37 | |||
| 38 | ==== 11.1.1.2 Definitions ==== | ||
| 39 | |||
| 40 | (% style="width:949.835px" %) | ||
| 41 | |**Class**|**Feature**|(% style="width:542px" %)**Description** | ||
| 42 | |//ItemSchemeMap//|((( | ||
| 43 | Inherits from | ||
| 44 | //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// | ||
| 45 | )))|(% style="width:542px" %)Links source and target //ItemSchemes// | ||
| 46 | | |+source|(% style="width:542px" %)Association to a source //ItemScheme// | ||
| 47 | | |+target|(% style="width:542px" %)Association to a target //ItemScheme// | ||
| 48 | |ItemMap|((( | ||
| 49 | Inherits from | ||
| 50 | //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// | ||
| 51 | )))|(% style="width:542px" %)Describes how the source value maps to the target value | ||
| 52 | | |[[validFrom>>doc:IMElements.validFrom.WebHome]]|(% style="width:542px" %)Optional period describing when the mapping is applicable | ||
| 53 | | |[[validTo>>doc:IMElements.validTo.WebHome]]|(% style="width:542px" %)Optional period describing which the mapping is no longer applicable. | ||
| 54 | | |sourceValue|(% style="width:542px" %)Input value for source | ||
| 55 | | |targetValue|(% style="width:542px" %)Output value for each mapped target | ||
| 56 | | |isRegEx|(% style="width:542px" %)If true, the sourceValue field should be treated as a regular expression when comparing with the source data | ||
| 57 | | |startIndex|(% style="width:542px" %)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 | ||
| 58 | | |endIndex|(% style="width:542px" %)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 | ||
| 59 | |OrganisationSchemeMap|((( | ||
| 60 | Inherits from | ||
| 61 | //ItemSchemeMap// | ||
| 62 | )))|(% style="width:542px" %)Concrete //Maintainable// subtype of //ItemSchemeMap// | ||
| 63 | |ConceptSchemeMap|((( | ||
| 64 | Inherits from | ||
| 65 | //ItemSchemeMap// | ||
| 66 | )))|(% style="width:542px" %)Concrete //Maintainable// subtype of //ItemSchemeMap// | ||
| 67 | |CategorySchemeMap|((( | ||
| 68 | Inherits from | ||
| 69 | //ItemSchemeMap// | ||
| 70 | )))|(% style="width:542px" %)Concrete //Maintainable// subtype of //ItemSchemeMap// | ||
| 71 | |ReportingTaxonomyMap|((( | ||
| 72 | Inherits from | ||
| 73 | //ItemSchemeMap// | ||
| 74 | )))|(% style="width:542px" %)Concrete //Maintainable// subtype of //ItemSchemeMap// |