Wiki source code of 3 SDMX Base Package
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
2.2 | 1 | {{box title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| |
1.1 | 5 | == 3.1 Introduction == |
| 6 | |||
| |
36.1 | 7 | The constructs in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base package comprise the (% style="color:#9b59b6" %)fundamental (%%)building blocks that support many of the other structures in the model. For this reason, many of the classes in this package are abstract (i.e., only derived sub-classes can exist in an implementation). |
| |
1.1 | 8 | |
| |
29.2 | 9 | The motivation for establishing the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base package is as follows: |
| |
1.1 | 10 | |
| 11 | it is accepted “Best Practise” to identify fundamental archetypes occurring in a model// //identification of commonly found structures or “patterns” leads to easier understanding// //identification of patterns encourages re-use | ||
| 12 | |||
| |
29.2 | 13 | Each of the class diagrams in this section views classes from the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Base package from a different perspective. There are detailed views of specific patterns, plus overviews showing inheritance between classes, and relationships amongst classes. |
| |
1.1 | 14 | |
| |
2.3 | 15 | == 3.2 Base Structures - Identification, Versioning, and Maintenance == |
| |
1.1 | 16 | |
| |
2.3 | 17 | === 3.2.1 Class Diagram === |
| |
1.1 | 18 | |
| |
14.1 | 19 | [[image:image36.png]] |
| 20 | |||
| |
1.1 | 21 | **Figure 10: SDMX Identification, Maintenance and Versioning** |
| 22 | |||
| |
2.3 | 23 | === 3.2.2 Explanation of the Diagram === |
| |
1.1 | 24 | |
| |
2.3 | 25 | ==== 3.2.2.1 Narrative ==== |
| |
1.1 | 26 | |
| |
29.2 | 27 | This group of classes forms the nucleus of the administration facets of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] objects. They provide features which are reusable by derived classes to support horizontal functionality such as identity, versioning etc. |
| |
1.1 | 28 | |
| |
29.2 | 29 | All classes derived from the abstract class //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// may have Annotations (or notes): this supports the need to add notes to all [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] elements. The [[Annotation>>doc:IMElements.Annotation.WebHome]] is used to convey extra information to describe any [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] construct. This information may be in the form of a URL reference and/or a multilingual [[text>>doc:IMElements.text.WebHome]] (represented by the association to [[InternationalString>>doc:IMElements.InternationalString.WebHome]]). |
| |
1.1 | 30 | |
| |
29.1 | 31 | The //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// is an abstract class that comprises the basic [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] needed for identification. Concrete classes based on //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// all inherit the ability to be uniquely identified. |
| |
1.1 | 32 | |
| |
29.2 | 33 | The (% style="background-color:#e74c3c" %)//NamableArtefact//(%%) is an abstract class that inherits from //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]] //and in addition the +[[description>>doc:IMElements.description.WebHome]] and +[[name>>doc:IMElements.name.WebHome]] roles support multilingual descriptions and names for all objects based on //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//. The [[InternationalString>>doc:IMElements.InternationalString.WebHome]] supports the representation of a [[description>>doc:IMElements.description.WebHome]] in multiple locales ([[locale>>doc:IMElements.locale.WebHome]] is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). The //[[LocalisedString>>doc:IMElements.LocalisedString.WebHome]]// supports the representation of a [[description>>doc:IMElements.description.WebHome]] in one [[locale>>doc:IMElements.locale.WebHome]]. |
| |
1.1 | 34 | |
| |
29.1 | 35 | //[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]// is an abstract class which inherits from //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// and adds versioning ability to all classes derived from it, as explained in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. |
| |
1.1 | 36 | |
| |
27.4 | 37 | //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// further adds the ability for derived classes to be maintained via its association to an //[[Organisation>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.WebHome]]//, and adds locational information (i.e., from where the object can be retrieved). |
| |
1.1 | 38 | |
| |
29.2 | 39 | The inheritance chain from //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// through to //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// allows [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] classes to inherit the features they need, from simple annotation, through identity, naming, to versioning and maintenance. |
| |
1.1 | 40 | |
| |
2.3 | 41 | ==== 3.2.2.2 Definitions ==== |
| |
1.1 | 42 | |
| |
2.3 | 43 | (% style="width:973.835px" %) |
| 44 | |**Class**|(% style="width:262px" %)**Feature**|(% style="width:543px" %)**Description** | ||
| |
27.4 | 45 | |//[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]//|(% style="width:262px" %)((( |
| |
1.1 | 46 | Base inheritance sub classes are: |
| |
27.4 | 47 | //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// |
| |
29.2 | 48 | )))|(% style="width:543px" %)Objects of classes derived from this can have attached annotations. |
| |
27.4 | 49 | |[[Annotation>>doc:IMElements.Annotation.WebHome]]|(% style="width:262px" %)// //|(% style="width:543px" %)Additional descriptive information attached to an object. |
| |
29.2 | 50 | | |(% style="width:262px" %)[[id>>doc:IMElements.id.WebHome]]|(% style="width:543px" %)Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object. |
| 51 | | |(% style="width:262px" %)[[title>>doc:IMElements.title.WebHome]]|(% style="width:543px" %)A title used to identify an annotation. | ||
| 52 | | |(% style="width:262px" %)[[type>>doc:IMElements.type.WebHome]]|(% style="width:543px" %)Specifies how the annotation is to be processed. | ||
| |
27.4 | 53 | | |(% style="width:262px" %)[[url>>doc:IMElements.url.WebHome]]|(% style="width:543px" %)A link to external descriptive text. |
| |
29.2 | 54 | | |(% style="width:262px" %)[[value>>doc:IMElements.value.WebHome]]|(% style="width:543px" %)A non-localised version of the Annotation content. |
| |
29.1 | 55 | | |(% style="width:262px" %)+[[url>>doc:IMElements.url.WebHome]]|(% style="width:543px" %)An International URI provides a set of links that are [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] specific, via this role. |
| |
29.2 | 56 | | |(% style="width:262px" %)+[[text>>doc:IMElements.text.WebHome]]|(% style="width:543px" %)An [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] provides the multilingual text content of the annotation via this role. |
| |
27.4 | 57 | |[[InternationalUri>>doc:IMElements.InternationalURI.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The International Uri is a collection of Localised URIs and supports linking to external descriptions in multiple locales. |
| |
29.1 | 58 | |[[LocalisedUri>>doc:IMElements.LocalisedURI.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The Localised URI supports the link to an external description in one locale (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). |
| |
27.4 | 59 | |//[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]//|(% style="width:262px" %)((( |
| 60 | Superclass is //[[AnnotableArtefact>>doc:IMElements.AnnotableArtefact.WebHome]]// | ||
| |
1.1 | 61 | Base inheritance sub classes are: |
| |
27.4 | 62 | //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// |
| |
29.2 | 63 | )))|(% style="width:543px" %)Provides identity to all derived classes. It also provides annotations to derived classes because it is a subclass of [[Annotable Artefact>>doc:sdmx:Glossary 2\.1.Annotable artefact.WebHome]]. |
| |
27.4 | 64 | | |(% style="width:262px" %)[[id>>doc:IMElements.id.WebHome]]|(% style="width:543px" %)The unique identifier of the object. |
| 65 | | |(% style="width:262px" %)[[uri>>doc:IMElements.uri.WebHome]]|(% style="width:543px" %)Universal resource identifier that may or may not be resolvable. | ||
| 66 | | |(% style="width:262px" %)[[urn>>doc:IMElements.urn.WebHome]]|(% style="width:543px" %)Universal resource name – this is for use in registries: all registered objects have a urn. | ||
| 67 | |//[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]//|(% style="width:262px" %)((( | ||
| 68 | Superclass is //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// Base inheritance sub classes are: | ||
| 69 | //[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]// | ||
| |
29.2 | 70 | )))|(% style="width:543px" %)Provides a Name and Description to all derived classes in addition to identification and annotations. |
| |
29.1 | 71 | | |(% style="width:262px" %)+[[description>>doc:IMElements.description.WebHome]]|(% style="width:543px" %)A multi-lingual description is provided by this role via the [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] class. |
| 72 | | |(% style="width:262px" %)+[[name>>doc:IMElements.name.WebHome]]|(% style="width:543px" %)A multi-lingual name is provided by this role via the [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] class | ||
| |
29.2 | 73 | |[[InternationalString>>doc:IMElements.InternationalString.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The [[International String>>doc:sdmx:Glossary 2\.1.International string.WebHome]] is a collection of Localised Strings and supports the representation of text in multiple locales. |
| 74 | |[[LocalisedString>>doc:IMElements.LocalisedString.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)The Localised String supports the representation of text in one locale (locale is similar to [[language>>doc:sdmx:Glossary 2\.1.Language.WebHome]] but includes geographic variations such as Canadian French, US English etc.). | ||
| |
27.4 | 75 | | |(% style="width:262px" %)[[label>>doc:IMElements.label.WebHome]]|(% style="width:543px" %)Label of the string. |
| 76 | | |(% style="width:262px" %)[[locale>>doc:IMElements.locale.WebHome]]|(% style="width:543px" %)The geographic locale of the string e.g French, Canadian French. | ||
| 77 | |//[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]//|(% style="width:262px" %)((( | ||
| |
1.1 | 78 | Superclass is |
| |
27.4 | 79 | //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// |
| |
1.1 | 80 | Base inheritance sub classes are: |
| |
27.4 | 81 | //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// |
| |
2.3 | 82 | )))|(% style="width:543px" %)Provides versioning information for all derived objects. |
| |
29.1 | 83 | | |(% style="width:262px" %)[[version>>doc:IMElements.version.WebHome]]|(% style="width:543px" %)A version string following [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules. |
| |
27.4 | 84 | | |(% style="width:262px" %)[[validFrom>>doc:IMElements.validFrom.WebHome]]|(% style="width:543px" %)Date from which the version is valid |
| 85 | | |(% style="width:262px" %)[[validTo>>doc:IMElements.validTo.WebHome]]|(% style="width:543px" %)Date from which version is superseded | ||
| 86 | |//[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]//|(% style="width:262px" %)((( | ||
| |
1.1 | 87 | Inherits from |
| 88 | |||
| |
27.4 | 89 | //[[VersionableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.WebHome]]// |
| |
29.1 | 90 | )))|(% style="width:543px" %)An abstract class to group together primary [[structural metadata>>doc:sdmx:Glossary 2\.1.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that are maintained by an Agency. |
| |
27.4 | 91 | | |(% style="width:262px" %)[[isExternalReference>>doc:IMElements.isExternalReference.WebHome]]|(% style="width:543px" %)If set to “true” it indicates that the content of the object is held externally. |
| |
29.1 | 92 | | |(% style="width:262px" %)[[structureURL>>doc:IMElements.structureURL.WebHome]]|(% style="width:543px" %)The URL of an [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] document containing the external object. |
| 93 | | |(% style="width:262px" %)[[serviceURL>>doc:IMElements.serviceURL.WebHome]]|(% style="width:543px" %)The URL of an [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]]-compliant web service from which the external object can be retrieved. | ||
| 94 | | |(% style="width:262px" %)+[[maintainer>>doc:IMElements.maintainer.WebHome]]|(% style="width:543px" %)Association to the [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]] responsible for maintaining the [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. | ||
| |
27.4 | 95 | |[[Agency>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.Agency.WebHome]]|(% style="width:262px" %) |(% style="width:543px" %)See section on “Organisations” |
| |
1.1 | 96 | |
| |
2.3 | 97 | == 3.3 Basic Inheritance == |
| |
1.1 | 98 | |
| |
2.3 | 99 | === 3.3.1 Class Diagram – Basic Inheritance from the Base Inheritance Classes === |
| |
1.1 | 100 | |
| |
25.2 | 101 | [[image:image37.png]] |
| |
14.2 | 102 | |
| |
1.1 | 103 | **Figure 11: Basic Inheritance from the Base Structures** |
| 104 | |||
| |
2.3 | 105 | === 3.3.2 Explanation of the Diagram === |
| |
1.1 | 106 | |
| |
2.3 | 107 | ==== 3.3.2.1 Narrative ==== |
| |
1.1 | 108 | |
| 109 | The diagram above shows the inheritance within the base structures. The concrete classes are introduced and defined in the specific package to which they relate. | ||
| 110 | |||
| |
2.3 | 111 | == 3.4 Data Types == |
| |
1.1 | 112 | |
| |
2.3 | 113 | === 3.4.1 Class Diagram === |
| |
1.1 | 114 | |
| |
26.2 | 115 | [[image:image38.png]] |
| |
14.2 | 116 | |
| |
1.1 | 117 | **Figure 12: Class Diagram of Basic Data Types** |
| 118 | |||
| |
2.4 | 119 | === 3.4.2 Explanation of the Diagram === |
| |
1.1 | 120 | |
| |
2.4 | 121 | ==== 3.4.2.1 Narrative ==== |
| |
1.1 | 122 | |
| |
29.3 | 123 | The FacetType and FacetValueType enumerations are used to specify the valid format of the content of a non-[[enumerated>>doc:IMElements.enumerated.WebHome]] [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] or the usage of a [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] when specified for use on a //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// on a //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// (such as a [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]] in a [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]]). The [[description>>doc:IMElements.description.WebHome]] of the various types can be found in the chapter on [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]] (section 4.5). |
| |
1.1 | 124 | |
| |
29.3 | 125 | The ActionType enumeration is used to specify the [[action>>doc:IMElements.action.WebHome]] that a receiving system should take when processing the content that is the object of the [[action>>doc:IMElements.action.WebHome]]. It is [[enumerated>>doc:IMElements.enumerated.WebHome]] as follows: |
| |
1.1 | 126 | |
| |
29.3 | 127 | * Append: Data or [[metadata>>doc:IMElements.metadata.WebHome]] is an [[incremental update>>doc:sdmx:Glossary 2\.1.Incremental update.WebHome]] for an existing data/[[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]] or the provision of new data or documentation ([[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] values) formerly absent. If any of the supplied data or [[metadata>>doc:IMElements.metadata.WebHome]] is already present, it will not replace that data or [[metadata>>doc:IMElements.metadata.WebHome]]. This corresponds to the "Update" [[value>>doc:IMElements.value.WebHome]] found in [[version>>doc:IMElements.version.WebHome]] 1.0 of the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Technical Standards. |
| 128 | * Replace: Data/[[metadata>>doc:IMElements.metadata.WebHome]] is to be replaced and may also include additional data/[[metadata>>doc:IMElements.metadata.WebHome]] to be appended. | ||
| |
1.1 | 129 | * Delete: Data/Metadata is to be deleted. |
| |
29.3 | 130 | * Information: Data and [[metadata>>doc:IMElements.metadata.WebHome]] are for information purposes. |
| |
1.1 | 131 | |
| |
29.3 | 132 | The ToValueType data [[type>>doc:IMElements.type.WebHome]] contains the [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] to support transformations defined in the StructureMap (see Section 0). |
| |
1.1 | 133 | |
| |
29.3 | 134 | The ConstraintRoleType data [[type>>doc:IMElements.type.WebHome]] contains the [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] that identify the purpose of a [[Constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] (allowableContent, actualContent). |
| |
1.1 | 135 | |
| |
27.4 | 136 | The ComponentRoleType data [[type>>doc:IMElements.type.WebHome]] contains the predefined [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] roles that can be assigned to any [[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]. |
| |
1.1 | 137 | |
| |
27.4 | 138 | The CascadeValues data [[type>>doc:IMElements.type.WebHome]] contains the possible values for a [[MemberValue>>doc:IMElements.SelectionValue.MemberValue.WebHome]] within a CubeRegion, in order to enable cascading to all children Codes of a selected [[Code>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Code.WebHome]], while including/excluding the latter in the selection. |
| |
1.1 | 139 | |
| |
29.3 | 140 | The VersionType data types provides the details for versioning according to [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Standards Section 6, paragraph “4.3 Versioning”. |
| |
1.1 | 141 | |
| |
2.4 | 142 | == 3.5 The Item Scheme Pattern == |
| |
1.1 | 143 | |
| |
2.4 | 144 | === 3.5.1 Context === |
| |
1.1 | 145 | |
| |
27.4 | 146 | The [[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]] Scheme is a basic architectural pattern that allows the creation of list schemes for use in simple taxonomies, for example. |
| |
1.1 | 147 | |
| |
29.4 | 148 | The //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is the basis for [[CategoryScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.CategoryScheme.WebHome]], [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]], [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]], [[ReportingTaxonomy>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ReportingTaxonomy.WebHome]], //[[OrganisationScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.WebHome]]//, TransformationScheme, CustomTypeScheme, NamePersonalisationScheme, RulesetScheme, VtlMappingScheme and UserDefinedOperatorScheme. |
| |
1.1 | 149 | |
| |
2.4 | 150 | === 3.5.2 Class Diagram === |
| |
1.1 | 151 | |
| |
27.2 | 152 | [[image:image39.png]] |
| |
14.2 | 153 | |
| |
1.1 | 154 | **Figure 13 The Item Scheme pattern** |
| 155 | |||
| |
2.4 | 156 | === 3.5.3 Explanation of the Diagram === |
| |
1.1 | 157 | |
| |
2.4 | 158 | ==== 3.5.3.1 Narrative ==== |
| |
1.1 | 159 | |
| |
29.4 | 160 | The //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is an abstract class which defines a set of //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// (this class is also abstract). Its main purpose is to define a mechanism which can be used to create taxonomies which can classify other parts of the [[SDMX Information Model>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]]. It is derived from //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// which gives it the ability to be annotated, have identity, naming, versioning and be associated with an [[Agency>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.Agency.WebHome]]. An example of a concrete class is a [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]]. The associated Concepts are //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s. |
| |
1.1 | 161 | |
| |
29.4 | 162 | In an exchange environment an //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is allowed to contain a sub-set of the //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s in the maintained //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//. If such an [[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]] is disseminated with a sub-set of the //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s then the fact that this is a sub-set is denoted by setting the [[isPartial>>doc:IMElements.isPartial.WebHome]] [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] to "true". |
| |
1.1 | 163 | |
| |
29.4 | 164 | A “partial” //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// cannot be maintained independently in its partial form i.e., it cannot contain //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s that are not present in the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// and the content of any one //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]] //(e.g., names and descriptions) cannot deviate from the content in the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//. Furthermore, the [[id>>doc:IMElements.id.WebHome]] of the //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// where [[isPartial>>doc:IMElements.isPartial.WebHome]] is set to "true" is the same as the [[id>>doc:IMElements.id.WebHome]] of the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// (agencyId, [[id>>doc:IMElements.id.WebHome]], [[version>>doc:IMElements.version.WebHome]]). This is important as this is the [[id>>doc:IMElements.id.WebHome]] that that is referenced in other structures (e.g., a [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] referenced in a [[DSD>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]) and this [[id>>doc:IMElements.id.WebHome]] is always the same, regardless of whether the disseminated //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is the full //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// or a partial //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//. |
| |
1.1 | 165 | |
| |
29.4 | 166 | The purpose of a partial //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// is to support the exchange and dissemination of a subset //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// without the need to maintain multiple //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//s which contain the same //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s. For instance, when a [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] is used in a [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] it is sometimes the case that only a sub-set of the Codes in a [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] are relevant. In this case a partial [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] can be constructed using the [[Constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] mechanism explained later in this document. |
| |
1.1 | 167 | |
| |
29.4 | 168 | //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// inherits from //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// which gives it the ability to be annotated and have identity, and therefore has [[id>>doc:IMElements.id.WebHome]], [[uri>>doc:IMElements.uri.WebHome]] and [[urn>>doc:IMElements.urn.WebHome]] [[attributes>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]], a [[name>>doc:IMElements.name.WebHome]] and a [[description>>doc:IMElements.description.WebHome]] in the form of an [[InternationalString>>doc:IMElements.InternationalString.WebHome]]. Unlike the [[parent>>doc:IMElements.parent.WebHome]] //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//, the //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// itself is not a //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// and therefore cannot have an independent [[Agency>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.Agency.WebHome]] (i.e., it implicitly has the same agencyId as the //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//). |
| |
1.1 | 169 | |
| |
11.1 | 170 | The //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// can be hierarchic and so one //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// can have [[child>>doc:IMElements.child.WebHome]] //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//s. The restriction of the hierarchic association is that a [[child>>doc:IMElements.child.WebHome]] //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]// can have only [[parent>>doc:IMElements.parent.WebHome]] //[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//. |
| |
1.1 | 171 | |
| |
2.4 | 172 | ==== 3.5.3.2 Definitions ==== |
| |
1.1 | 173 | |
| |
2.4 | 174 | (% style="width:989.835px" %) |
| 175 | |**Class**|(% style="width:297px" %)**Feature**|(% style="width:583px" %)**Description** | ||
| |
11.1 | 176 | |//[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]//|(% style="width:297px" %)((( |
| |
1.1 | 177 | Inherits from: |
| |
11.1 | 178 | //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// |
| |
1.1 | 179 | Direct sub classes are: |
| |
11.1 | 180 | [[CategoryScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.CategoryScheme.WebHome]] |
| 181 | [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]] | ||
| |
29.5 | 182 | [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] |
| |
11.1 | 183 | [[ReportingTaxonomy>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ReportingTaxonomy.WebHome]] |
| 184 | //[[OrganisationScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.OrganisationScheme.WebHome]]// | ||
| |
1.1 | 185 | TransformationScheme |
| |
12.1 | 186 | CustomTypeScheme NamePersonalisationScheme |
| |
1.1 | 187 | RulesetScheme |
| |
2.4 | 188 | VtlMappingScheme |
| |
12.1 | 189 | UserDefinedOperatorScheme |
| |
2.4 | 190 | )))|(% style="width:583px" %)The descriptive information for an arrangement or division of objects into groups based on characteristics, which the objects have in common. |
| |
29.5 | 191 | | |(% style="width:297px" %)[[isPartial>>doc:IMElements.isPartial.WebHome]]|(% style="width:583px" %)Denotes whether the [[Item Scheme>>doc:sdmx:Glossary 2\.1.Item scheme.WebHome]] contains a subset of the full set of Items in the maintained scheme. |
| |
2.4 | 192 | | |(% style="width:297px" %)/items|(% style="width:583px" %)Association to the Items in the scheme. |
| |
11.1 | 193 | |//[[Item>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.WebHome]]//|(% style="width:297px" %)((( |
| |
1.1 | 194 | Inherits from: |
| |
11.1 | 195 | //[[NameableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.WebHome]]// |
| |
1.1 | 196 | Direct sub classes are |
| |
11.1 | 197 | [[Category>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Category.WebHome]] |
| |
27.4 | 198 | [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] |
| 199 | [[Code>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Code.WebHome]] | ||
| |
12.2 | 200 | [[ReportingCategory>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.ReportingCategory.WebHome]] |
| 201 | //[[Organisation>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.WebHome]]// | ||
| |
1.1 | 202 | Transformation |
| 203 | CustomType | ||
| 204 | NamePersonalisation | ||
| 205 | Ruleset | ||
| 206 | VtlMapping | ||
| |
12.2 | 207 | UserDefinedOperator |
| |
2.4 | 208 | )))|(% style="width:583px" %)((( |
| |
29.5 | 209 | The Item is an item of content in an [[Item Scheme>>doc:sdmx:Glossary 2\.1.Item scheme.WebHome]]. This may be a node in a taxonomy or ontology, a code in a [[code list>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] etc. Node that at the conceptual level the Organisation is not hierarchic. |
| |
1.1 | 210 | ))) |
| |
29.5 | 211 | | |(% style="width:297px" %)[[hierarchy>>doc:sdmx:Glossary 2\.1.Hierarchy.WebHome]]|(% style="width:583px" %)This allows an Item optionally to have one or more child Items |
| |
1.1 | 212 | |
| |
2.5 | 213 | == 3.6 The Structure Pattern == |
| |
1.1 | 214 | |
| |
2.5 | 215 | === 3.6.1 Context === |
| |
1.1 | 216 | |
| |
27.4 | 217 | The [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]] Pattern is a basic architectural pattern which allows the specification of complex tabular structures which are often found in statistical data (such as Data [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]] Definition, and Metadata [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]] Definition). A [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]] is a set of ordered lists. A pattern to underpin this tabular [[structure>>doc:IMElements.structure.WebHome]] has been developed, so that commonalities between these [[structure>>doc:IMElements.structure.WebHome]] definitions can be supported by common software and common syntax structures. |
| |
1.1 | 218 | |
| |
3.1 | 219 | === 3.6.2 Class Diagrams === |
| |
1.1 | 220 | |
| |
16.2 | 221 | [[image:image40.png]] |
| |
16.1 | 222 | |
| |
1.1 | 223 | **Figure 14: The Structure Pattern** |
| 224 | |||
| |
17.1 | 225 | [[image:image41.png]] |
| |
16.1 | 226 | |
| |
1.1 | 227 | **Figure 15: Representation within the Structure Pattern** |
| 228 | |||
| |
3.1 | 229 | === 3.6.3 Explanation of the Diagrams === |
| |
1.1 | 230 | |
| |
3.1 | 231 | ==== 3.6.3.1 Narrative ==== |
| |
1.1 | 232 | |
| |
11.1 | 233 | The //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// is an abstract class which contains a set of one or more //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]//(s) (this class is also abstract). An example of a concrete //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// is [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]]. |
| |
1.1 | 234 | |
| |
27.4 | 235 | The //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]// is a list of one or more //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]//(s//)//. The //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]// has several concrete descriptor classes based on it: [[DimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.DimensionDescriptor.WebHome]], [[GroupDimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.GroupDimensionDescriptor.WebHome]], [[MeasureDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MeasureDescriptor.WebHome]], and [[AttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.AttributeDescriptor.WebHome]] of the [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] and [[MetadataAttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MetadataAttributeDescriptor.WebHome]] of the [[MetadataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.MetadataStructureDefinition.WebHome]]. |
| |
1.1 | 236 | |
| |
27.4 | 237 | The //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// is contained in a //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]//. The [[type>>doc:IMElements.type.WebHome]] of //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// in a //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]// is dependent on the concrete class of the [[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]] as follows: |
| |
1.1 | 238 | |
| |
27.4 | 239 | [[DimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.DimensionDescriptor.WebHome]]: [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]], [[TimeDimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.TimeDimension.WebHome]] |
| 240 | [[GroupDimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.GroupDimensionDescriptor.WebHome]]: [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]], [[TimeDimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.TimeDimension.WebHome]] | ||
| 241 | [[MeasureDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MeasureDescriptor.WebHome]]: [[Measure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.Measure.WebHome]] | ||
| |
11.1 | 242 | [[AttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.AttributeDescriptor.WebHome]]: [[DataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.DataAttribute.WebHome]], MetadataAttributeRef |
| 243 | [[MetadataAttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MetadataAttributeDescriptor.WebHome]]: [[MetadataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.MetadataAttribute.WebHome]] | ||
| |
1.1 | 244 | |
| |
29.7 | 245 | Each //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// takes its semantic (and possibly also its representation) from a [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]] in a [[ConceptScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.ConceptScheme.WebHome]]. This is represented by the [[conceptIdentity>>doc:IMElements.conceptIdentity.WebHome]] association to [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]]. |
| |
1.1 | 246 | |
| |
29.7 | 247 | The //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// may also have a [[localRepresentation>>doc:IMElements.localRepresentation.WebHome]]. This allows a concrete class, such as [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]], to specify its representation which is local to the //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// in which it is contained (for [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]] this will be [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]]), and thus overrides any [[coreRepresentation>>doc:IMElements.coreRepresentation.WebHome]] specified for the [[Concept>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Concept.WebHome]]. |
| |
1.1 | 248 | |
| |
29.7 | 249 | The [[Representation>>doc:IMElements.Representation.WebHome]] can be [[enumerated>>doc:IMElements.enumerated.WebHome]] or non-[[enumerated>>doc:IMElements.enumerated.WebHome]]. The valid content of an [[enumerated>>doc:IMElements.enumerated.WebHome]] representation is specified either in an //[[ItemScheme>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.WebHome]]// which can be one of [[Codelist>>doc:sdmx:Glossary 2\.1.Code list.WebHome]], [[ValueList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.EnumeratedList.ValueList.WebHome]] or //[[GeoCodelist>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.ItemScheme.Codelist.GeoCodelist.WebHome]]//. The valid content of a non-[[enumerated>>doc:IMElements.enumerated.WebHome]] representation is specified as one or more Facet(s) (for example, these may specify minimum and maximum values). For any [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] this is achieved by one of more |
| |
1.1 | 250 | |
| |
29.7 | 251 | ExtendedFacet(s), which allow the additional representation of XHTML. |
| |
1.1 | 252 | |
| |
29.7 | 253 | The types of representation that are valid for specific [[components>>doc:IMElements.components.WebHome]] is expressed in the model as a [[constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] on the association: |
| |
1.1 | 254 | |
| |
27.4 | 255 | * The [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]], [[DataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.DataAttribute.WebHome]], [[Measure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.Measure.WebHome]], [[MetadataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.MetadataAttribute.WebHome]] may be [[enumerated>>doc:IMElements.enumerated.WebHome]] and, if so, use an //[[EnumeratedList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.EnumeratedList.WebHome]]//. |
| |
29.7 | 256 | * The [[Dimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.Dimension.WebHome]] and [[Measure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.Measure.WebHome]] may be non-[[enumerated>>doc:IMElements.enumerated.WebHome]] and, if so, use one or more Facet(s), note that the FacetValueType applicable to the [[TimeDimension>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.TimeDimension.WebHome]] is restricted to those that represent time. |
| 257 | * The [[MetadataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.MetadataAttribute.WebHome]] and [[DataAttribute>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.DataAttribute.WebHome]] may be non-[[enumerated>>doc:IMElements.enumerated.WebHome]] and, if so, use one or more ExtendedFacet(s). | ||
| |
1.1 | 258 | |
| |
27.4 | 259 | The //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]// may be used by one or more //[[StructureUsage>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.WebHome]]//(s). An example of this, in terms of concrete classes, is that a [[Dataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Dataflow.WebHome]] (sub class of //[[StructureUsage>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.WebHome]]//) may use a particular [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] (sub class of //[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]//), and similar constructs apply for the [[Metadataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Metadataflow.WebHome]] (link to [[MetadataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.MetadataStructureDefinition.WebHome]]). |
| |
1.1 | 260 | |
| |
3.1 | 261 | ==== 3.6.3.2 Definitions ==== |
| |
1.1 | 262 | |
| |
13.1 | 263 | (% style="width:1368.29px" %) |
| 264 | |**Class**|**Feature**|(% style="width:897px" %)**Description** | ||
| |
11.1 | 265 | |[[StructureUsage>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.WebHome]]|((( |
| |
1.1 | 266 | Inherits from: |
| |
11.1 | 267 | //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// |
| |
1.1 | 268 | Sub classes are: |
| |
27.4 | 269 | [[Dataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Dataflow.WebHome]] |
| 270 | [[Metadataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Metadataflow.WebHome]] | ||
| |
29.8 | 271 | )))|(% style="width:897px" %)An [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] whose components are described by a Structure. In concrete terms (sub-classes) an example would be a Dataflow which is linked to a given structure – in this case the [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. |
| 272 | | |[[structure>>doc:IMElements.structure.WebHome]]|(% style="width:897px" %)An association to a Structure specifying the structure of the [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. | ||
| |
11.1 | 273 | |[[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]]|((( |
| |
1.1 | 274 | Inherits from: |
| |
11.1 | 275 | //[[MaintainableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.WebHome]]// |
| |
1.1 | 276 | Sub classes are: |
| |
27.4 | 277 | [[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] [[MetadataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.MetadataStructureDefinition.WebHome]] |
| |
29.8 | 278 | )))|(% style="width:897px" %)Abstract specification of a list of lists to define a complex tabular structure. A concrete example of this would be statistical concepts, [[code lists>>doc:sdmx:Glossary 2\.1.Code list.WebHome]], and their organisation in a data or [[metadata structure definition>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]], defined by a centre institution, usually for the exchange of statistical information with its partners. |
| |
27.4 | 279 | | |[[grouping>>doc:IMElements.grouping.WebHome]]|(% style="width:897px" %)A composite association to one or more component lists. |
| |
11.1 | 280 | |//[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]//|((( |
| |
1.1 | 281 | Inherits from: |
| |
11.1 | 282 | //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// |
| |
1.1 | 283 | Sub classes are: |
| |
11.1 | 284 | [[DimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.DimensionDescriptor.WebHome]] |
| 285 | [[GroupDimensionDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.GroupDimensionDescriptor.WebHome]] | ||
| 286 | [[MeasureDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MeasureDescriptor.WebHome]] | ||
| |
27.4 | 287 | [[AttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.AttributeDescriptor.WebHome]] [[MetadataAttributeDescriptor>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.MetadataAttributeDescriptor.WebHome]] |
| |
29.8 | 288 | )))|(% style="width:897px" %)An abstract definition of a list of components. A concrete example is a Dimension Descriptor, which defines the list of Dimensions in a [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]. |
| 289 | | |[[components>>doc:IMElements.components.WebHome]]|(% style="width:897px" %)An aggregate association to one or more components which make up the list. | ||
| |
27.4 | 290 | |//[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]//|((( |
| |
1.1 | 291 | Inherits from: |
| |
11.1 | 292 | //[[IdentifiableArtefact>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.WebHome]]// |
| |
1.1 | 293 | Sub classes are: |
| |
27.4 | 294 | [[Measure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.Measure.WebHome]] |
| |
11.1 | 295 | //[[AttributeComponent>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.AttributeComponent.WebHome]] |
| 296 | [[DimensionComponent>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.DimensionComponent.WebHome]]// | ||
| |
27.4 | 297 | )))|(% style="width:897px" %)A Component is an abstract super class used to define qualitative and quantitative data and metadata items that belong to a Component List and hence a Structure. Component is refined through its sub-classes. |
| |
29.8 | 298 | | |[[conceptIdentity>>doc:IMElements.conceptIdentity.WebHome]]|(% style="width:897px" %)Association to a Concept in a [[Concept Scheme>>doc:sdmx:Glossary 2\.1.Concept scheme.WebHome]] that identifies and defines the semantic of the Component. |
| 299 | | |[[localRepresentation>>doc:IMElements.localRepresentation.WebHome]]|(% style="width:897px" %)((( | ||
| |
27.4 | 300 | Association to the Representation of the Component if this is different from the coreRepresentation of the Concept, which the Component uses (ConceptUsage). |
| |
1.1 | 301 | ))) |
| |
27.4 | 302 | |[[Representation>>doc:IMElements.Representation.WebHome]]| |(% style="width:897px" %)The allowable value or format for Component or Concept |
| |
29.8 | 303 | | |+[[enumerated>>doc:IMElements.enumerated.WebHome]]|(% style="width:897px" %)Association to an enumerated list that contains the allowable content for the Component when reported in a data or [[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]]. The type of enumerated list that is allowed for any concrete Component is shown in the [[constraints>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] on the association. |
| 304 | | |+[[nonEnumerated>>doc:IMElements.nonEnumerated.WebHome]]|(% style="width:897px" %)Association to a set of Facets that define the allowable format for the content of the Component when reported in a data or [[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]]. | ||
| 305 | |[[Facet>>doc:IMElements.Facet.WebHome]]| |(% style="width:897px" %)Defines the format for the content of the Component when reported in a data or [[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]]. | ||
| |
27.4 | 306 | | |[[facetType>>doc:IMElements.facetType.WebHome]]|(% style="width:897px" %)A specific content type, which is constrained by the Facet Type enumeration. |
| |
29.8 | 307 | | |[[facetValueType>>doc:IMElements.facetValueType.WebHome]]|(% style="width:897px" %)The format of the value of a Component when reported in a data or [[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]]. This is constrained by the Facet Value Type enumeration. |
| 308 | | |+itemSchemeFacet|(% style="width:897px" %)Defines the format of the identifiers in an [[Item Scheme>>doc:sdmx:Glossary 2\.1.Item scheme.WebHome]] used by a Component. Typically, this would define the number of characters (length) of the identifier. | ||
| 309 | |[[ExtendedFacet>>doc:IMElements.ExtendedFacet.WebHome]]| |(% style="width:897px" %)This has the same function as Facet but allows additionally an XHTML representation. This is constrained for use with a Metadata [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] and a Data [[Attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]]. | ||
| |
1.1 | 310 | |
| |
27.4 | 311 | The specification of the content and use of the sub classes to //[[ComponentList>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.ComponentList.WebHome]]// and //[[Component>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.Component.WebHome]]// can be found in the section in which they are used ([[DataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.DataStructureDefinition.WebHome]] and [[MetadataStructureDefinition>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.MetadataStructureDefinition.WebHome]]). Moreover, the FacetType SentinelValues is explained in the datastructure representation diagram (see 5.3.2.2), since it only concerns DataStructureDefinitions. |
| |
1.1 | 312 | |
| |
3.1 | 313 | ==== 3.6.3.3 Representation Constructs ==== |
| |
1.1 | 314 | |
| |
29.9 | 315 | The majority of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] FacetValueTypes are compatible with those found in XML Schema, and have equivalents in most current implementation platforms: |
| |
1.1 | 316 | |
| |
4.1 | 317 | |(% style="width:198px" %)((( |
| |
3.1 | 318 | **SDMX Facet Value Type** |
| |
4.1 | 319 | )))|(% style="width:204px" %)**XML Schema Data Type**|(% style="width:209px" %)**JSON Schema Data Type**|(% style="width:187px" %)((( |
| |
3.1 | 320 | **.NET Framework Type** |
| |
4.1 | 321 | )))|(% style="width:817px" %)**Java Data Type** |
| 322 | |(% style="width:198px" %)String|(% style="width:204px" %)xsd:string|(% style="width:209px" %)string|(% style="width:187px" %)System.String|(% style="width:817px" %)java.lang.String | ||
| 323 | |(% style="width:198px" %)Big Integer|(% style="width:204px" %)xsd:integer|(% style="width:209px" %)integer|(% style="width:187px" %)System.Decimal|(% style="width:817px" %)java.math.BigInteger | ||
| 324 | |(% style="width:198px" %)Integer|(% style="width:204px" %)xsd:int|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int32|(% style="width:817px" %)int | ||
| 325 | |(% style="width:198px" %)Long|(% style="width:204px" %)xsd.long|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int64|(% style="width:817px" %)long | ||
| 326 | |(% style="width:198px" %)Short|(% style="width:204px" %)xsd:short|(% style="width:209px" %)integer|(% style="width:187px" %)System.Int16|(% style="width:817px" %)short | ||
| |
32.1 | 327 | |(% style="width:198px" %)[[Decimal>>doc:sdmx:Glossary 2\.1.Decimals.WebHome]]|(% style="width:204px" %)xsd:decimal|(% style="width:209px" %)number|(% style="width:187px" %)System.Decimal|(% style="width:817px" %)java.math.BigDecimal |
| |
4.1 | 328 | |(% style="width:198px" %)Float|(% style="width:204px" %)xsd:float|(% style="width:209px" %)number|(% style="width:187px" %)System.Single|(% style="width:817px" %)float |
| 329 | |(% style="width:198px" %)Double|(% style="width:204px" %)xsd:double|(% style="width:209px" %)number|(% style="width:187px" %)System.Double|(% style="width:817px" %)double | ||
| 330 | |(% style="width:198px" %)Boolean|(% style="width:204px" %)xsd:boolean|(% style="width:209px" %)boolean|(% style="width:187px" %)System.Boolean|(% style="width:817px" %)boolean | ||
| |
35.1 | 331 | |(% style="width:198px" %)URI|(% style="width:204px" %)xsd:anyURI|(% style="width:209px" %)string:[[uri>>doc:IMElements.uri.WebHome]]|(% style="width:187px" %)System.Uri|(% style="width:817px" %)Java.net.URI or java.lang.String |
| |
4.1 | 332 | |(% style="width:198px" %)DateTime|(% style="width:204px" %)xsd:dateTime|(% style="width:209px" %)string:datetime|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar |
| 333 | |(% style="width:198px" %)Time|(% style="width:204px" %)xsd:time|(% style="width:209px" %)string:time|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar | ||
| |
5.1 | 334 | |(% style="width:198px" %)GregorianYear|(% style="width:204px" %)xsd:gYear|(% style="width:209px" %)string{{footnote}}In the JSON schemas, more complex data types are complemented with regular expressions, whenever no direct mapping to a standard type exists.{{/footnote}}|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar |
| |
4.1 | 335 | |(% style="width:198px" %)GregorianMonth|(% style="width:204px" %)xsd:gYearMonth|(% style="width:209px" %)string|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar |
| 336 | |(% style="width:198px" %)GregorianDay|(% style="width:204px" %)xsd:date|(% style="width:209px" %)string|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar | ||
| 337 | |(% style="width:198px" %)Day, MonthDay, Month|(% style="width:204px" %)xsd:g*|(% style="width:209px" %)string|(% style="width:187px" %)System.DateTime|(% style="width:817px" %)javax.xml.datatype.XML GregorianCalendar | ||
| 338 | |(% style="width:198px" %)Duration|(% style="width:204px" %)xsd:duration|(% style="width:209px" %)string|(% style="width:187px" %)System.TimeSpan|(% style="width:817px" %)javax.xml.datatype.Dur ation | ||
| |
1.1 | 339 | |
| |
29.9 | 340 | There are also a number of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data [[type>>doc:IMElements.type.WebHome]]. These are detailed in Section 6 of the standards. |
| |
1.1 | 341 | |
| |
29.9 | 342 | The [[Representation>>doc:IMElements.Representation.WebHome]] is composed of Facets, each of which conveys characteristic information related to the definition of a [[value>>doc:IMElements.value.WebHome]] domain. Often a set of Facets are needed to convey the required semantic. For example, a [[sequence>>doc:IMElements.sequence.WebHome]] is defined by a minimum of two Facets: one to define the start [[value>>doc:IMElements.value.WebHome]], and one to define the interval. |
| |
1.1 | 343 | |
| |
3.1 | 344 | (% style="width:981.835px" %) |
| 345 | |(% style="width:107px" %)**Facet Type**|(% style="width:872px" %)**Explanation** | ||
| |
29.9 | 346 | |(% style="width:107px" %)isSequence|(% style="width:872px" %)The isSequence facet indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue,and endValue facet or the timeInterval, [[startTime>>doc:IMElements.startTime.WebHome]], and endTime, facets. If this [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] holds a [[value>>doc:IMElements.value.WebHome]] of true, a start [[value>>doc:IMElements.value.WebHome]] or time and a numeric or time interval must be supplied. If an end [[value>>doc:IMElements.value.WebHome]] is not given, then the [[sequence>>doc:IMElements.sequence.WebHome]] continues indefinitely. |
| 347 | |(% style="width:107px" %)interval|(% style="width:872px" %)The interval [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] specifies the permitted interval (increment) in a [[sequence>>doc:IMElements.sequence.WebHome]]. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] must have a [[value>>doc:IMElements.value.WebHome]] of true. | ||
| 348 | |(% style="width:107px" %)startValue|(% style="width:872px" %)The startValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet isused for a numeric [[sequence>>doc:IMElements.sequence.WebHome]] and indicates the starting point of the [[sequence>>doc:IMElements.sequence.WebHome]]. This [[value>>doc:IMElements.value.WebHome]] is mandatory for a numeric [[sequence>>doc:IMElements.sequence.WebHome]] to be expressed. | ||
| |
27.4 | 349 | |(% style="width:107px" %)endValue|(% style="width:872px" %)The endValue facet is used in conjunction with the isSequence and interval facets (which must be set in order to use this facet). This facet is used for a numeric [[sequence>>doc:IMElements.sequence.WebHome]] and indicates that ending point (if any) of the [[sequence>>doc:IMElements.sequence.WebHome]]. |
| |
29.9 | 350 | |(% style="width:107px" %)timeInterval|(% style="width:872px" %)The timeInterval facet indicates the permitted duration in a time [[sequence>>doc:IMElements.sequence.WebHome]]. In order for this to be used, the isSequence facet must have a [[value>>doc:IMElements.value.WebHome]] of true. |
| 351 | |(% style="width:107px" %)[[startTime>>doc:IMElements.startTime.WebHome]]|(% style="width:872px" %)The [[startTime>>doc:IMElements.startTime.WebHome]] facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). Thisnattribute is used for a time [[sequence>>doc:IMElements.sequence.WebHome]] and indicates the start time of thensequence. This [[value>>doc:IMElements.value.WebHome]] is mandatory for a time [[sequence>>doc:IMElements.sequence.WebHome]] to be expressed. | ||
| |
27.4 | 352 | |(% style="width:107px" %)endTime|(% style="width:872px" %)The endTime facet is used in conjunction with the isSequence and timeInterval facets (which must be set in order to use this facet). This facet is used for a time [[sequence>>doc:IMElements.sequence.WebHome]] and indicates that ending point (if any) ofnthe [[sequence>>doc:IMElements.sequence.WebHome]]. |
| |
29.9 | 353 | |(% style="width:107px" %)minLength|(% style="width:872px" %)The minLength facet specifies the minimum and length of the [[value>>doc:IMElements.value.WebHome]] in characters. |
| 354 | |(% style="width:107px" %)maxLength|(% style="width:872px" %)The maxLength facet specifies the maximum length of the [[value>>doc:IMElements.value.WebHome]] in characters. | ||
| 355 | |(% style="width:107px" %)minValue|(% style="width:872px" %)The minValue facet is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid [[value>>doc:IMElements.value.WebHome]] will be greater than or equal to the [[value>>doc:IMElements.value.WebHome]] specified here. If the inclusive and exclusive data [[type>>doc:IMElements.type.WebHome]] is not specified (e.g., this facet is used with an integer data [[type>>doc:IMElements.type.WebHome]]), the [[value>>doc:IMElements.value.WebHome]] is assumed to be inclusive. | ||
| 356 | |(% style="width:107px" %)maxValue|(% style="width:872px" %)The maxValue facet is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid [[value>>doc:IMElements.value.WebHome]] will be less than or equal to the [[value>>doc:IMElements.value.WebHome]] specified here. If the inclusive and exclusive data [[type>>doc:IMElements.type.WebHome]] is not specified (e.g., this facet is used with an integer data [[type>>doc:IMElements.type.WebHome]]), the [[value>>doc:IMElements.value.WebHome]] is assumed to be inclusive. | ||
| 357 | |(% style="width:107px" %)[[Decimals>>doc:sdmx:Glossary 2\.1.Decimals.WebHome]]|(% style="width:872px" %)The [[decimals>>doc:sdmx:Glossary 2\.1.Decimals.WebHome]] facet indicates the number of characters allowed after the [[decimal>>doc:sdmx:Glossary 2\.1.Decimals.WebHome]] separator. | ||
| 358 | |(% style="width:107px" %)pattern|(% style="width:872px" %)The pattern [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] holds any regular expression permitted in the implementation syntax (e.g., W3C XML Schema). | ||
| |
1.1 | 359 | |
| 360 | ---- | ||
| 361 | |||
| |
5.1 | 362 | {{putFootnotes/}} |