Wiki source code of Part III. Structure
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | = 1 Introduction = | ||
| 6 | |||
| 7 | The structure namespace contains the definition of all [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] constructs. These constructs are intended to be very tightly coupled with the information model to ease the burden of implementers on translating the information from the XML messages into objects based on the information model. | ||
| 8 | |||
| 9 | The conformance with the information was achieved through derivation by extensions, restrictions, and substitutions. Because of some the limitations of XML Schema in these areas, it was often necessary to create intermediate type which formed the basis of the final types which make up the information that is actually exchanged in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] messages. The intermediate types are all abstract, so they are not explicitly used in a message. They do however serve the purpose of creating a strong relation of the schemas to the information model. | ||
| 10 | |||
| 11 | = 2 Schema Documentation = | ||
| 12 | |||
| 13 | == 2.1 Structure Namespace == | ||
| 14 | |||
| 15 | http://www.sdmx.org/resources/sdmxml/schemas/v3_1/structure | ||
| 16 | |||
| 17 | === 2.1.1 Summary === | ||
| 18 | |||
| 19 | Referenced Namespaces: | ||
| 20 | |||
| 21 | (% style="width:1042.29px" %) | ||
| 22 | |(% style="width:559px" %) **Namespace**|(% style="width:481px" %) **Prefix** | ||
| 23 | |(% style="width:559px" %) http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|(% style="width:481px" %) common | ||
| 24 | |(% style="width:559px" %) http://www.w3.org/2001/XMLSchema|(% style="width:481px" %) xs | ||
| 25 | |||
| 26 | Contents: | ||
| 27 | 38 Global Elements | ||
| 28 | 235 Complex Types | ||
| 29 | 19 Simple Types | ||
| 30 | |||
| 31 | === 2.1.2 Global Elements === | ||
| 32 | |||
| 33 | **Structures (StructuresType):** Structures contains constructs for all [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 34 | |||
| 35 | **//Item (ItemType)//:** Item is an abstract element that serves as a substitution head for all items in an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType. | ||
| 36 | |||
| 37 | Substitutions: [[Category>>doc:sdmx:Glossary.Category.WebHome]], [[Code>>doc:sdmx:Glossary.Code.WebHome]], *GeoRefCode*, GeoFeatureSetCode, GeoGridCode, (% style="color:#e74c3c" %)Concept(%%), *Organisation*, Agency, DataConsumer, DataProvider, MetadataProvider, OrganisationUnit, ReportingCategory, Transformation, VtlMapping, NamePersonalisation, Ruleset, UserDefinedOperator, CustomType | ||
| 38 | |||
| 39 | **Grouping (GroupingType):** Grouping is an abstract element that serves as a substitution head for all structure groupings. Groupings contain a collection of [[component>>doc:sdmx:Glossary.Component.WebHome]] lists for a structure. Concrete instances of this must use a concrete instance of GroupingType. | ||
| 40 | |||
| 41 | Substitutions: DataStructureComponents, MetadataStructureComponents | ||
| 42 | |||
| 43 | **ComponentList (ComponentListType):** ComponentList is an abstract element that serves as a substitution head for all [[component>>doc:sdmx:Glossary.Component.WebHome]] lists. Concrete instances of this must use a concrete instance of ComponentListType. | ||
| 44 | |||
| 45 | Substitutions: AttributeList, DimensionList, Group, MeasureList, MetadataAttributeList | ||
| 46 | |||
| 47 | **[[Component>>doc:sdmx:Glossary.Component.WebHome]] (ComponentType):** [[Component>>doc:sdmx:Glossary.Component.WebHome]] is an abstract element that serves as a substitution head for all [[components>>doc:sdmx:Glossary.Component.WebHome]]. Concrete instances of this must use a concrete instance of ComponentType. | ||
| 48 | |||
| 49 | Substitutions: [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]], MetadataAttributeUsage, [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], TimeDimension, GroupDimension, [[Measure>>doc:sdmx:Glossary.Measure.WebHome]], MetadataAttribute | ||
| 50 | |||
| 51 | **[[Category>>doc:sdmx:Glossary.Category.WebHome]] (CategoryType):** [[Category>>doc:sdmx:Glossary.Category.WebHome]] represents a set of nested [[categories>>doc:sdmx:Glossary.Category.WebHome]] which describe a simple classification [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. | ||
| 52 | |||
| 53 | Substitution For: Item | ||
| 54 | |||
| 55 | **[[Code>>doc:sdmx:Glossary.Code.WebHome]] (CodeType):** [[Code>>doc:sdmx:Glossary.Code.WebHome]] describes a [[code>>doc:sdmx:Glossary.Code.WebHome]] in a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. In addition to the identification and description of the [[code>>doc:sdmx:Glossary.Code.WebHome]], basic presentational information is also available. Presentational information not present may be added through the use of annotations. | ||
| 56 | |||
| 57 | Substitution For: Item | ||
| 58 | |||
| 59 | Substitutions: GeoRefCode, GeoFeatureSetCode, GeoGridCode | ||
| 60 | |||
| 61 | ***GeoRefCode* (*GeoRefCodeType*):** GeoRefCode is the abstract base from which specific types of geographic [[codes>>doc:sdmx:Glossary.Code.WebHome]] will be derived. | ||
| 62 | |||
| 63 | Substitution For: Code | ||
| 64 | |||
| 65 | Substitutions: GeoFeatureSetCode, GeoGridCode | ||
| 66 | |||
| 67 | **GeoFeatureSetCode (GeoFeatureSetCodeType):** Is a geographic [[code>>doc:sdmx:Glossary.Code.WebHome]] in a geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. It adds a value to a [[code>>doc:sdmx:Glossary.Code.WebHome]] that folows a pattern to represent a geo feature set. | ||
| 68 | |||
| 69 | Substitution For: GeoRefCode | ||
| 70 | |||
| 71 | **GeoGridCode (GeoGridCodeType):** GeoGridCode is a [[code>>doc:sdmx:Glossary.Code.WebHome]] the represents a geographic grid cell that belongs to a specific grid definition. | ||
| 72 | |||
| 73 | Substitution For: GeoRefCode | ||
| 74 | |||
| 75 | (% style="color:#e74c3c" %)**Concept**(%%)** (ConceptType):** (% style="color:#e74c3c" %)Concept(%%) describes the details of a (% style="color:#e74c3c" %)concept(%%) within a (% style="color:#e74c3c" %)concept(%%) scheme. | ||
| 76 | |||
| 77 | Substitution For: Item | ||
| 78 | |||
| 79 | **DataStructureComponents (DataStructureComponentsType):** DataStructureComponents defines the grouping of the sets of metadata (% style="color:#e74c3c" %)concepts(%%) that have a defined structural role in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Note that for any [[component>>doc:sdmx:Glossary.Component.WebHome]] or group defined in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], its id must be unique. This applies to the identifiers explicitly defined by the [[components>>doc:sdmx:Glossary.Component.WebHome]] as well as those inherited from the (% style="color:#e74c3c" %)concept(%%) identity of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. For example, if two [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] take their identity from (% style="color:#e74c3c" %)concepts(%%) with same identity (regardless of whether the (% style="color:#e74c3c" %)concepts(%%) exist in different schemes) one of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] must be provided a different explicit identifier. Although there are XML schema (% style="color:#e74c3c" %)constraints(%%) to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a (% style="color:#e74c3c" %)concept(%%) from which a [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its identity cannot be validated against this (% style="color:#e74c3c" %)constraint(%%). Therefore, systems processing [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]] will have to perform this check outside of the XML validation. There are also two reserved identifiers in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]; TIME\_PERIOD, and REPORTING\_YEAR\_START\_DAY. These identifiers may not be used outside of their respective defintions (TimeDimension and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the [[components>>doc:sdmx:Glossary.Component.WebHome]] or groups as well as an identifier inherited by a [[component>>doc:sdmx:Glossary.Component.WebHome]] from its (% style="color:#e74c3c" %)concept(%%) identity. For example, if an ordinary [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (i.e. not the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]) takes its (% style="color:#e74c3c" %)concept(%%) identity from a (% style="color:#e74c3c" %)concept(%%) with the identifier TIME\_PERIOD, that [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] must provide a different explicit identifier. | ||
| 80 | |||
| 81 | Substitution For: Grouping | ||
| 82 | |||
| 83 | **AttributeList (AttributeListType):** AttributeList describes the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] descriptor for the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. It is a collection of metadata (% style="color:#e74c3c" %)concepts(%%) that define the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] of the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 84 | |||
| 85 | Substitution For: ComponentList | ||
| 86 | |||
| 87 | **[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] (AttributeType):** [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] describes the definition of a data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], which is defined as a characteristic of an object or entity. | ||
| 88 | |||
| 89 | Substitution For: [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 90 | |||
| 91 | **MetadataAttributeUsage (MetadataAttributeUsageType):** MetadataAttributeUsage refines the details of how a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] from the metadata structure referenced from the data structure is used. By default, metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be expressed at any (% style="color:#e74c3c" %)level(%%) of the data. This allows an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] to be defined in order restrict the reporing of a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to a specific part of the data. | ||
| 92 | |||
| 93 | Substitution For: [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 94 | |||
| 95 | **DimensionList (DimensionListType):** DimensionList describes the key descriptor for the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. It is an ordered set of metadata (% style="color:#e74c3c" %)concepts(%%) that, combined, classify a statistical series, such as a time series, and whose values, when combined (the key) in an instance such as a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], uniquely identify a specific series. | ||
| 96 | |||
| 97 | Substitution For: ComponentList | ||
| 98 | |||
| 99 | **[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (DimensionType):** [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] describes the structure of a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], which is defined as a statistical (% style="color:#e74c3c" %)concept(%%) used (most probably together with other statistical (% style="color:#e74c3c" %)concepts(%%)) to identify a statistical series, such as a time series, e.g. a statistical (% style="color:#e74c3c" %)concept(%%) indicating certain [[economic activity>>doc:sdmx:Glossary.Economic activity.WebHome]] or a geographical reference area. | ||
| 100 | |||
| 101 | Substitution For: [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 102 | |||
| 103 | **TimeDimension (TimeDimensionType):** TimeDimension is a special [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which designates the period in time in which the data identified by the full [[series key>>doc:sdmx:Glossary.Series key.WebHome]] applies. | ||
| 104 | |||
| 105 | Substitution For: [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 106 | |||
| 107 | **Group (GroupType):** Group describes a group descriptor in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. It is a set metadata (% style="color:#e74c3c" %)concepts(%%) (and possibly their values) that define a partial key derived from the key descriptor in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 108 | |||
| 109 | Substitution For: ComponentList | ||
| 110 | |||
| 111 | **GroupDimension (GroupDimensionType):** GroupDimension is a [[component>>doc:sdmx:Glossary.Component.WebHome]] which contains only a reference to a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the key descriptor (DimensionList). Although it is conventional to declare [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] in the same order as they are declared in the ordered key, there is no requirement to do so - the ordering of the values of the key are taken from the order in which the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] are declared. Note that the id of a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] may be inherited from its underlying (% style="color:#e74c3c" %)concept(%%) - therefore this reference value may actually be the id of the (% style="color:#e74c3c" %)concept(%%). | ||
| 112 | |||
| 113 | Substitution For: [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 114 | |||
| 115 | **MeasureList (MeasureListType):** MeasureList describes the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] descriptor for a data structure. | ||
| 116 | |||
| 117 | Substitution For: ComponentList | ||
| 118 | |||
| 119 | **[[Measure>>doc:sdmx:Glossary.Measure.WebHome]] (MeasureType):** [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] defines the structure of a [[measure>>doc:sdmx:Glossary.Measure.WebHome]], which is the (% style="color:#e74c3c" %)concept(%%) that is the value of the phenomenon to be measured in a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 120 | |||
| 121 | Substitution For: [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 122 | |||
| 123 | **MetadataStructureComponents (MetadataStructureComponentsType):** MetadataStructureComponents defines the grouping of the sets of the [[components>>doc:sdmx:Glossary.Component.WebHome]] that make up the metadata structure definition. | ||
| 124 | |||
| 125 | Substitution For: Grouping | ||
| 126 | |||
| 127 | **MetadataAttributeList (MetadataAttributeListType):** MetadataAttributeList defines the set of metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that can be defined as a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], for reporting [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] about a target object. The identification of metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] must be unique at any given (% style="color:#e74c3c" %)level(%%) of the metadata structure. Although there are XML schema (% style="color:#e74c3c" %)constraints(%%) to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a (% style="color:#e74c3c" %)concept(%%) from which a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] takes its identity cannot be validated against this (% style="color:#e74c3c" %)constraint(%%). Therefore, systems processing [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] will have to perform this check outside of the XML validation. | ||
| 128 | |||
| 129 | Substitution For: ComponentList | ||
| 130 | |||
| 131 | **MetadataAttribute (MetadataAttributeType):** MetadataAttribute defines the a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], which is the value of an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], such as the instance of a coded or uncoded [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in a metadata structure definition. | ||
| 132 | |||
| 133 | Substitution For: [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 134 | |||
| 135 | ***Organisation* (*OrganisationType*):** Organisation is an abstract substitution head for a generic organisation. | ||
| 136 | |||
| 137 | Substitution For: Item | ||
| 138 | |||
| 139 | Substitutions: Agency, DataConsumer, DataProvider, MetadataProvider, OrganisationUnit | ||
| 140 | |||
| 141 | **Agency (AgencyType):** Agency is an organisation which maintains [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] such as classifications, (% style="color:#e74c3c" %)concepts(%%), data structures, and metadata structures. | ||
| 142 | |||
| 143 | Substitution For: Organisation | ||
| 144 | |||
| 145 | **DataConsumer (DataConsumerType):** DataConsumer describes an organisation using data as input for further processing. | ||
| 146 | |||
| 147 | Substitution For: Organisation | ||
| 148 | |||
| 149 | **DataProvider (DataProviderType):** DataProvider describes an organisation that produces data. | ||
| 150 | |||
| 151 | Substitution For: Organisation | ||
| 152 | |||
| 153 | **MetadataProvider (MetadataProviderType):** MetadataProvider describes an organisation that produces metadata . | ||
| 154 | |||
| 155 | Substitution For: Organisation | ||
| 156 | |||
| 157 | **OrganisationUnit (OrganisationUnitType):** OrganisationUnit describes a generic organisation, which serves not predefined role in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. | ||
| 158 | |||
| 159 | Substitution For: Organisation | ||
| 160 | |||
| 161 | **ReportingCategory (ReportingCategoryType):** ReportingCateogry defines a reporting [[category>>doc:sdmx:Glossary.Category.WebHome]], which is used to group structure usages into useful sub-packages. | ||
| 162 | |||
| 163 | Substitution For: Item | ||
| 164 | |||
| 165 | **Transformation (TransformationType):** Transformation describes the details of a single transformation within a transformation scheme. | ||
| 166 | |||
| 167 | Substitution For: Item | ||
| 168 | |||
| 169 | **VtlMapping (VtlMappingType):** VtlMapping details a mapping between [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] and [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] transformation. | ||
| 170 | |||
| 171 | Substitution For: Item | ||
| 172 | |||
| 173 | **NamePersonalisation (NamePersonalisationType):** NamePersonalisation details a name personalisation that is used in a transformation. | ||
| 174 | |||
| 175 | Substitution For: Item | ||
| 176 | |||
| 177 | **Ruleset (RulesetType):** Ruleset details a ruleset within a ruleset scheme. | ||
| 178 | |||
| 179 | Substitution For: Item | ||
| 180 | |||
| 181 | **UserDefinedOperator (UserDefinedOperatorType):** UserDefinedOperator details a user defined operators within a user defined operator scheme. | ||
| 182 | |||
| 183 | Substitution For: Item | ||
| 184 | |||
| 185 | **CustomType (CustomTypeType):** CustomType details a custom type within a custom type scheme. | ||
| 186 | |||
| 187 | Substitution For: Item | ||
| 188 | |||
| 189 | === 2.1.3 Complex Types === | ||
| 190 | |||
| 191 | **StructuresType:** StructuresType describes the structure of the container for all [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]]. The structural [[components>>doc:sdmx:Glossary.Component.WebHome]] may be explicitly detailed, or referenced from an external structure document or registry service. Best practices dictate that, at a minimum, any structural [[component>>doc:sdmx:Glossary.Component.WebHome]] that is referenced by another structural [[component>>doc:sdmx:Glossary.Component.WebHome]] be included by reference. | ||
| 192 | |||
| 193 | Content: | ||
| 194 | ALL(AgencySchemesCategorisationsCategorySchemeMapsCategorySchemesCodelistsConceptSchemeMapsConceptSchemesCustomTypeSchemesDataConstraintsDataConsumerSchemesDataflowsDataProviderSchemesDataStructuresGeographicCodelistsGeoGridCodelistsHierarchiesHierarchyAssociationsMetadataConstraintsMetadataflowsMetadataProviderSchemesMetadataProvisionAgreementsMetadataStructuresNamePersonalisationSchemesOrganisationSchemeMapsOrganisationUnitSchemesProcessesProvisionAgreementsReportingTaxonomiesReportingTaxonomyMapsRepresentationMapsRulesetSchemesStructureMapsTransformationSchemesUserDefinedOperatorSchemesValueListsVtlMappingSchemes) | ||
| 195 | |||
| 196 | Element Documentation: | ||
| 197 | |||
| 198 | |**Name**|**Type**|**Documentation** | ||
| 199 | |AgencySchemes|AgencySchemesType|AgencySchemes contains a collection of [[agency scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] descriptions. The [[agency schemes>>doc:sdmx:Glossary.Agency scheme.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 200 | |Categorisations|CategorisationsType|Categorisations contains a collection of structural object categorisations. This container may contain categorisations for many types of objects. The categorisations may be detailed in full, or referenced from an external structure document or registry service. | ||
| 201 | |CategorySchemeMaps|CategorySchemeMapsType|CategorySchemeMaps contains a collection of [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) descriptions. The [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] (% style="color:#e74c3c" %)maps(%%) may be detailed in full, or referenced from an external structure document or registry service. | ||
| 202 | |CategorySchemes|CategorySchemesType|CategorySchemes contains a collection of [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] descriptions. The [[category schemes>>doc:sdmx:Glossary.Category scheme.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 203 | |[[Codelists>>doc:sdmx:Glossary.Code list.WebHome]]|CodelistsType|[[Codelists>>doc:sdmx:Glossary.Code list.WebHome]] contains a collection of [[code list>>doc:sdmx:Glossary.Code list.WebHome]] descriptions. The [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 204 | |ConceptSchemeMaps|ConceptSchemeMapsType|ConceptSchemeMaps contains a collection of [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) descriptions. The [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] (% style="color:#e74c3c" %)maps(%%) may be detailed in full, or referenced from an external structure document or registry service. | ||
| 205 | |ConceptSchemes|ConceptSchemesType|ConceptSchemes contains a collection of [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] descriptions. The [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]] described are contained within schemes. The (% style="color:#e74c3c" %)concepts(%%) may be detailed in full, or referenced from an external structure document or registry service. | ||
| 206 | |CustomTypeSchemes|CustomTypeSchemesType|CustomTypeSchemes contains a collection of custom type schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. | ||
| 207 | |DataConstraints|DataConstraintsType|DataConstraints contains a collection of data (% style="color:#e74c3c" %)constraint(%%) descriptions. The (% style="color:#e74c3c" %)constraints(%%) may be detailed in full, or referenced from an external structure document or registry service. | ||
| 208 | |DataConsumerSchemes|DataConsumerSchemesType|DataConsumerSchemes contains a collection of [[data consumer scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]] descriptions. The [[data consumer schemes>>doc:sdmx:Glossary.Data consumer scheme.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 209 | |[[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]]|DataflowsType|[[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] contains a collection of [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] descriptions. The [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 210 | |DataProviderSchemes|DataProviderSchemesType|DataProviderSchemes contains a collection of [[data provider scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]] descriptions. The [[data provider schemes>>doc:sdmx:Glossary.Data provider scheme.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 211 | |DataStructures|DataStructuresType|DataStructures contains a collection of [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 212 | |GeographicCodelists|GeographicCodelistsType|GeographicCodelists contains a collection of geographi [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] descriptions. The [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 213 | |GeoGridCodelists|GeoGridCodelistsType|GeoGridCodelists contains a collection of geographic grid [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] descriptions. The [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 214 | |[[Hierarchies>>doc:sdmx:Glossary.Hierarchy.WebHome]]|HierarchiesType|[[Hierarchies>>doc:sdmx:Glossary.Hierarchy.WebHome]] contains a collection of [[hierarchical code list>>doc:sdmx:Glossary.Hierarchical code list.WebHome]] descriptions. The [[hierarchical code lists>>doc:sdmx:Glossary.Hierarchical code list.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 215 | |HierarchyAssociation s|HierarchyAssociationsType|HierarchyAssociations contains a collection of [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] associations. The associations may be detailed in full, or referenced from an external structure document or registry service. | ||
| 216 | |MetadataConstraints|MetadataConstraintsType|MetadataConstraints contains a collection of metadata (% style="color:#e74c3c" %)constraint(%%) descriptions. The (% style="color:#e74c3c" %)constraints(%%) may be detailed in full, or referenced from an external structure document or registry service. | ||
| 217 | |[[Metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]]|MetadataflowsType|[[Metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]] contains a collection of [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] descriptions. The [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 218 | |MetadataProviderSchemes|MetadataProviderSchemesType|MetadataProviderSchemes contains a collection of metadata provider scheme descriptions. The meatadata provider schemes may be detailed in full, or referenced from an external structure document or registry service. | ||
| 219 | |MetadataProvisionAreements|MetadataProvisionAgreementsType|ProvisionAgreements contains a collection of [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]]. The [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 220 | |MetadataStructures|MetadataStructuresType|MetadataStructures contains a collection of [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] descriptions. The [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 221 | |NamePersonalisationSchemes|NamePersonalisationSchemesType|NamePersonalisationSchemes contains a collection of name personalisation schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. | ||
| 222 | |OrganisationSchemeMaps|OrganisationSchemeMapsType|OrganisationSchemeMaps contains a collection of organisation scheme (% style="color:#e74c3c" %)map(%%) descriptions. The organisation scheme (% style="color:#e74c3c" %)maps(%%) may be detailed in full, or referenced from an external structure document or registry service. | ||
| 223 | |OrganisationUnitSchemes|OrganisationUnitSchemesType|OrganisationUnitSchemes contains a collection of [[organisation unit scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]] descriptions. The [[organisation unit schemes>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 224 | |Processes|ProcessesType|Processes contains a collection of process descriptions. The processes may be detailed in full, or referenced from an external structure document or registry service. | ||
| 225 | |ProvisionAgreements|ProvisionAgreementsType|ProvisionAgreements contains a collection of [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]]. The [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 226 | |ReportingTaxonomies|ReportingTaxonomiesType|ReportingTaxonomies contains a collection of [[reporting taxonomy>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]] descriptions. The reporting taxonomies may be detailed in full, or referenced from an external structure document or registry service. | ||
| 227 | |ReportingTaxonomyMaps|ReportingTaxonomyMapsType|ReportingTaxonomyMaps contains a collection of [[reporting taxonomy>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]] (% style="color:#e74c3c" %)map(%%) descriptions. The [[reporting taxonomy>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]] (% style="color:#e74c3c" %)maps(%%) may be detailed in full, or referenced from an external structure document or registry service. | ||
| 228 | |RepresentationMaps|RepresentationMapsType|RepresentationMaps contains a collection of [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)map(%%) descriptions. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)maps(%%) may be detailed in full, or referenced from an external structure document or registry service. | ||
| 229 | |RulesetSchemes|RulesetSchemesType|RulesetSchemes contains a collection of ruleset schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. | ||
| 230 | |StructureMaps|StructureMapsType|StructureMaps contains a collection of structure (% style="color:#e74c3c" %)map(%%) descriptions. The structure (% style="color:#e74c3c" %)maps(%%) may be detailed in full, or referenced from an external structure document or registry service. | ||
| 231 | |TransformationSchemes|TransformationScheme sType|TransformationSchemes contains a collection of transformation schemes. The transformation schemes may be detailed in full, or referenced from an external structure document or registry service. | ||
| 232 | |UserDefinedOperatorSchemes|UserDefinedOperatorSchemesType|UserDefinedOperatorSchemes contains a collection of user defined operator schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. | ||
| 233 | |ValueLists|ValueListsType|ValueLists contains a collection of value list descriptions. The value lists may be detailed in full, or referenced from an external structure document or registry service. | ||
| 234 | |VtlMappingSchemes|VtlMappingSchemesType|VtlMappingSchemes contains a collection of [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mapping schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. | ||
| 235 | |||
| 236 | **AgencySchemesType:** AgencySchemesType describes the structure of the [[agency schemes>>doc:sdmx:Glossary.Agency scheme.WebHome]] container. It contains one or more [[agency scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 237 | |||
| 238 | Content: | ||
| 239 | AgencyScheme+ | ||
| 240 | |||
| 241 | Element Documentation: | ||
| 242 | |||
| 243 | |**Name**|**Type**|**Documentation** | ||
| 244 | |AgencyScheme|AgencySchemeType|AgencyScheme provides the details of an [[agency scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]], in which agencies are described. | ||
| 245 | |||
| 246 | **CategorisationsType:** CategorisationsType describes the structure of the categorisations container. It contains one or more categorisation of a specific object type, which can be explicitly detailed or referenced from an external structure document or registry service. This container may contain categorisations for multiple types of structural objects. | ||
| 247 | |||
| 248 | Content: | ||
| 249 | Categorisation+ | ||
| 250 | |||
| 251 | Element Documentation: | ||
| 252 | |||
| 253 | |**Name**|**Type**|**Documentation** | ||
| 254 | |Categorisation|CategorisationType|Categorisation allows for the association of an identifiable object to a [[category>>doc:sdmx:Glossary.Category.WebHome]], providing for the classifications of the reference identifiable object. This must either contain the full details of the categorisation, or provide a name and identification information and reference the full details from an external structure document or registry service. | ||
| 255 | |||
| 256 | **CategorySchemeMapsType:** CategorySchemeMapsType describes the structure of the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] (% style="color:#e74c3c" %)maps(%%) container. It contains one or more [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] (% style="color:#e74c3c" %)map(%%), which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 257 | |||
| 258 | Content: | ||
| 259 | CategorySchemeMap+ | ||
| 260 | |||
| 261 | Element Documentation: | ||
| 262 | |||
| 263 | |**Name**|**Type**|**Documentation** | ||
| 264 | |CategorySchemeMap|CategorySchemeMapType|CategorySchemeMap provides the details of a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] (% style="color:#e74c3c" %)map(%%), which descibes mappings between [[categories>>doc:sdmx:Glossary.Category.WebHome]] in different schemes. | ||
| 265 | |||
| 266 | **CategorySchemesType:** CategorySchemesType describes the structure of the [[category schemes>>doc:sdmx:Glossary.Category scheme.WebHome]] container. It contains one or more [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 267 | |||
| 268 | Content: | ||
| 269 | CategoryScheme+ | ||
| 270 | |||
| 271 | Element Documentation: | ||
| 272 | |||
| 273 | |**Name**|**Type**|**Documentation** | ||
| 274 | |CategoryScheme|CategorySchemeType|CategoryScheme provides the details of a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], which is the descriptive information for an arrangement or division of [[categories>>doc:sdmx:Glossary.Category.WebHome]] into groups based on characteristics, which the objects have in common. This provides for a simple, (% style="color:#e74c3c" %)leveled(%%) [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] or [[categories>>doc:sdmx:Glossary.Category.WebHome]]. | ||
| 275 | |||
| 276 | **ConceptSchemeMapsType:** ConceptSchemeMapsType describes the structure of the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] (% style="color:#e74c3c" %)maps(%%) container. It contains one or more [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] (% style="color:#e74c3c" %)map(%%), which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 277 | |||
| 278 | Content: | ||
| 279 | ConceptSchemeMap+ | ||
| 280 | |||
| 281 | Element Documentation: | ||
| 282 | |||
| 283 | |**Name**|**Type**|**Documentation** | ||
| 284 | |ConceptSchemeMap|ConceptSchemeMapType|ConceptSchemeMap provides the details of a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] (% style="color:#e74c3c" %)map(%%), which descibes mappings between (% style="color:#e74c3c" %)concepts(%%) in different schemes. | ||
| 285 | |||
| 286 | **ConceptSchemesType:** ConceptSchemesType describes the structure of the [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]] container. It contains one or more [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 287 | |||
| 288 | Content: | ||
| 289 | ConceptScheme | ||
| 290 | |||
| 291 | Element Documentation: | ||
| 292 | |||
| 293 | |**Name**|**Type**|**Documentation** | ||
| 294 | |ConceptScheme|ConceptSchemeType|ConceptScheme provides the details of a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]], which is the descriptive information for an arrangement or division of (% style="color:#e74c3c" %)concepts(%%) into groups based on characteristics, which the objects have in common. It contains a collection of (% style="color:#e74c3c" %)concept(%%) definitions, that may be arranged in simple [[hierarchies>>doc:sdmx:Glossary.Hierarchy.WebHome]]. | ||
| 295 | |||
| 296 | **CodelistsType:** CodelistsType describes the structure of the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] container. It contains one or more [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 297 | |||
| 298 | Content: | ||
| 299 | [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]+ | ||
| 300 | |||
| 301 | Element Documentation: | ||
| 302 | |||
| 303 | |**Name**|**Type**|**Documentation** | ||
| 304 | |[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]|CodelistType|[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] provides the details of a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], which is defined as a list from which some statistical (% style="color:#e74c3c" %)concepts(%%) (coded (% style="color:#e74c3c" %)concepts(%%)) take their values. | ||
| 305 | |||
| 306 | **CustomTypeSchemesType:** CustomTypeSchemesType describes the structure of the custom type schemes container. It contains one or more custom type scheme, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 307 | |||
| 308 | Content: | ||
| 309 | CustomTypeScheme+ | ||
| 310 | |||
| 311 | Element Documentation: | ||
| 312 | |||
| 313 | |**Name**|**Type**|**Documentation** | ||
| 314 | |CustomTypeScheme|CustomTypeSchemeType|CustomTypeScheme provides the details of a custom type scheme, in which user defined operators are described. | ||
| 315 | |||
| 316 | **DataConstraintsType:** DataConstraintsType describes the structure of the data (% style="color:#e74c3c" %)constraints(%%) container. It contains one or more data (% style="color:#e74c3c" %)constraint(%%), which can be explicitly detailed or referenced from an external structure document or registry service. This container may contain both attachment and content (% style="color:#e74c3c" %)constraints(%%). | ||
| 317 | |||
| 318 | Content: | ||
| 319 | DataConstraint+ | ||
| 320 | |||
| 321 | Element Documentation: | ||
| 322 | |||
| 323 | |**Name**|**Type**|**Documentation** | ||
| 324 | |DataConstraint|DataConstraintType|DataConstraint specifies a sub set of the definition of the allowable or available content of a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] in terms of the content or in terms of the set of key combinations. | ||
| 325 | |||
| 326 | **DataConsumerSchemesType:** DataConsumerSchemesType describes the structure of the [[data consumer schemes>>doc:sdmx:Glossary.Data consumer scheme.WebHome]] container. It contains one or more [[data consumer scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 327 | |||
| 328 | Content: | ||
| 329 | DataConsumerScheme+ | ||
| 330 | |||
| 331 | Element Documentation: | ||
| 332 | |||
| 333 | |**Name**|**Type**|**Documentation**| | ||
| 334 | |DataConsumerScheme|DataConsumerSchemeType|DataConsumerScheme provides the details of an [[data consumer scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]], in which [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]] are described.| | ||
| 335 | |||
| 336 | **DataflowsType:** DataflowsType describes the structure of the [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] container. It contains one or more [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 337 | |||
| 338 | Content: | ||
| 339 | |||
| 340 | [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]+ | ||
| 341 | |||
| 342 | Element Documentation: | ||
| 343 | |||
| 344 | |**Name**|**Type**|**Documentation** | ||
| 345 | |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|DataflowType|[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] provides the details of a [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]], which is defined as the structure of data that will be provided for different [[reference periods>>doc:sdmx:Glossary.Reference period.WebHome]]. | ||
| 346 | |||
| 347 | **DataProviderSchemesType:** DataProviderSchemesType describes the structure of the [[data provider schemes>>doc:sdmx:Glossary.Data provider scheme.WebHome]] container. It contains one or more [[data provider scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 348 | |||
| 349 | Content: | ||
| 350 | DataProviderScheme+ | ||
| 351 | |||
| 352 | Element Documentation: | ||
| 353 | |||
| 354 | |**Name**|**Type**|**Documentation** | ||
| 355 | |DataProviderScheme|DataProviderSchemeType|DataProviderScheme provides the details of an [[data provider scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]], in which [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]] are described. | ||
| 356 | |||
| 357 | **DataStructuresType:** DataStructuresType describes the structure of the [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]] container. It contains one or more [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 358 | |||
| 359 | Content: | ||
| 360 | DataStructure+ | ||
| 361 | |||
| 362 | Element Documentation: | ||
| 363 | |||
| 364 | |**Name**|**Type**|**Documentation** | ||
| 365 | |DataStructure|DataStructureType|DataStructure provides the details of a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], which is defined as a collection of metadata (% style="color:#e74c3c" %)concepts(%%), their structure and usage when used to collect or disseminate data. | ||
| 366 | |||
| 367 | **GeographicCodelistsType:** GeographicCodelistsType describes the structure of the geographic [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] container. It contains one or more geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 368 | |||
| 369 | Content: | ||
| 370 | GeographicCodelist+ | ||
| 371 | |||
| 372 | Element Documentation: | ||
| 373 | |||
| 374 | |**Name**|**Type**|**Documentation** | ||
| 375 | |GeographicCodelist|GeographicCodelistType|GeographiCodelist provides the details of a geographic [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] container, which comprises a set of GeoFeatureSetCodes, by adding a value in the [[Code>>doc:sdmx:Glossary.Code.WebHome]] that follows a pattern to represent a geo feature set. | ||
| 376 | |||
| 377 | **GeoGridCodelistsType:** GeoGridCodelistsType describes the structure of the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] container. It contains one or more geographic grid [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 378 | |||
| 379 | Content: | ||
| 380 | GeoGridCodelist+ | ||
| 381 | |||
| 382 | Element Documentation: | ||
| 383 | |||
| 384 | |**Name**|**Type**|**Documentation** | ||
| 385 | |GeoGridCodelist|GeoGridCodelistType|GeoGridCodelist provides the details of a geographic grid [[code list>>doc:sdmx:Glossary.Code list.WebHome]], which comprises a set of GridCodes, which are related to the gridDefinition specified in the GeoGridCodelist. | ||
| 386 | |||
| 387 | **HierarchiesType:** HierarchiesType describes the structure of the [[hierarchies>>doc:sdmx:Glossary.Hierarchy.WebHome]] container. It contains one or more [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 388 | |||
| 389 | Content: | ||
| 390 | [[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]+ | ||
| 391 | |||
| 392 | Element Documentation: | ||
| 393 | |||
| 394 | |**Name**|**Type**|**Documentation** | ||
| 395 | |[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]|HierarchyType|[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] provides the details of a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], which is defined as an organised collection of [[codes>>doc:sdmx:Glossary.Code.WebHome]] that may participate in many parent/child relationships with other [[codes>>doc:sdmx:Glossary.Code.WebHome]] in the list. | ||
| 396 | |||
| 397 | **HierarchyAssociationsType:** HiearchyAssociationsType describes the structure of the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] assoications container. It contains one or more hiearchy associations, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 398 | |||
| 399 | Content: | ||
| 400 | HierarchyAssociation+ | ||
| 401 | |||
| 402 | Element Documentation: | ||
| 403 | |||
| 404 | |**Name**|**Type**|**Documentation** | ||
| 405 | |HierarchyAssociation|HierarchyAssociation Type|HierarchyAssociation provides the details of a hiearchy assoication, which associates a hiearchy with an identifiable object in the context of another object. | ||
| 406 | |||
| 407 | **MetadataConstraintsType:** MetadataConstraintsType describes the structure of the metadata (% style="color:#e74c3c" %)constraints(%%) container. It contains one or more metadata (% style="color:#e74c3c" %)constraint(%%), which can be explicitly detailed or referenced from an external structure document or registry service. This container may contain both attachment and content (% style="color:#e74c3c" %)constraints(%%). | ||
| 408 | |||
| 409 | Content: | ||
| 410 | MetadataConstraint+ | ||
| 411 | |||
| 412 | Element Documentation: | ||
| 413 | |||
| 414 | |**Name**|**Type**|**Documentation** | ||
| 415 | |MetadataConstraint|MetadataConstraintType|MetadataConstraint specifies a sub set of the definition of the allowable content of a metadata set. | ||
| 416 | |||
| 417 | **MetadataflowsType:** MetadataflowsType describes the structure of the [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]] container. It contains one or more [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 418 | |||
| 419 | Content: | ||
| 420 | [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]+ | ||
| 421 | |||
| 422 | Element Documentation: | ||
| 423 | |||
| 424 | |**Name**|**Type**|**Documentation** | ||
| 425 | |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|MetadataflowType|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] provides the details of a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]], which is defined as the structure of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] that will be provided for different [[reference periods>>doc:sdmx:Glossary.Reference period.WebHome]] | ||
| 426 | |||
| 427 | **MetadataProviderSchemesType:** MetadataProviderSchemesType describes the structure of the metadata provider schemes container. It contains one or more metadata provider scheme, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 428 | |||
| 429 | Content: | ||
| 430 | MetadataProviderScheme+ | ||
| 431 | |||
| 432 | Element Documentation: | ||
| 433 | |||
| 434 | |**Name**|**Type**|**Documentation** | ||
| 435 | |MetadataProviderSche me|MetadataProviderSchemeType|MetadataProviderScheme provides the details of an metadata provider scheme, in which metadata providers are described. | ||
| 436 | |||
| 437 | **MetadataProvisionAgreementsType:** MetadataProvisionAgreementsType describes the structure of the metadata [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] container. It contains one or more metadata [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 438 | |||
| 439 | Content: | ||
| 440 | MetadataProvisionAgreement+ | ||
| 441 | |||
| 442 | Element Documentation: | ||
| 443 | |||
| 444 | |**Name**|**Type**|**Documentation**| | ||
| 445 | |MetadataProvisionAgreement|MetadataProvisionAgreementType|MetadataProvisionAgreement provides the details of a metadata [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], which is an agreement for a metadata provider to report [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] against a flow.| | ||
| 446 | |||
| 447 | **MetadataStructuresType:** MetadataStructuresType describes the structure of the [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] container. It contains one or more [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 448 | |||
| 449 | Content: | ||
| 450 | MetadataStructure+ | ||
| 451 | |||
| 452 | Element Documentation: | ||
| 453 | |||
| 454 | |**Name**|**Type**|**Documentation** | ||
| 455 | |MetadataStructure|MetadataStructureType|MetadataStructure provides the details of a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], which is defined as a collection of metadata (% style="color:#e74c3c" %)concepts(%%), their structure and usage when used to collect or disseminate [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]. A [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] performs several functions: it groups sets of objects into "targets" against which [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] may be reported. Targets define the structure of the [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] "keys" which identify specific types of reported metadata, and describe the valid values for populating the keys. Also, [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] provide a presentational organization of (% style="color:#e74c3c" %)concepts(%%) for reporting purposes. The structure of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is derived from this presentational structure. | ||
| 456 | |||
| 457 | **NamePersonalisationSchemesType:** NamePersonalisationSchemesType describes the structure of the name personalisation schemes container. It contains one or more name personalisation scheme, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 458 | |||
| 459 | Content: | ||
| 460 | NamePersonalisationScheme+ | ||
| 461 | |||
| 462 | Element Documentation: | ||
| 463 | |||
| 464 | |**Name**|**Type**|**Documentation** | ||
| 465 | |NamePersonalisationScheme|NamePersonalisationSchemeType|NamePersonalisationScheme provides the details of a name personalisation scheme, in which name personalisations are described. | ||
| 466 | |||
| 467 | **OrganisationSchemeMapsType:** OrganisationSchemeMapsType describes the structure of the organisation scheme (% style="color:#e74c3c" %)maps(%%) container. It contains one or more organisation scheme (% style="color:#e74c3c" %)map(%%), which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 468 | |||
| 469 | Content: | ||
| 470 | OrganisationSchemeMap+ | ||
| 471 | |||
| 472 | Element Documentation: | ||
| 473 | |||
| 474 | |**Name**|**Type**|**Documentation** | ||
| 475 | |OrganisationSchemeMap|OrganisationSchemeMapType|OrganisationSchemeMap provides the details of a organisation scheme (% style="color:#e74c3c" %)map(%%), which descibes mappings between organisations in different schemes. | ||
| 476 | |||
| 477 | **OrganisationUnitSchemesType:** OrganisationUnitSchemesType describes the structure of the [[organisation unit schemes>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]] container. It contains one or more [[organisation unit scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 478 | |||
| 479 | Content: | ||
| 480 | OrganisationUnitScheme+ | ||
| 481 | |||
| 482 | Element Documentation: | ||
| 483 | |||
| 484 | |**Name**|**Type**|**Documentation** | ||
| 485 | |OrganisationUnitScheme|OrganisationUnitSchemeType|OrganisationUnitScheme provides the details of an [[organisation unit scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]], in which organisation units are described. | ||
| 486 | |||
| 487 | **ProcessesType:** ProcessesType describes the structure of the processes container. It contains one or more process, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 488 | |||
| 489 | Content: | ||
| 490 | Process+ | ||
| 491 | |||
| 492 | Element Documentation: | ||
| 493 | |||
| 494 | |**Name**|**Type**|**Documentation** | ||
| 495 | |Process|ProcessType|Process provides the details of a process, which is a scheme which defines or documents the operations performed on data in order to validate data or to derive new information according to a given set of rules. It is not meant to support process automation, but serves as a description of how processes occur. The primary use for this structural mechanism is the attachment of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] regarding statistical processing. This must either contain the full details of the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], or provide a name and identification information and reference the full details from an external structure document or registry service. | ||
| 496 | |||
| 497 | **ProvisionAgreementsType:** ProvisionAgreementsType describes the structure of the [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] container. It contains one or more [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 498 | |||
| 499 | Content: | ||
| 500 | ProvisionAgreement+ | ||
| 501 | |||
| 502 | Element Documentation: | ||
| 503 | |||
| 504 | |**Name**|**Type**|**Documentation** | ||
| 505 | |ProvisionAgreement|ProvisionAgreementType|ProvisionAgreement provides the details of a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], which is an agreement for a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] to report data against a flow. | ||
| 506 | |||
| 507 | **ReportingTaxonomiesType:** ReportingTaxonomiesType describes the structure of the reporting taxonomies container. It contains one or more [[reporting taxonomy>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 508 | |||
| 509 | Content: | ||
| 510 | ReportingTaxonomy+ | ||
| 511 | |||
| 512 | Element Documentation: | ||
| 513 | |||
| 514 | |**Name**|**Type**|**Documentation** | ||
| 515 | |ReportingTaxonomy|ReportingTaxonomyType|ReportingTaxonomy provides the details of a [[reporting taxonomy>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]], which is a scheme which defines the composition structure of a data report where each [[component>>doc:sdmx:Glossary.Component.WebHome]] can be described by an independent data or [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] definition. | ||
| 516 | |||
| 517 | **ReportingTaxonomyMapsType:** ReportingTaxonomyMapsType describes the structure of the [[reporting taxonomy>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]] (% style="color:#e74c3c" %)maps(%%) container. It contains one or [[reporting taxonomy>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]] (% style="color:#e74c3c" %)map(%%), which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 518 | |||
| 519 | Content: | ||
| 520 | ReportingTaxonomyMap+ | ||
| 521 | |||
| 522 | Element Documentation: | ||
| 523 | |||
| 524 | |**Name**|**Type**|**Documentation** | ||
| 525 | |ReportingTaxonomyMap|ReportingTaxonomyMapType|ReportingTaxonomyMap provides the details of a [[reporting taxonomy>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]] (% style="color:#e74c3c" %)map(%%), which descibes mappings between reporting taxonomies. | ||
| 526 | |||
| 527 | **RepresentationMapsType:** RepresentationMapsType describes the structure of the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)maps(%%) container. It contains one or more [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)map(%%), which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 528 | |||
| 529 | Content: | ||
| 530 | RepresentationMap+ | ||
| 531 | |||
| 532 | Element Documentation: | ||
| 533 | |||
| 534 | |**Name**|**Type**|**Documentation** | ||
| 535 | |RepresentationMap|RepresentationMapType|RepresentationMap provides the details of a represenation (% style="color:#e74c3c" %)map(%%), which describes mappings between various [[component>>doc:sdmx:Glossary.Component.WebHome]] represenations. | ||
| 536 | |||
| 537 | **RulesetSchemesType:** RulesetSchemesType describes the structure of the ruleset schemes container. It contains one or more ruleset scheme, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 538 | |||
| 539 | Content: | ||
| 540 | RulesetScheme+ | ||
| 541 | |||
| 542 | Element Documentation: | ||
| 543 | |||
| 544 | |**Name**|**Type**|**Documentation** | ||
| 545 | |RulesetScheme|RulesetSchemeType|RulesetScheme provides the details of a ruleset scheme, in which rulesets are described. | ||
| 546 | |||
| 547 | **StructureMapsType:** StructureMapsType describes the structure of the structure (% style="color:#e74c3c" %)maps(%%) container. It contains one or more structure (% style="color:#e74c3c" %)maps(%%), which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 548 | |||
| 549 | Content: | ||
| 550 | StructureMap+ | ||
| 551 | |||
| 552 | Element Documentation: | ||
| 553 | |||
| 554 | |**Name**|**Type**|**Documentation** | ||
| 555 | |StructureMap|StructureMapType|StructureMap provides the details or a structure (% style="color:#e74c3c" %)map(%%), which describes mapping between data structures or [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]]. | ||
| 556 | |||
| 557 | **TransformationSchemesType:** TransformationSchemesType describes the structure of the transformations container. It contains one or more transformation schemes, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 558 | |||
| 559 | Content: | ||
| 560 | |||
| 561 | TransformationScheme+ | ||
| 562 | |||
| 563 | Element Documentation: | ||
| 564 | |||
| 565 | |**Name**|**Type**|**Documentation** | ||
| 566 | |TransformationScheme|TransformationScheme Type|TransformationScheme provides the details of a transformation scheme, in which transformations are described. | ||
| 567 | |||
| 568 | **UserDefinedOperatorSchemesType:** UserDefinedOperatorSchemesType describes the structure of the user defined operator schemes container. It contains one or more user defined operator scheme, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 569 | |||
| 570 | Content: | ||
| 571 | UserDefinedOperatorScheme+ | ||
| 572 | |||
| 573 | Element Documentation: | ||
| 574 | |||
| 575 | |**Name**|**Type**|**Documentation** | ||
| 576 | |UserDefinedOperatorScheme|UserDefinedOperatorSchemeType|UserDefinedOperatorScheme provides the details of a user defined operator scheme, in which user defined operators are described. | ||
| 577 | |||
| 578 | **ValueListsType:** ValueListsType describes the structure of the value lists container. It contains one or more value list, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 579 | |||
| 580 | Content: | ||
| 581 | |||
| 582 | ValueList+ | ||
| 583 | |||
| 584 | Element Documentation: | ||
| 585 | |||
| 586 | (% style="width:1138.29px" %) | ||
| 587 | |(% style="width:172px" %)**Name**|(% style="width:219px" %)**Type**|(% style="width:744px" %)**Documentation** | ||
| 588 | |(% style="width:172px" %)ValueList|(% style="width:219px" %)ValueListType|(% style="width:744px" %)ValueList provides the details of a value list, which is a closed set of values that can occur for a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[measure>>doc:sdmx:Glossary.Measure.WebHome]], or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. This may be a simple list of values, or a list of values with names and descriptions (similar to a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]). | ||
| 589 | |||
| 590 | **VtlMappingSchemesType:** VtlMappingSchemesType describes the structure of the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mappings schemes container. It contains one or more [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mapping schemes, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 591 | |||
| 592 | Content: | ||
| 593 | |||
| 594 | VtlMappingScheme+ | ||
| 595 | |||
| 596 | Element Documentation: | ||
| 597 | |||
| 598 | |**Name**|**Type**|**Documentation** | ||
| 599 | |VtlMappingScheme|VtlMappingSchemeType|VtlMappingScheme provides the details of a [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mapping scheme, in which [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mappings are described. | ||
| 600 | |||
| 601 | **ItemSchemeType:** ItemSchemeType is an abstract base type for all [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] objects. It contains a collection of items. Concrete instances of this type should restrict the actual types of items allowed within the scheme. | ||
| 602 | |||
| 603 | Derivation: | ||
| 604 | AnnotableType (extension) | ||
| 605 | IdentifiableType (extension) | ||
| 606 | NameableType (extension) | ||
| 607 | VersionableType (restriction) | ||
| 608 | MaintainableBaseType (extension) | ||
| 609 | MaintainableType (extension) | ||
| 610 | ItemSchemeType | ||
| 611 | |||
| 612 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 613 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 614 | |||
| 615 | Content: | ||
| 616 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, Item* | ||
| 617 | |||
| 618 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 619 | |||
| 620 | |**Name**|**Type**|**Documentation** | ||
| 621 | |id|IDType|The id is the identifier for the object. | ||
| 622 | |urn|MaintainableUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 623 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 624 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 625 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 626 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 627 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 628 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 629 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 630 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 631 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 632 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is being communicated. This is used in cases where a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is returned for a data structure in the context of a (% style="color:#e74c3c" %)constraint(%%). | ||
| 633 | |||
| 634 | Element Documentation: | ||
| 635 | |||
| 636 | |**Name**|**Type**|**Documentation** | ||
| 637 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 638 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 639 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 640 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 641 | |*Item*|*ItemType*|Item is an abstract element that serves as a substitution head for all items in an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType. | ||
| 642 | |||
| 643 | **ItemBaseType:** ItemBaseType is an abstract base type that forms the basis for the ItemType. It requires that at least an id be supplied for an item. | ||
| 644 | |||
| 645 | Derivation: | ||
| 646 | AnnotableType (extension) | ||
| 647 | IdentifiableType (extension) | ||
| 648 | NameableType (restriction) | ||
| 649 | ItemBaseType | ||
| 650 | |||
| 651 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 652 | id, urn?, uri? | ||
| 653 | |||
| 654 | Content: | ||
| 655 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description | ||
| 656 | |||
| 657 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 658 | |||
| 659 | |**Name**|**Type**|**Documentation** | ||
| 660 | |id|IDType|The id is the identifier for the object. | ||
| 661 | |urn|UrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 662 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 663 | |||
| 664 | Element Documentation: | ||
| 665 | |||
| 666 | |**Name**|**Type**|**Documentation** | ||
| 667 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 668 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 669 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 670 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 671 | |||
| 672 | ***ItemType*:** ItemType is an abstract base type for all items with in an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]. Concrete instances of this type may or may not utilize the nested item, but if so should restrict the actual types of item allowed. | ||
| 673 | |||
| 674 | Derivation: | ||
| 675 | AnnotableType (extension) | ||
| 676 | IdentifiableType (extension) | ||
| 677 | NameableType (restriction) | ||
| 678 | ItemBaseType (extension) | ||
| 679 | ItemType | ||
| 680 | |||
| 681 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 682 | id, urn?, uri? | ||
| 683 | |||
| 684 | Content: | ||
| 685 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, (Parent |Item+ )? | ||
| 686 | |||
| 687 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 688 | |||
| 689 | |**Name**|**Type**|**Documentation** | ||
| 690 | |id|IDType|The id is the identifier for the object. | ||
| 691 | |urn|UrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 692 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 693 | |||
| 694 | Element Documentation: | ||
| 695 | |||
| 696 | |**Name**|**Type**|**Documentation** | ||
| 697 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 698 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 699 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 700 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 701 | |Parent|NestedIDType| | ||
| 702 | |*Item*|*ItemType*|Item is an abstract element that serves as a substitution head for all items in an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType. | ||
| 703 | |||
| 704 | ***UnnestedItemType*:** UnnestedItemType is an abstract base type for all items with in an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that do not contain nested items. | ||
| 705 | |||
| 706 | Derivation: | ||
| 707 | AnnotableType (extension) | ||
| 708 | IdentifiableType (extension) | ||
| 709 | NameableType (restriction) | ||
| 710 | ItemBaseType (extension) | ||
| 711 | ItemType (restriction) | ||
| 712 | UnnestedItemType | ||
| 713 | |||
| 714 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 715 | id, urn?, uri? | ||
| 716 | |||
| 717 | Content: | ||
| 718 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link, Name+, Description | ||
| 719 | |||
| 720 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 721 | |||
| 722 | |**Name**|**Type**|**Documentation** | ||
| 723 | |id|IDType|The id is the identifier for the object. | ||
| 724 | |urn|UrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 725 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 726 | |||
| 727 | Element Documentation: | ||
| 728 | |||
| 729 | |**Name**|**Type**|**Documentation** | ||
| 730 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 731 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 732 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 733 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 734 | |||
| 735 | ***StructureType*:** StructureType is an abstract base type for all structure objects. Concrete instances of this should restrict to a concrete grouping. | ||
| 736 | |||
| 737 | Derivation: | ||
| 738 | AnnotableType (extension) | ||
| 739 | IdentifiableType (extension) | ||
| 740 | NameableType (extension) | ||
| 741 | VersionableType (restriction) | ||
| 742 | MaintainableBaseType (extension) | ||
| 743 | MaintainableType (extension) | ||
| 744 | StructureType | ||
| 745 | |||
| 746 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 747 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 748 | |||
| 749 | Content: | ||
| 750 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, Grouping? | ||
| 751 | |||
| 752 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 753 | |||
| 754 | |**Name**|**Type**|**Documentation** | ||
| 755 | |id|IDType|The id is the identifier for the object. | ||
| 756 | |urn|MaintainableUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 757 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 758 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 759 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 760 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 761 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 762 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 763 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 764 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 765 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 766 | |||
| 767 | Element Documentation: | ||
| 768 | |||
| 769 | |**Name**|**Type**|**Documentation** | ||
| 770 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 771 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 772 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 773 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 774 | |*Grouping*|*GroupingType*|Grouping is an abstract element that serves as a substitution head for all structure groupings. Groupings contain a collection of [[component>>doc:sdmx:Glossary.Component.WebHome]] lists for a structure. Concrete instances of this must use a concrete instance of GroupingType. | ||
| 775 | |||
| 776 | ***GroupingType*:** GroupType is an abstract base type for specific structure groupings. It contains a collection of [[component>>doc:sdmx:Glossary.Component.WebHome]] lists. Concrete instances of this should restrict to specific concrete [[component>>doc:sdmx:Glossary.Component.WebHome]] lists. | ||
| 777 | |||
| 778 | Content: | ||
| 779 | ComponentList | ||
| 780 | |||
| 781 | Element Documentation: | ||
| 782 | |||
| 783 | |**Name**|**Type**|**Documentation**| | ||
| 784 | |*ComponentList*|*ComponentListType*|ComponentList is an abstract element that serves as a substitution head for all [[component>>doc:sdmx:Glossary.Component.WebHome]] lists. Concrete instances of this must use a concrete instance of ComponentListType.| | ||
| 785 | |||
| 786 | ***ComponentListType*:** ComponentListType is an abstract base type for all [[component>>doc:sdmx:Glossary.Component.WebHome]] lists. It contains a collection of [[components>>doc:sdmx:Glossary.Component.WebHome]]. Concrete types should restrict this to specific concrete [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 787 | |||
| 788 | Derivation: | ||
| 789 | AnnotableType (extension) | ||
| 790 | IdentifiableType (extension) | ||
| 791 | ComponentListType | ||
| 792 | |||
| 793 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 794 | id?, urn?, uri? | ||
| 795 | |||
| 796 | Content: | ||
| 797 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 798 | |||
| 799 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 800 | |||
| 801 | |**Name**|**Type**|**Documentation** | ||
| 802 | |id|IDType|The id is the identifier for the object. | ||
| 803 | |urn|UrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 804 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 805 | |||
| 806 | Element Documentation: | ||
| 807 | |||
| 808 | |**Name**|**Type**|**Documentation** | ||
| 809 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 810 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 811 | |*[[Component>>doc:sdmx:Glossary.Component.WebHome]]*|*ComponentType*|[[Component>>doc:sdmx:Glossary.Component.WebHome]] is an abstract element that serves as a substitution head for all [[components>>doc:sdmx:Glossary.Component.WebHome]]. Concrete instances of this must use a concrete instance of ComponentType. | ||
| 812 | |||
| 813 | ***ComponentBaseType*:** ComponentBaseType is an abstract type that only serves the purpose of forming the base for the actual ComponentType. It only restricts the format of the id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to the NCNameIDType. | ||
| 814 | |||
| 815 | Derivation: | ||
| 816 | AnnotableType (extension) | ||
| 817 | IdentifiableType (restriction) | ||
| 818 | ComponentBaseType | ||
| 819 | |||
| 820 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 821 | id?, urn?, uri? | ||
| 822 | |||
| 823 | Content: | ||
| 824 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link | ||
| 825 | |||
| 826 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 827 | |||
| 828 | |**Name**|**Type**|**Documentation** | ||
| 829 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds an explicit identification of the [[component>>doc:sdmx:Glossary.Component.WebHome]]. If this identifier is not supplied, then it is assumed to be the same as the identifier of the (% style="color:#e74c3c" %)concept(%%) referenced from the (% style="color:#e74c3c" %)concept(%%) identity. Because structures require that every [[component>>doc:sdmx:Glossary.Component.WebHome]] be given a unique identifier, it may be necessary to assign an explicit identifier when more than one [[component>>doc:sdmx:Glossary.Component.WebHome]] in a structure reference (% style="color:#e74c3c" %)concepts(%%) with same identifier. It is important to note that this applies strictly to the identifier of (% style="color:#e74c3c" %)concept(%%) and not the URN. Therefore if two (% style="color:#e74c3c" %)concepts(%%) with the same identifier from different [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]] are referenced in the same structure, one of the [[components>>doc:sdmx:Glossary.Component.WebHome]] will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since [[component>>doc:sdmx:Glossary.Component.WebHome]] identifiers are used to create XML elements and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 830 | |urn|UrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 831 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 832 | |||
| 833 | Element Documentation: | ||
| 834 | |||
| 835 | |**Name**|**Type**|**Documentation** | ||
| 836 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 837 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 838 | |||
| 839 | ***ComponentType*:** ComponentType is an abstract base type for all [[components>>doc:sdmx:Glossary.Component.WebHome]]. It contains information pertaining to a [[component>>doc:sdmx:Glossary.Component.WebHome]], including an optional reference to a (% style="color:#e74c3c" %)concept(%%), an optional role played by the (% style="color:#e74c3c" %)concept(%%), an optional text format description, and an optional local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 840 | |||
| 841 | Derivation: | ||
| 842 | AnnotableType (extension) | ||
| 843 | IdentifiableType (restriction) | ||
| 844 | ComponentBaseType (extension) | ||
| 845 | ComponentType | ||
| 846 | |||
| 847 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 848 | id?, urn?, uri? | ||
| 849 | |||
| 850 | Content: | ||
| 851 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, ConceptIdentity?, LocalRepresentation? | ||
| 852 | |||
| 853 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 854 | |||
| 855 | |**Name**|**Type**|**Documentation** | ||
| 856 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds an explicit identification of the [[component>>doc:sdmx:Glossary.Component.WebHome]]. If this identifier is not supplied, then it is assumed to be the same as the identifier of the (% style="color:#e74c3c" %)concept(%%) referenced from the (% style="color:#e74c3c" %)concept(%%) identity. Because structures require that every [[component>>doc:sdmx:Glossary.Component.WebHome]] be given a unique identifier, it may be necessary to assign an explicit identifier when more than one [[component>>doc:sdmx:Glossary.Component.WebHome]] in a structure reference (% style="color:#e74c3c" %)concepts(%%) with same identifier. It is important to note that this applies strictly to the identifier of (% style="color:#e74c3c" %)concept(%%) and not the URN. Therefore if two (% style="color:#e74c3c" %)concepts(%%) with the same identifier from different [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]] are referenced in the same structure, one of the [[components>>doc:sdmx:Glossary.Component.WebHome]] will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since [[component>>doc:sdmx:Glossary.Component.WebHome]] identifiers are used to create XML elements and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 857 | |urn|UrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 858 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 859 | |||
| 860 | Element Documentation: | ||
| 861 | |||
| 862 | |**Name**|**Type**|**Documentation** | ||
| 863 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 864 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 865 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a (% style="color:#e74c3c" %)concept(%%) in a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]. The [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic from this (% style="color:#e74c3c" %)concept(%%), and if an id is not specified, it takes its identification as well. If a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (LocalRepresentation) is not supplied, then the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[component>>doc:sdmx:Glossary.Component.WebHome]] is also inherited from the (% style="color:#e74c3c" %)concept(%%). Note that in the case of the [[component>>doc:sdmx:Glossary.Component.WebHome]] [[representation>>doc:sdmx:Glossary.Representation.WebHome]] being inherited from the (% style="color:#e74c3c" %)concept(%%), the allowable [[representations>>doc:sdmx:Glossary.Representation.WebHome]] for the [[component>>doc:sdmx:Glossary.Component.WebHome]] still apply. Therefore, if a [[component>>doc:sdmx:Glossary.Component.WebHome]] references a (% style="color:#e74c3c" %)concept(%%) with a core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] that is not allowed for the (% style="color:#e74c3c" %)concept(%%), that [[representation>>doc:sdmx:Glossary.Representation.WebHome]] must be locally overridden. For [[components>>doc:sdmx:Glossary.Component.WebHome]] which can specify a (% style="color:#e74c3c" %)concept(%%) role, it is implied that the (% style="color:#e74c3c" %)concept(%%) which is referenced also identifies a role for the [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 866 | |LocalRepresentation|*RepresentationType*|LocalRepresentation references [[item schemes>>doc:sdmx:Glossary.Item scheme.WebHome]] that may be used to create the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. The type of this must be refined such that a concrete [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] reference is used. | ||
| 867 | |||
| 868 | ***StructureUsageType*:** StructureUsageType is an abstract base type for all structure usages. It contains a reference to a structure. Concrete instances of this type should restrict the type of structure referenced. | ||
| 869 | |||
| 870 | Derivation: | ||
| 871 | AnnotableType (extension) | ||
| 872 | IdentifiableType (extension) | ||
| 873 | NameableType (extension) | ||
| 874 | VersionableType (restriction) | ||
| 875 | MaintainableBaseType (extension) | ||
| 876 | MaintainableType (extension) | ||
| 877 | StructureUsageType | ||
| 878 | |||
| 879 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 880 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 881 | |||
| 882 | Content: | ||
| 883 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, Structure? | ||
| 884 | |||
| 885 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 886 | |||
| 887 | |**Name**|**Type**|**Documentation** | ||
| 888 | |id|IDType|The id is the identifier for the object. | ||
| 889 | |urn|MaintainableUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 890 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 891 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 892 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 893 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 894 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 895 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 896 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 897 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 898 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 899 | |||
| 900 | Element Documentation: | ||
| 901 | |||
| 902 | |**Name**|**Type**|**Documentation** | ||
| 903 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 904 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 905 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 906 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 907 | |Structure|StructureReferenceType|Structure references the structure (data structure or [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]) which the structure usage is based upon. Implementations will have to refine the type to use a concrete structure reference (i.e. either a data structure or [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] reference). | ||
| 908 | |||
| 909 | ***RepresentationType*:** RepresentationType is an abstract type that defines a [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. Because the type of [[item schemes>>doc:sdmx:Glossary.Item scheme.WebHome]] that are allowed as the an enumeration vary based on the object in which this is defined, this type is abstract to force that the enumeration reference be restricted to the proper type of [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] reference. | ||
| 910 | |||
| 911 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 912 | minOccurs?, maxOccurs? | ||
| 913 | |||
| 914 | Content: | ||
| 915 | (TextFormat|(Enumeration, EnumerationFormat?)) | ||
| 916 | |||
| 917 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 918 | |||
| 919 | |**Name**|**Type**|**Documentation** | ||
| 920 | |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the minimum number of value that must be reported for the [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 921 | |maxOccurs|OccurenceType|The maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the maximum number of values that can be reported for the [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 922 | |||
| 923 | Element Documentation: | ||
| 924 | |||
| 925 | |**Name**|**Type**|**Documentation** | ||
| 926 | |TextFormat|TextFormatType|TextFormat describes an uncoded textual format. | ||
| 927 | |Enumeration|AnyCodelistReferenceType|Enumeration references an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that enumerates the allowable values for this [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 928 | |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the [[facets>>doc:sdmx:Glossary.Facet.WebHome]] of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] enumeration. This is for the most part, informational. | ||
| 929 | |||
| 930 | **TextFormatType:** TextFormatType defines the information for describing a full range of text formats and may place restrictions on the values of the other [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], referred to as "[[facets>>doc:sdmx:Glossary.Facet.WebHome]]". | ||
| 931 | |||
| 932 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 933 | textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, [[decimals>>doc:sdmx:Glossary.Decimals.WebHome]]?, pattern?, isMultiLingual? | ||
| 934 | |||
| 935 | Content: | ||
| 936 | SentinelValue | ||
| 937 | |||
| 938 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 939 | |||
| 940 | |**Name**|**Type**|**Documentation** | ||
| 941 | |textType (default: String)|DataType|The textType [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the (% style="color:#e74c3c" %)constraints(%%) of the [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. | ||
| 942 | |isSequence|xs:boolean|The isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] or the timeInterval, startTime, and endTime, [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. If this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely. | ||
| 943 | |interval|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The interval [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a value of true. | ||
| 944 | |startValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The startValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and interval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. | ||
| 945 | |endValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The endValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and interval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a numeric sequence, and indicates that ending point (if any) of the sequence. | ||
| 946 | |timeInterval|xs:duration|The timeInterval [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the permitted duration in a time sequence. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a value of true. | ||
| 947 | |startTime|StandardTimePeriodType|The startTime [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and timeInterval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed. | ||
| 948 | |endTime|StandardTimePeriodType|The endTime [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and timeInterval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a time sequence, and indicates that ending point (if any) of the sequence. | ||
| 949 | |minLength|xs:positiveInteger|The minLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the minimum and length of the value in characters. | ||
| 950 | |maxLength|xs:positiveInteger|The maxLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the maximum length of the value in characters. | ||
| 951 | |minValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The minValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. | ||
| 952 | |maxValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The maxValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. | ||
| 953 | |[[decimals>>doc:sdmx:Glossary.Decimals.WebHome]]|xs:positiveInteger|The [[decimals>>doc:sdmx:Glossary.Decimals.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the number of characters allowed after the [[decimal>>doc:sdmx:Glossary.Decimals.WebHome]] separator. | ||
| 954 | |pattern|xs:string|The pattern [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds any regular expression permitted in the similar [[facet>>doc:sdmx:Glossary.Facet.WebHome]] in W3C XML Schema. | ||
| 955 | |isMultiLingual (default: true)|xs:boolean|The isMultiLingual [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates for a text format of type "string", whether the value should allow for multiple values in different languages. | ||
| 956 | |||
| 957 | Element Documentation: | ||
| 958 | |||
| 959 | |**Name**|**Type**|**Documentation** | ||
| 960 | |SentinelValue|SentinelValueType|SentinelValue defines a value that has a special meaning within the text format [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 961 | |||
| 962 | **SentinelValueType:** SentinelValueType defines the structure of a sentinel value. A sentinel is a value that has a special meaning within the text format [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. The value is associated with a multi-lingual name and description. | ||
| 963 | |||
| 964 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 965 | value | ||
| 966 | |||
| 967 | Content: | ||
| 968 | Name+, Description | ||
| 969 | |||
| 970 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 971 | |||
| 972 | |**Name**|**Type**|**Documentation** | ||
| 973 | |value|xs:anySimpleType|The sentinel value being described. | ||
| 974 | |||
| 975 | Element Documentation: | ||
| 976 | |||
| 977 | |**Name**|**Type**|**Documentation** | ||
| 978 | |Name|TextType|Name is a reusable element, used for providing a human-readable name for an object. | ||
| 979 | |Description|TextType|Description is a reusable element, used for providing a longer human-readable description of an object. | ||
| 980 | |||
| 981 | **BasicComponentTextFormatType:** BasicComponentTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the TextFormatType that restricts the text type to the [[representations>>doc:sdmx:Glossary.Representation.WebHome]] allowed for all [[components>>doc:sdmx:Glossary.Component.WebHome]] except for target objects. | ||
| 982 | |||
| 983 | Derivation: | ||
| 984 | TextFormatType (restriction) | ||
| 985 | BasicComponentTextFormatType | ||
| 986 | |||
| 987 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 988 | textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, [[decimals>>doc:sdmx:Glossary.Decimals.WebHome]]?, pattern?, isMultiLingual? | ||
| 989 | |||
| 990 | Content: | ||
| 991 | SentinelValue | ||
| 992 | |||
| 993 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 994 | |||
| 995 | |**Name**|**Type**|**Documentation** | ||
| 996 | |textType (default: String)|BasicComponentDataType|The textType [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the (% style="color:#e74c3c" %)constraints(%%) of the [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. | ||
| 997 | |isSequence|xs:boolean|The isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] or the timeInterval, startTime, and endTime, [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. If this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely. | ||
| 998 | |interval|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The interval [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a value of true. | ||
| 999 | |startValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The startValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and interval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. | ||
| 1000 | |endValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The endValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and interval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a numeric sequence, and indicates that ending point (if any) of the sequence. | ||
| 1001 | |timeInterval|xs:duration|The timeInterval [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the permitted duration in a time sequence. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a value of true. | ||
| 1002 | |startTime|StandardTimePeriodType|The startTime [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and timeInterval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed. | ||
| 1003 | |endTime|StandardTimePeriodType|The endTime [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and timeInterval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a time sequence, and indicates that ending point (if any) of the sequence. | ||
| 1004 | |minLength|xs:positiveInteger|The minLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the minimum and length of the value in characters. | ||
| 1005 | |maxLength|xs:positiveInteger|The maxLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the maximum length of the value in characters. | ||
| 1006 | |minValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The minValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. | ||
| 1007 | |maxValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The maxValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. | ||
| 1008 | |[[decimals>>doc:sdmx:Glossary.Decimals.WebHome]]|xs:positiveInteger|The [[decimals>>doc:sdmx:Glossary.Decimals.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the number of characters allowed after the [[decimal>>doc:sdmx:Glossary.Decimals.WebHome]] separator. | ||
| 1009 | |pattern|xs:string|The pattern [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds any regular expression permitted in the similar [[facet>>doc:sdmx:Glossary.Facet.WebHome]] in W3C XML Schema. | ||
| 1010 | |isMultiLingual (default: true)|xs:boolean|The isMultiLingual [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates for a text format of type "string", whether the value should allow for multiple values in different languages. | ||
| 1011 | |||
| 1012 | Element Documentation: | ||
| 1013 | |||
| 1014 | |**Name**|**Type**|**Documentation** | ||
| 1015 | |SentinelValue|SentinelValueType|SentinelValue defines a value that has a special meaning within the text format [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 1016 | |||
| 1017 | **SimpleComponentTextFormatType:** SimpleComponentTextFormatType is a restricted (% style="color: rgb(231, 76, 60); color: rgb(231, 76, 60)" %)version(%%) of the BasicComponentTextFormatType that does not allow for multi-lingual values. | ||
| 1018 | |||
| 1019 | Derivation: | ||
| 1020 | TextFormatType (restriction) | ||
| 1021 | BasicComponentTextFormatType (restriction) | ||
| 1022 | SimpleComponentTextFormatType | ||
| 1023 | |||
| 1024 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1025 | textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, [[decimals>>doc:sdmx:Glossary.Decimals.WebHome]]?, pattern? | ||
| 1026 | |||
| 1027 | Content: | ||
| 1028 | SentinelValue | ||
| 1029 | |||
| 1030 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1031 | |||
| 1032 | |**Name**|**Type**|**Documentation** | ||
| 1033 | |textType (default: String)|SimpleDataType|The textType [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the (% style="color:#e74c3c" %)constraints(%%) of the [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. | ||
| 1034 | |isSequence|xs:boolean|The isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] or the timeInterval, startTime, and endTime, [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. If this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely. | ||
| 1035 | |interval|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The interval [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a value of true. | ||
| 1036 | |startValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The startValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and interval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. | ||
| 1037 | |endValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The endValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and interval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a numeric sequence, and indicates that ending point (if any) of the sequence. | ||
| 1038 | |timeInterval|xs:duration|The timeInterval [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the permitted duration in a time sequence. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a value of true. | ||
| 1039 | |startTime|StandardTimePeriodType|The startTime [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and timeInterval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed. | ||
| 1040 | |endTime|StandardTimePeriodType|The endTime [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and timeInterval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a time sequence, and indicates that ending point (if any) of the sequence. | ||
| 1041 | |minLength|xs:positiveInteger|The minLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the minimum and length of the value in characters. | ||
| 1042 | |maxLength|xs:positiveInteger|The maxLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the maximum length of the value in characters. | ||
| 1043 | |minValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The minValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. | ||
| 1044 | |maxValue|xs:[[decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|The maxValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. | ||
| 1045 | |[[decimals>>doc:sdmx:Glossary.Decimals.WebHome]]|xs:positiveInteger|The [[decimals>>doc:sdmx:Glossary.Decimals.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the number of characters allowed after the [[decimal>>doc:sdmx:Glossary.Decimals.WebHome]] separator. | ||
| 1046 | |pattern|xs:string|The pattern [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds any regular expression permitted in the similar [[facet>>doc:sdmx:Glossary.Facet.WebHome]] in W3C XML Schema. | ||
| 1047 | |||
| 1048 | Element Documentation: | ||
| 1049 | |||
| 1050 | |**Name**|**Type**|**Documentation** | ||
| 1051 | |SentinelValue|SentinelValueType|SentinelValue defines a value that has a special meaning within the text format [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 1052 | |||
| 1053 | **CodedTextFormatType:** CodedTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the SimpleComponentTextFormatType that only allows factets and text types applicable to [[codes>>doc:sdmx:Glossary.Code.WebHome]]. Although the time [[facets>>doc:sdmx:Glossary.Facet.WebHome]] permit any value, an actual [[code>>doc:sdmx:Glossary.Code.WebHome]] identifier does not support the necessary characters for time. Therefore these [[facets>>doc:sdmx:Glossary.Facet.WebHome]] should not contain time in their values. | ||
| 1054 | |||
| 1055 | Derivation: | ||
| 1056 | TextFormatType (restriction) | ||
| 1057 | BasicComponentTextFormatType (restriction) | ||
| 1058 | SimpleComponentTextFormatType (restriction) | ||
| 1059 | CodedTextFormatType | ||
| 1060 | |||
| 1061 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1062 | textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, pattern? | ||
| 1063 | |||
| 1064 | Content: | ||
| 1065 | {Empty} | ||
| 1066 | |||
| 1067 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1068 | |||
| 1069 | |**Name**|**Type**|**Documentation** | ||
| 1070 | |textType|CodeDataType|The textType [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the (% style="color:#e74c3c" %)constraints(%%) of the [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. | ||
| 1071 | |isSequence|xs:boolean|The isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] or the timeInterval, startTime, and endTime, [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. If this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely. | ||
| 1072 | |interval|xs:integer|The interval [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a value of true. | ||
| 1073 | |startValue|xs:integer|The startValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and interval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. | ||
| 1074 | |endValue|xs:integer|The endValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and interval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a numeric sequence, and indicates that ending point (if any) of the sequence. | ||
| 1075 | |timeInterval|xs:duration|The timeInterval [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the permitted duration in a time sequence. In order for this to be used, the isSequence [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must have a value of true. | ||
| 1076 | |startTime|StandardTimePeriodType|The startTime [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and timeInterval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed. | ||
| 1077 | |endTime|StandardTimePeriodType|The endTime [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and timeInterval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a time sequence, and indicates that ending point (if any) of the sequence. | ||
| 1078 | |minLength|xs:positiveInteger|The minLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the minimum and length of the value in characters. | ||
| 1079 | |maxLength|xs:positiveInteger|The maxLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the maximum length of the value in characters. | ||
| 1080 | |minValue|xs:integer|The minValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. | ||
| 1081 | |maxValue|xs:integer|The maxValue [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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 will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is used with an integer data type), the value is assumed to be inclusive. | ||
| 1082 | |pattern|xs:string|The pattern [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds any regular expression permitted in the similar [[facet>>doc:sdmx:Glossary.Facet.WebHome]] in W3C XML Schema. | ||
| 1083 | |||
| 1084 | **NonFacetedTextFormatType:** NonFacetedTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the SimpleComponentTextFormatType that does not allow for any [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. | ||
| 1085 | |||
| 1086 | Derivation: | ||
| 1087 | TextFormatType (restriction) | ||
| 1088 | BasicComponentTextFormatType (restriction) | ||
| 1089 | SimpleComponentTextFormatType (restriction) | ||
| 1090 | NonFacetedTextFormatType | ||
| 1091 | |||
| 1092 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1093 | textType? | ||
| 1094 | |||
| 1095 | Content: | ||
| 1096 | {Empty} | ||
| 1097 | |||
| 1098 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1099 | |||
| 1100 | |**Name**|**Type**|**Documentation** | ||
| 1101 | |textType|SimpleDataType|The textType [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the (% style="color:#e74c3c" %)constraints(%%) of the [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. | ||
| 1102 | |||
| 1103 | **TimeTextFormatType:** TimeTextFormat is a restricted (% style="color:#e74c3c" %)version(%%) of the SimpleComponentTextFormatType that only allows time based format and specifies a default ObservationalTimePeriod [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and [[facets>>doc:sdmx:Glossary.Facet.WebHome]] of a start and end time. | ||
| 1104 | |||
| 1105 | Derivation: | ||
| 1106 | TextFormatType (restriction) | ||
| 1107 | BasicComponentTextFormatType (restriction) | ||
| 1108 | SimpleComponentTextFormatType (restriction) | ||
| 1109 | TimeTextFormatType | ||
| 1110 | |||
| 1111 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1112 | textType?, startTime?, endTime? | ||
| 1113 | |||
| 1114 | Content: | ||
| 1115 | SentinelValue | ||
| 1116 | |||
| 1117 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1118 | |||
| 1119 | |**Name**|**Type**|**Documentation** | ||
| 1120 | |textType (default: ObservationalTimePeriod)|TimeDataType|The textType [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the (% style="color:#e74c3c" %)constraints(%%) of the [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. | ||
| 1121 | |startTime|StandardTimePeriodType|The startTime [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and timeInterval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed. | ||
| 1122 | |endTime|StandardTimePeriodType|The endTime [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used in conjunction with the isSequence and timeInterval [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (which must be set in order to use this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used for a time sequence, and indicates that ending point (if any) of the sequence. | ||
| 1123 | |||
| 1124 | Element Documentation: | ||
| 1125 | |||
| 1126 | |**Name**|**Type**|**Documentation**| | ||
| 1127 | |SentinelValue|SentinelValueType|SentinelValue defines a value that has a special meaning within the text format [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]].| | ||
| 1128 | |||
| 1129 | ***CategorisationBaseType*:** CategorisationBaseType defines the base refinement of the CategorisationType. Its purpose is to retrict the urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 1130 | |||
| 1131 | Derivation: | ||
| 1132 | AnnotableType (extension) | ||
| 1133 | IdentifiableType (extension) | ||
| 1134 | NameableType (extension) | ||
| 1135 | VersionableType (restriction) | ||
| 1136 | MaintainableBaseType (extension) | ||
| 1137 | MaintainableType (restriction) | ||
| 1138 | CategorisationBaseType | ||
| 1139 | |||
| 1140 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1141 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 1142 | |||
| 1143 | Content: | ||
| 1144 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description | ||
| 1145 | |||
| 1146 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1147 | |||
| 1148 | |**Name**|**Type**|**Documentation** | ||
| 1149 | |id|IDType|The id is the identifier for the object. | ||
| 1150 | |urn|CategorisationUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1151 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1152 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1153 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1154 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1155 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1156 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1157 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1158 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1159 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1160 | |||
| 1161 | Element Documentation: | ||
| 1162 | |||
| 1163 | |**Name**|**Type**|**Documentation** | ||
| 1164 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1165 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1166 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1167 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1168 | |||
| 1169 | **CategorisationType:** CategorisationType is defines the structure for a categorisation. A source object is referenced via an object reference and the target [[category>>doc:sdmx:Glossary.Category.WebHome]] is referenced via the target [[category>>doc:sdmx:Glossary.Category.WebHome]]. | ||
| 1170 | |||
| 1171 | Derivation: | ||
| 1172 | AnnotableType (extension) | ||
| 1173 | IdentifiableType (extension) | ||
| 1174 | NameableType (extension) | ||
| 1175 | VersionableType (restriction) | ||
| 1176 | MaintainableBaseType (extension) | ||
| 1177 | MaintainableType (restriction) | ||
| 1178 | CategorisationBaseType (extension) | ||
| 1179 | CategorisationType | ||
| 1180 | |||
| 1181 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1182 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 1183 | |||
| 1184 | Content: | ||
| 1185 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, (Source, Target)? | ||
| 1186 | |||
| 1187 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1188 | |||
| 1189 | |**Name**|**Type**|**Documentation** | ||
| 1190 | |id|IDType|The id is the identifier for the object. | ||
| 1191 | |urn|CategorisationUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1192 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1193 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1194 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1195 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1196 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1197 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1198 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1199 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1200 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1201 | |||
| 1202 | Element Documentation: | ||
| 1203 | |||
| 1204 | |**Name**|**Type**|**Documentation** | ||
| 1205 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1206 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1207 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1208 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1209 | |Source|UrnReferenceType|Source is a reference to an object to be categorized. | ||
| 1210 | |Target|CategoryReferenceType|Target is reference to the [[category>>doc:sdmx:Glossary.Category.WebHome]] that the referenced object is to be (% style="color:#e74c3c" %)mapped(%%) to. | ||
| 1211 | |||
| 1212 | **CategorySchemeType:** CategorySchemeType describes the structure of a [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]. A [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] is the descriptive information for an arrangement or division of [[categories>>doc:sdmx:Glossary.Category.WebHome]] into groups based on characteristics, which the objects have in common. This provides for a simple, (% style="color:#e74c3c" %)leveled(%%) [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] or [[categories>>doc:sdmx:Glossary.Category.WebHome]]. | ||
| 1213 | |||
| 1214 | Derivation: | ||
| 1215 | AnnotableType (extension) | ||
| 1216 | IdentifiableType (extension) | ||
| 1217 | NameableType (extension) | ||
| 1218 | VersionableType (restriction) | ||
| 1219 | MaintainableBaseType (extension) | ||
| 1220 | MaintainableType (restriction) | ||
| 1221 | ItemSchemeType (restriction) | ||
| 1222 | CategorySchemeType | ||
| 1223 | |||
| 1224 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1225 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 1226 | |||
| 1227 | Content: | ||
| 1228 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, [[Category>>doc:sdmx:Glossary.Category.WebHome]] | ||
| 1229 | |||
| 1230 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1231 | |||
| 1232 | |**Name**|**Type**|**Documentation** | ||
| 1233 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 1234 | |urn|CategorySchemeUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1235 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1236 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1237 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1238 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1239 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1240 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1241 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1242 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1243 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1244 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is being communicated. This is used in cases where a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is returned for a data structure in the context of a constraint. | ||
| 1245 | |||
| 1246 | Element Documentation: | ||
| 1247 | |||
| 1248 | |**Name**|**Type**|**Documentation** | ||
| 1249 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1250 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1251 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1252 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1253 | |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|CategoryType|[[Category>>doc:sdmx:Glossary.Category.WebHome]] represents a set of nested [[categories>>doc:sdmx:Glossary.Category.WebHome]] which describe a simple classification [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. | ||
| 1254 | |||
| 1255 | **CategoryType:** CategoryType describes the details of a [[category>>doc:sdmx:Glossary.Category.WebHome]]. A [[category>>doc:sdmx:Glossary.Category.WebHome]] is defined as an item at any (% style="color: rgb(231, 76, 60); color: rgb(231, 76, 60)" %)level(%%) in a classification. The [[Category>>doc:sdmx:Glossary.Category.WebHome]] element represents a set of nested [[categories>>doc:sdmx:Glossary.Category.WebHome]] which are child [[categories>>doc:sdmx:Glossary.Category.WebHome]]. | ||
| 1256 | |||
| 1257 | Derivation: | ||
| 1258 | AnnotableType (extension) | ||
| 1259 | IdentifiableType (extension) | ||
| 1260 | NameableType (restriction) | ||
| 1261 | ItemBaseType (extension) | ||
| 1262 | ItemType (restriction) | ||
| 1263 | CategoryType | ||
| 1264 | |||
| 1265 | Attributes: | ||
| 1266 | id, urn?, uri? | ||
| 1267 | |||
| 1268 | Content: | ||
| 1269 | Annotations?, Link*, Name+, Description*, Category\* | ||
| 1270 | |||
| 1271 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1272 | |||
| 1273 | |**Name**|**Type**|**Documentation** | ||
| 1274 | |id|IDType|The id is the identifier for the object. | ||
| 1275 | |urn|CategoryUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1276 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1277 | |||
| 1278 | Element Documentation: | ||
| 1279 | |||
| 1280 | |**Name**|**Type**|**Documentation** | ||
| 1281 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1282 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1283 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1284 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1285 | |[[Category>>doc:sdmx:Glossary.Category.WebHome]]|CategoryType|[[Category>>doc:sdmx:Glossary.Category.WebHome]] represents a set of nested [[categories>>doc:sdmx:Glossary.Category.WebHome]] which describe a simple classification hierarchy. | ||
| 1286 | |||
| 1287 | //**CodelistBaseType:**// CodelistType defines the structure of a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. A [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is defined as a list from which some statistical (% style="color:#e74c3c" %)concepts(%%) (coded (% style="color:#e74c3c" %)concepts(%%)) take their values. | ||
| 1288 | |||
| 1289 | Derivation: | ||
| 1290 | AnnotableType (extension) | ||
| 1291 | IdentifiableType (extension) | ||
| 1292 | NameableType (extension) | ||
| 1293 | VersionableType (restriction) | ||
| 1294 | MaintainableBaseType (extension) | ||
| 1295 | MaintainableType (restriction) | ||
| 1296 | ItemSchemeType (restriction) | ||
| 1297 | CodelistBaseType | ||
| 1298 | |||
| 1299 | Attributes: | ||
| 1300 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 1301 | |||
| 1302 | Content: | ||
| 1303 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, ([[Code>>doc:sdmx:Glossary.Code.WebHome]]|GeoFeatureSetCode|GeoGridCode) | ||
| 1304 | |||
| 1305 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1306 | |||
| 1307 | |**Name**|**Type**|**Documentation** | ||
| 1308 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the [[code list>>doc:sdmx:Glossary.Code list.WebHome]]. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 1309 | |urn|CodelistUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1310 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1311 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1312 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1313 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1314 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1315 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1316 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1317 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1318 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1319 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is being communicated. This is used in cases where a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is returned for a data structure in the context of a constraint. | ||
| 1320 | |||
| 1321 | Element Documentation: | ||
| 1322 | |||
| 1323 | |**Name**|**Type**|**Documentation** | ||
| 1324 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1325 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1326 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1327 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1328 | |[[Code>>doc:sdmx:Glossary.Code.WebHome]]|CodeType|[[Code>>doc:sdmx:Glossary.Code.WebHome]] describes a [[code>>doc:sdmx:Glossary.Code.WebHome]] in a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. In addition to the identification and description of the [[code>>doc:sdmx:Glossary.Code.WebHome]], basic presentational information is also available. Presentational information not present may be added through the use of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1329 | |||
| 1330 | **CodelistType:** | ||
| 1331 | |||
| 1332 | Derivation: | ||
| 1333 | AnnotableType (extension) | ||
| 1334 | IdentifiableType (extension) | ||
| 1335 | NameableType (extension) | ||
| 1336 | VersionableType (restriction) | ||
| 1337 | MaintainableBaseType (extension) | ||
| 1338 | MaintainableType (restriction) | ||
| 1339 | ItemSchemeType (restriction) | ||
| 1340 | CodelistBaseType (extension) | ||
| 1341 | CodelistType | ||
| 1342 | |||
| 1343 | Attributes: | ||
| 1344 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 1345 | |||
| 1346 | Content: | ||
| 1347 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, ([[Code>>doc:sdmx:Glossary.Code.WebHome]]|GeoFeatureSetCode|GeoGridCode)*, CodelistExtension | ||
| 1348 | |||
| 1349 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1350 | |||
| 1351 | |**Name**|**Type**|**Documentation** | ||
| 1352 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the [[code list>>doc:sdmx:Glossary.Code list.WebHome]]. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 1353 | |urn|CodelistUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1354 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1355 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1356 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1357 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1358 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1359 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1360 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1361 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1362 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1363 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is being communicated. This is used in cases where a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is returned for a data structure in the context of a constraint. | ||
| 1364 | |||
| 1365 | Element Documentation: | ||
| 1366 | |||
| 1367 | |**Name**|**Type**|**Documentation** | ||
| 1368 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1369 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1370 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1371 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1372 | |[[Code>>doc:sdmx:Glossary.Code.WebHome]]|CodeType|[[Code>>doc:sdmx:Glossary.Code.WebHome]] describes a [[code>>doc:sdmx:Glossary.Code.WebHome]] in a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. In addition to the identification and description of the [[code>>doc:sdmx:Glossary.Code.WebHome]], basic presentational information is also available. Presentational information not present may be added through the use of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]].**Substitutions:** GeoFeatureSetCode, GeoGridCode | ||
| 1373 | |CodelistExtension|CodelistExtensionType|CodelistExtension allows for the extension of [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] by referencing the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] to be extended and providing inclusion/exclusion rules for selecting the [[codes>>doc:sdmx:Glossary.Code.WebHome]] to extend. The order of these is important as it is indicates the order of precedence of the extended [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] for conflict resolution of [[codes>>doc:sdmx:Glossary.Code.WebHome]]. However, the prefix property can be used to ensure uniqueness of inherited [[codes>>doc:sdmx:Glossary.Code.WebHome]] in the extending [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], in case conflicting [[codes>>doc:sdmx:Glossary.Code.WebHome]] must be included. | ||
| 1374 | |||
| 1375 | **CodeType:** CodeType describes the structure of a [[code>>doc:sdmx:Glossary.Code.WebHome]]. A [[code>>doc:sdmx:Glossary.Code.WebHome]] is defined as a language independent set of letters, numbers or symbols that represent a (% style="color:#e74c3c" %)concept(%%) whose meaning is described in a natural language. Presentational information not present may be added through the use of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. | ||
| 1376 | |||
| 1377 | Derivation: | ||
| 1378 | AnnotableType (extension) | ||
| 1379 | IdentifiableType (extension) | ||
| 1380 | NameableType (restriction) | ||
| 1381 | ItemBaseType (extension) | ||
| 1382 | ItemType (restriction) | ||
| 1383 | CodeType | ||
| 1384 | |||
| 1385 | Attributes: | ||
| 1386 | id, urn?, uri? | ||
| 1387 | |||
| 1388 | Content: | ||
| 1389 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, Parent? | ||
| 1390 | |||
| 1391 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1392 | |||
| 1393 | |**Name**|**Type**|**Documentation** | ||
| 1394 | |id|IDType|The id is the identifier for the object. | ||
| 1395 | |urn|CodeUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1396 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1397 | |||
| 1398 | Element Documentation: | ||
| 1399 | |||
| 1400 | |**Name**|**Type**|**Documentation** | ||
| 1401 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1402 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1403 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description. | ||
| 1404 | |Description|TextType|Description provides a plain text, human-readable description of the [[code>>doc:sdmx:Glossary.Code.WebHome]]. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1405 | |Parent|SingleNCNameIDType|Parent provides the ability to describe simple [[hierarchies>>doc:sdmx:Glossary.Hierarchy.WebHome]] within a single [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], by referencing the id value of another [[code>>doc:sdmx:Glossary.Code.WebHome]] in the same [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 1406 | |||
| 1407 | **CodelistExtensionType:** CodelistExtensionType defines the structure of a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] to be extended by the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] defining the extension. It provides a reference to the extended [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] and selection criteria to indicate the [[codes>>doc:sdmx:Glossary.Code.WebHome]] to be included in the extending [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 1408 | |||
| 1409 | Attributes: | ||
| 1410 | prefix? | ||
| 1411 | |||
| 1412 | Content: | ||
| 1413 | [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]], (InclusiveCodeSelection|ExclusiveCodeSelection)? | ||
| 1414 | |||
| 1415 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1416 | |||
| 1417 | |**Name**|**Type**|**Documentation** | ||
| 1418 | |prefix|xs:string|A reference to a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] may contain a prefix. If a prefix is provided, this prefix will be applied to all the [[codes>>doc:sdmx:Glossary.Code.WebHome]] in the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] before they are imported into the extended [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 1419 | |||
| 1420 | Element Documentation: | ||
| 1421 | |||
| 1422 | |**Name**|**Type**|**Documentation** | ||
| 1423 | |[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]|CodelistReferenceType| | ||
| 1424 | |InclusiveCodeSelection|CodeSelectionType|Selection of [[codes>>doc:sdmx:Glossary.Code.WebHome]] from the referenced (extended) [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] to be included in the extending [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 1425 | |ExclusiveCodeSelection|CodeSelectionType|Selection of [[codes>>doc:sdmx:Glossary.Code.WebHome]] from the referenced (extended) [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] to be excluded in the extending [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 1426 | |||
| 1427 | **CodeSelectionType:** CodeSelectionType defines the structure for [[code>>doc:sdmx:Glossary.Code.WebHome]] selection to be used as inclusive or exclusive extensions. | ||
| 1428 | |||
| 1429 | Content: | ||
| 1430 | MemberValue+ | ||
| 1431 | |||
| 1432 | Element Documentation: | ||
| 1433 | |||
| 1434 | |**Name**|**Type**|**Documentation** | ||
| 1435 | |MemberValue|MemberValueType|An explicit or wildcard selection of a [[code>>doc:sdmx:Glossary.Code.WebHome]](s) from the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] selected for inclusion/exclusion. If a wildcard expression is used, it is evaluated to determine [[codes>>doc:sdmx:Glossary.Code.WebHome]] selected for inclusion/exclusion. Otherwise, each [[member value>>doc:sdmx:Glossary.Member value.WebHome]] is a distinct [[code>>doc:sdmx:Glossary.Code.WebHome]]. If the extended list is hierarchical, this can indicate whether child [[codes>>doc:sdmx:Glossary.Code.WebHome]] are to be included. | ||
| 1436 | |||
| 1437 | **MemberValueType:** Allows for a ditinct reference or a wildcard expression for selecting [[codes>>doc:sdmx:Glossary.Code.WebHome]] from a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 1438 | |||
| 1439 | Derivation: | ||
| 1440 | |||
| 1441 | xs:anySimpleType (restriction) | ||
| 1442 | xs:string (restriction) | ||
| 1443 | WildcardedMemberValueType (extension) | ||
| 1444 | MemberValueType | ||
| 1445 | |||
| 1446 | Attributes: | ||
| 1447 | cascadeValues? | ||
| 1448 | |||
| 1449 | Content: | ||
| 1450 | |||
| 1451 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1452 | |||
| 1453 | |**Name**|**Type**|**Documentation** | ||
| 1454 | |cascadeValues|CascadeSelectionType|Indicates whether child [[codes>>doc:sdmx:Glossary.Code.WebHome]] should be selected when the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is hierarchical. Possible values are true (include the selected and child [[codes>>doc:sdmx:Glossary.Code.WebHome]]), false (only include the selected [[code>>doc:sdmx:Glossary.Code.WebHome]](s)), and excluderoot (include the children but not the selected [[code>>doc:sdmx:Glossary.Code.WebHome]](s)). | ||
| 1455 | |||
| 1456 | ***GeoCodelistBaseType*:** GeoCodelistBaseType is an abstract base refinement of a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] that restricts the cods to be derived from the abstract GeoRefCode. | ||
| 1457 | |||
| 1458 | Derivation: | ||
| 1459 | AnnotableType (extension) | ||
| 1460 | IdentifiableType (extension) | ||
| 1461 | NameableType (extension) | ||
| 1462 | VersionableType (restriction) | ||
| 1463 | MaintainableBaseType (extension) | ||
| 1464 | MaintainableType (restriction) | ||
| 1465 | ItemSchemeType (restriction) | ||
| 1466 | CodelistBaseType (extension) | ||
| 1467 | CodelistType (restriction) | ||
| 1468 | GeoCodelistBaseType | ||
| 1469 | |||
| 1470 | Attributes: | ||
| 1471 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 1472 | |||
| 1473 | Content: | ||
| 1474 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, GeoRefCode, CodelistExtension | ||
| 1475 | |||
| 1476 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1477 | |||
| 1478 | |**Name**|**Type**|**Documentation** | ||
| 1479 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the [[code list>>doc:sdmx:Glossary.Code list.WebHome]]. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 1480 | |urn|CodelistUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1481 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1482 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1483 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1484 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1485 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1486 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1487 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1488 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1489 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1490 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is being communicated. This is used in cases where a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is returned for a data structure in the context of a constraint. | ||
| 1491 | |||
| 1492 | Element Documentation: | ||
| 1493 | |||
| 1494 | |**Name**|**Type**|**Documentation** | ||
| 1495 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1496 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1497 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1498 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1499 | |*GeoRefCode*|*GeoRefCodeType*|GeoRefCode is the abstract base from which specific types of geographic [[codes>>doc:sdmx:Glossary.Code.WebHome]] will be derived. | ||
| 1500 | |CodelistExtension|CodelistExtensionType|CodelistExtension allows for the extension of [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] by referencing the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] to be extended and providing inclusion/exclusion rules for selecting the [[codes>>doc:sdmx:Glossary.Code.WebHome]] to extend. The order of these is important as it is indicates the order of precedence of the extended [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] for conflict resolution of [[codes>>doc:sdmx:Glossary.Code.WebHome]]. However, the prefix property can be used to ensure uniqueness of inherited [[codes>>doc:sdmx:Glossary.Code.WebHome]] in the extending [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], in case conflicting [[codes>>doc:sdmx:Glossary.Code.WebHome]] must be included. | ||
| 1501 | |||
| 1502 | ***GeoCodelistType*:** GeoCodelistType is an abstract refinement of a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] from which specific types of geographic [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] will be derived. | ||
| 1503 | |||
| 1504 | Derivation: | ||
| 1505 | AnnotableType (extension) | ||
| 1506 | IdentifiableType (extension) | ||
| 1507 | NameableType (extension) | ||
| 1508 | VersionableType (restriction) | ||
| 1509 | MaintainableBaseType (extension) | ||
| 1510 | MaintainableType (restriction) | ||
| 1511 | ItemSchemeType (restriction) | ||
| 1512 | CodelistBaseType (extension) | ||
| 1513 | CodelistType (restriction) | ||
| 1514 | GeoCodelistBaseType (extension) | ||
| 1515 | GeoCodelistType | ||
| 1516 | |||
| 1517 | Attributes: | ||
| 1518 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial?, geoType | ||
| 1519 | |||
| 1520 | Content: | ||
| 1521 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, GeoRefCode, CodelistExtension | ||
| 1522 | |||
| 1523 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1524 | |||
| 1525 | |**Name**|**Type**|**Documentation**| | ||
| 1526 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the [[code list>>doc:sdmx:Glossary.Code list.WebHome]]. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 1527 | |urn|CodelistUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | ||
| 1528 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | ||
| 1529 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned.| | ||
| 1530 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 1531 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 1532 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object.| | ||
| 1533 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 1534 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface.| | ||
| 1535 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object.| | ||
| 1536 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 1537 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is being communicated. This is used in cases where a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is returned for a data structure in the context of a (% style="color:#e74c3c" %)constraint(%%).| | ||
| 1538 | |geoType|GeoCodelistTypeType|The type of geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. The will be refined and provided a fixed value in the specific geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] type implementations.| | ||
| 1539 | |||
| 1540 | Element Documentation: | ||
| 1541 | |||
| 1542 | |**Name**|**Type**|**Documentation**| | ||
| 1543 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 1544 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 1545 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 1546 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 1547 | |//GeoRefCode//|//GeoRefCodeType//|GeoRefCode is the abstract base from which specific types of geographic [[codes>>doc:sdmx:Glossary.Code.WebHome]] will be derived.| | ||
| 1548 | |CodelistExtension|CodelistExtensionType|CodelistExtension allows for the extension of [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] by referencing the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] to be extended and providing inclusion/exclusion rules for selecting the [[codes>>doc:sdmx:Glossary.Code.WebHome]] to extend. The order of these is important as it is indicates the order of precedence of the extended [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] for conflict resolution of [[codes>>doc:sdmx:Glossary.Code.WebHome]]. However, the prefix property can be used to ensure uniqueness of inherited [[codes>>doc:sdmx:Glossary.Code.WebHome]] in the extending [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], in case conflicting [[codes>>doc:sdmx:Glossary.Code.WebHome]] must be included.| | ||
| 1549 | |||
| 1550 | **GeoRefCodeType:** GeoRefCodeType is the abstract base type defining the structure of geographic [[codes>>doc:sdmx:Glossary.Code.WebHome]]. | ||
| 1551 | |||
| 1552 | Derivation: | ||
| 1553 | AnnotableType (extension) | ||
| 1554 | IdentifiableType (extension) | ||
| 1555 | NameableType (restriction) | ||
| 1556 | ItemBaseType (extension) | ||
| 1557 | ItemType (restriction) | ||
| 1558 | CodeType (extension) | ||
| 1559 | GeoRefCodeType | ||
| 1560 | |||
| 1561 | Attributes: | ||
| 1562 | id, urn?, uri? | ||
| 1563 | |||
| 1564 | Content: | ||
| 1565 | Annotations?, Link*, Name+, Description*, Parent? | ||
| 1566 | |||
| 1567 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1568 | |||
| 1569 | |**Name**|**Type**|**Documentation**| | ||
| 1570 | |id|IDType|The id is the identifier for the object.| | ||
| 1571 | |urn|CodeUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | ||
| 1572 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | ||
| 1573 | |||
| 1574 | Element Documentation: | ||
| 1575 | |||
| 1576 | |**Name**|**Type**|**Documentation** | ||
| 1577 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1578 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1579 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description. | ||
| 1580 | |Description|TextType|Description provides a plain text, human-readable description of the [[code>>doc:sdmx:Glossary.Code.WebHome]]. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1581 | |Parent|SingleNCNameIDType|Parent provides the ability to describe simple [[hierarchies>>doc:sdmx:Glossary.Hierarchy.WebHome]] within a single [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], by referencing the id value of another [[code>>doc:sdmx:Glossary.Code.WebHome]] in the same [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 1582 | |||
| 1583 | **GeographicCodelistType:** GeographicCodelistType defines the sturcture of a geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. It comprises a set of GeoFeatureSetCodes, by adding a value in the [[Code>>doc:sdmx:Glossary.Code.WebHome]] that follows a pattern to represent a geo feature set. | ||
| 1584 | |||
| 1585 | Derivation: | ||
| 1586 | AnnotableType (extension) | ||
| 1587 | IdentifiableType (extension) | ||
| 1588 | NameableType (extension) | ||
| 1589 | VersionableType (restriction) | ||
| 1590 | MaintainableBaseType (extension) | ||
| 1591 | MaintainableType (restriction) | ||
| 1592 | ItemSchemeType (restriction) | ||
| 1593 | CodelistBaseType (extension) | ||
| 1594 | CodelistType (restriction) | ||
| 1595 | GeoCodelistBaseType (extension) | ||
| 1596 | GeoCodelistType (restriction) | ||
| 1597 | GeographicCodelistType | ||
| 1598 | |||
| 1599 | Attributes: | ||
| 1600 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType | ||
| 1601 | |||
| 1602 | Content: | ||
| 1603 | Annotations?, Link*, Name+, Description*, GeoFeatureSetCode\*, CodelistExtension | ||
| 1604 | |||
| 1605 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1606 | |||
| 1607 | |**Name**|**Type**|**Documentation** | ||
| 1608 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the [[code list>>doc:sdmx:Glossary.Code list.WebHome]]. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 1609 | |urn|CodelistUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1610 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1611 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1612 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1613 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1614 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1615 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1616 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1617 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1618 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1619 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is being communicated. This is used in cases where a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is returned for a data structure in the context of a constraint. | ||
| 1620 | |geoType (fixed: GeographicCodelist)|GeoCodelistTypeType|The type of geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. The will be refined and provided a fixed value in the specific geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] type implementations. | ||
| 1621 | |||
| 1622 | Element Documentation: | ||
| 1623 | |||
| 1624 | |**Name**|**Type**|**Documentation** | ||
| 1625 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1626 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1627 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1628 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1629 | |GeoFeatureSetCode|GeoFeatureSetCodeType|Is a geographic [[code>>doc:sdmx:Glossary.Code.WebHome]] in a geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. It adds a value to a [[code>>doc:sdmx:Glossary.Code.WebHome]] that folows a pattern to represent a geo feature set. | ||
| 1630 | |CodelistExtension|CodelistExtensionType|CodelistExtension allows for the extension of [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] by referencing the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] to be extended and providing inclusion/exclusion rules for selecting the [[codes>>doc:sdmx:Glossary.Code.WebHome]] to extend. The order of these is important as it is indicates the order of precedence of the extended [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] for conflict resolution of [[codes>>doc:sdmx:Glossary.Code.WebHome]]. However, the prefix property can be used to ensure uniqueness of inherited [[codes>>doc:sdmx:Glossary.Code.WebHome]] in the extending [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], in case conflicting [[codes>>doc:sdmx:Glossary.Code.WebHome]] must be included. | ||
| 1631 | |||
| 1632 | **GeoFeatureSetCodeType:** GeoFeatureSetCodeType defines the structure of a geogrphic [[code>>doc:sdmx:Glossary.Code.WebHome]]. | ||
| 1633 | |||
| 1634 | Derivation: | ||
| 1635 | AnnotableType (extension) | ||
| 1636 | IdentifiableType (extension) | ||
| 1637 | NameableType (restriction) | ||
| 1638 | ItemBaseType (extension) | ||
| 1639 | ItemType (restriction) | ||
| 1640 | CodeType (extension) | ||
| 1641 | GeoRefCodeType (extension) | ||
| 1642 | GeoFeatureSetCodeType | ||
| 1643 | |||
| 1644 | Attributes: | ||
| 1645 | id, urn?, uri?, value | ||
| 1646 | |||
| 1647 | Content: | ||
| 1648 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, Parent? | ||
| 1649 | |||
| 1650 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1651 | |||
| 1652 | |**Name**|**Type**|**Documentation** | ||
| 1653 | |id|IDType|The id is the identifier for the object. | ||
| 1654 | |urn|CodeUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1655 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1656 | |value|xs:string|The geo feature set of the [[Code>>doc:sdmx:Glossary.Code.WebHome]], which represents a set of points defining a feature in a format defined a predefined pattern (see section 6). | ||
| 1657 | |||
| 1658 | Element Documentation: | ||
| 1659 | |||
| 1660 | |**Name**|**Type**|**Documentation**| | | ||
| 1661 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | | ||
| 1662 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | | ||
| 1663 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description.| | | ||
| 1664 | |Description|TextType|Description provides a plain text, human-readable description of the [[code>>doc:sdmx:Glossary.Code.WebHome]]. This may be provided in multiple, parallel language-equivalent forms.| | | ||
| 1665 | |Parent|SingleNCNameIDType|Parent provides the ability to describe simple [[hierarchies>>doc:sdmx:Glossary.Hierarchy.WebHome]] within a single [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], by referencing the id value of another [[code>>doc:sdmx:Glossary.Code.WebHome]] in the same [[codelist>>doc:sdmx:Glossary.Code list.WebHome]].| | | ||
| 1666 | |||
| 1667 | //**GeoGridCodelistBaseType:**// GeoGridCodelistBaseType is the abstract base refinement for a geographic grid [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 1668 | |||
| 1669 | Derivation: | ||
| 1670 | AnnotableType (extension) | ||
| 1671 | IdentifiableType (extension) | ||
| 1672 | NameableType (extension) | ||
| 1673 | VersionableType (restriction) | ||
| 1674 | MaintainableBaseType (extension) | ||
| 1675 | MaintainableType (restriction) | ||
| 1676 | ItemSchemeType (restriction) | ||
| 1677 | CodelistBaseType (extension) | ||
| 1678 | CodelistType (restriction) | ||
| 1679 | GeoCodelistBaseType (extension) | ||
| 1680 | GeoCodelistType (restriction) | ||
| 1681 | GeoGridCodelistBaseType | ||
| 1682 | |||
| 1683 | Attributes: | ||
| 1684 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial?, geoType | ||
| 1685 | |||
| 1686 | Content: | ||
| 1687 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, GeoGridCode*, CodelistExtension | ||
| 1688 | |||
| 1689 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1690 | |||
| 1691 | |**Name**|**Type**|**Documentation** | ||
| 1692 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the [[code list>>doc:sdmx:Glossary.Code list.WebHome]]. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 1693 | |urn|CodelistUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1694 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1695 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1696 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1697 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1698 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1699 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1700 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1701 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1702 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1703 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is being communicated. This is used in cases where a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is returned for a data structure in the context of a constraint. | ||
| 1704 | |geoType (fixed: GeoGridCodelist)|GeoCodelistTypeType|The type of geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. The will be refined and provided a fixed value in the specific geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] type implementations. | ||
| 1705 | |||
| 1706 | Element Documentation: | ||
| 1707 | |||
| 1708 | |**Name**|**Type**|**Documentation**| | ||
| 1709 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 1710 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 1711 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 1712 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 1713 | |GeoGridCode|GeoGridCodeType|GeoGridCode is a [[code>>doc:sdmx:Glossary.Code.WebHome]] the represents a geographic grid cell that belongs to a specific grid definition.| | ||
| 1714 | |CodelistExtension|CodelistExtensionType|CodelistExtension allows for the extension of [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] by referencing the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] to be extended and providing inclusion/exclusion rules for selecting the [[codes>>doc:sdmx:Glossary.Code.WebHome]] to extend. The order of these is important as it is indicates the order of precedence of the extended [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] for conflict resolution of [[codes>>doc:sdmx:Glossary.Code.WebHome]]. However, the prefix property can be used to ensure uniqueness of inherited [[codes>>doc:sdmx:Glossary.Code.WebHome]] in the extending [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], in case conflicting [[codes>>doc:sdmx:Glossary.Code.WebHome]] must be included.| | ||
| 1715 | |||
| 1716 | **GeoGridCodelistType:** GeoGridCodelistType defines the structure of a geographic grid [[code list>>doc:sdmx:Glossary.Code list.WebHome]]. These define a geographical grid composed of cells representing regular squared portions of the Earth. | ||
| 1717 | |||
| 1718 | Derivation: | ||
| 1719 | AnnotableType (extension) | ||
| 1720 | IdentifiableType (extension) | ||
| 1721 | NameableType (extension) | ||
| 1722 | VersionableType (restriction) | ||
| 1723 | MaintainableBaseType (extension) | ||
| 1724 | MaintainableType (restriction) | ||
| 1725 | ItemSchemeType (restriction) | ||
| 1726 | CodelistBaseType (extension) | ||
| 1727 | CodelistType (restriction) | ||
| 1728 | GeoCodelistBaseType (extension) | ||
| 1729 | GeoCodelistType (restriction) | ||
| 1730 | GeoGridCodelistBaseType (extension) | ||
| 1731 | GeoGridCodelistType | ||
| 1732 | |||
| 1733 | Attributes: | ||
| 1734 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial?, geoType | ||
| 1735 | |||
| 1736 | Content: | ||
| 1737 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, GeoGridCode*, CodelistExtension*, GridDefinition | ||
| 1738 | |||
| 1739 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1740 | |||
| 1741 | |**Name**|**Type**|**Documentation** | ||
| 1742 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the [[code list>>doc:sdmx:Glossary.Code list.WebHome]]. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 1743 | |urn|CodelistUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1744 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1745 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1746 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1747 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1748 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1749 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1750 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1751 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1752 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1753 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is being communicated. This is used in cases where a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is returned for a data structure in the context of a constraint. | ||
| 1754 | |geoType (fixed: GeoGridCodelist)|GeoCodelistTypeType|The type of geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. The will be refined and provided a fixed value in the specific geographic [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] type implementations. | ||
| 1755 | |||
| 1756 | Element Documentation: | ||
| 1757 | |||
| 1758 | |**Name**|**Type**|**Documentation** | ||
| 1759 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1760 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1761 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1762 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1763 | |GeoGridCode|GeoGridCodeType|GeoGridCode is a [[code>>doc:sdmx:Glossary.Code.WebHome]] the represents a geographic grid cell that belongs to a specific grid definition. | ||
| 1764 | |CodelistExtension|CodelistExtensionType|CodelistExtension allows for the extension of [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] by referencing the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] to be extended and providing inclusion/exclusion rules for selecting the [[codes>>doc:sdmx:Glossary.Code.WebHome]] to extend. The order of these is important as it is indicates the order of precedence of the extended [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] for conflict resolution of [[codes>>doc:sdmx:Glossary.Code.WebHome]]. However, the prefix property can be used to ensure uniqueness of inherited [[codes>>doc:sdmx:Glossary.Code.WebHome]] in the extending [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], in case conflicting [[codes>>doc:sdmx:Glossary.Code.WebHome]] must be included. | ||
| 1765 | |GridDefinition|xs:string|Contains a regular expression string corresponding to the grid definition for the GeoGrid [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 1766 | |||
| 1767 | **GeoGridCodeType:** GeoGridCodeType defines the structure of a geographic grid cell. | ||
| 1768 | |||
| 1769 | Derivation: | ||
| 1770 | AnnotableType (extension) | ||
| 1771 | IdentifiableType (extension) | ||
| 1772 | NameableType (restriction) | ||
| 1773 | ItemBaseType (extension) | ||
| 1774 | ItemType (restriction) | ||
| 1775 | CodeType (extension) | ||
| 1776 | GeoRefCodeType (extension) | ||
| 1777 | GeoGridCodeType | ||
| 1778 | |||
| 1779 | Attributes: | ||
| 1780 | id, urn?, uri? | ||
| 1781 | |||
| 1782 | Content: | ||
| 1783 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, Parent?, GeoCell | ||
| 1784 | |||
| 1785 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1786 | |||
| 1787 | |**Name**|**Type**|**Documentation**| | | ||
| 1788 | |id|IDType|The id is the identifier for the object.| | | ||
| 1789 | |urn|CodeUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | | ||
| 1790 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | | ||
| 1791 | |||
| 1792 | Element Documentation: | ||
| 1793 | |||
| 1794 | |**Name**|**Type**|**Documentation** | ||
| 1795 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1796 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1797 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description. | ||
| 1798 | |Description|TextType|Description provides a plain text, human-readable description of the [[code>>doc:sdmx:Glossary.Code.WebHome]]. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1799 | |Parent|SingleNCNameIDType|Parent provides the ability to describe simple [[hierarchies>>doc:sdmx:Glossary.Hierarchy.WebHome]] within a single [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], by referencing the id value of another [[code>>doc:sdmx:Glossary.Code.WebHome]] in the same [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 1800 | |GeoCell|xs:string|The value used to assign the [[Code>>doc:sdmx:Glossary.Code.WebHome]] to one cell in the grid. | ||
| 1801 | |||
| 1802 | ***ValueListBaseType*:** ValueListBaseType defines the base refinement of the ValueListType. Its purpose is to retrict the urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 1803 | |||
| 1804 | Derivation: | ||
| 1805 | AnnotableType (extension) | ||
| 1806 | IdentifiableType (extension) | ||
| 1807 | NameableType (extension) | ||
| 1808 | VersionableType (restriction) | ||
| 1809 | MaintainableBaseType (extension) | ||
| 1810 | MaintainableType (restriction) | ||
| 1811 | ValueListBaseType | ||
| 1812 | |||
| 1813 | Attributes: | ||
| 1814 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 1815 | |||
| 1816 | Content: | ||
| 1817 | |||
| 1818 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description | ||
| 1819 | |||
| 1820 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1821 | |||
| 1822 | |**Name**|**Type**|**Documentation** | ||
| 1823 | |id|IDType|The id is the identifier for the object. | ||
| 1824 | |urn|ValueListUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1825 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1826 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1827 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1828 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1829 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1830 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1831 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1832 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1833 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1834 | |||
| 1835 | Element Documentation: | ||
| 1836 | |||
| 1837 | |**Name**|**Type**|**Documentation** | ||
| 1838 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1839 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1840 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1841 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1842 | |||
| 1843 | **ValueListType:** ValueListType defines the structure of value list. These represent a closed set of values the can occur for a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], [[measure>>doc:sdmx:Glossary.Measure.WebHome]], or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. These may be values, or values with names and descriptions (similar to a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]). | ||
| 1844 | |||
| 1845 | Derivation: | ||
| 1846 | AnnotableType (extension) | ||
| 1847 | IdentifiableType (extension) | ||
| 1848 | NameableType (extension) | ||
| 1849 | VersionableType (restriction) | ||
| 1850 | MaintainableBaseType (extension) | ||
| 1851 | MaintainableType (restriction) | ||
| 1852 | ValueListBaseType (extension) | ||
| 1853 | ValueListType | ||
| 1854 | |||
| 1855 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1856 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 1857 | |||
| 1858 | Content: | ||
| 1859 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, ValueItem | ||
| 1860 | |||
| 1861 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1862 | |||
| 1863 | |**Name**|**Type**|**Documentation** | ||
| 1864 | |id|IDType|The id is the identifier for the object. | ||
| 1865 | |urn|ValueListUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1866 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1867 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1868 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1869 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1870 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1871 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1872 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1873 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1874 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1875 | |||
| 1876 | Element Documentation: | ||
| 1877 | |||
| 1878 | |**Name**|**Type**|**Documentation** | ||
| 1879 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1880 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1881 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1882 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1883 | |ValueItem|ValueItemType| | ||
| 1884 | |||
| 1885 | **ValueItemType:** ValueItemType defines the structure of a value item. A value must be provided, and a longer name and description can be provided to provide additiona meaning to the value (similar to a [[code>>doc:sdmx:Glossary.Code.WebHome]] in a [[code>>doc:sdmx:Glossary.Code.WebHome]] list). | ||
| 1886 | |||
| 1887 | Derivation: | ||
| 1888 | AnnotableType (extension) | ||
| 1889 | ValueItemType | ||
| 1890 | |||
| 1891 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1892 | id | ||
| 1893 | |||
| 1894 | Content: | ||
| 1895 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Name*, Description | ||
| 1896 | |||
| 1897 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1898 | |||
| 1899 | |**Name**|**Type**|**Documentation** | ||
| 1900 | |id|xs:string| | ||
| 1901 | |||
| 1902 | Element Documentation: | ||
| 1903 | |||
| 1904 | |**Name**|**Type**|**Documentation** | ||
| 1905 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1906 | |Name|TextType|Name is a reusable element, used for providing a human-readable name for an object. | ||
| 1907 | |Description|TextType|Description is a reusable element, used for providing a longer human-readable description of an object. | ||
| 1908 | |||
| 1909 | **ConceptSchemeType:** ConceptSchemeType describes the structure of a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]. A [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] is the descriptive information for an arrangement or division of (% style="color:#e74c3c" %)concepts(%%) into groups based on characteristics, which the objects have in common. It contains a collection of (% style="color:#e74c3c" %)concept(%%) definitions, that may be arranged in simple hierarchies. | ||
| 1910 | |||
| 1911 | Derivation: | ||
| 1912 | AnnotableType (extension) | ||
| 1913 | IdentifiableType (extension) | ||
| 1914 | NameableType (extension) | ||
| 1915 | VersionableType (restriction) | ||
| 1916 | MaintainableBaseType (extension) | ||
| 1917 | MaintainableType (restriction) | ||
| 1918 | ItemSchemeType (restriction) | ||
| 1919 | ConceptSchemeType | ||
| 1920 | |||
| 1921 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1922 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 1923 | |||
| 1924 | Content: | ||
| 1925 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, (% style="color:#e74c3c" %)Concept | ||
| 1926 | |||
| 1927 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1928 | |||
| 1929 | |**Name**|**Type**|**Documentation** | ||
| 1930 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 1931 | |urn|ConceptSchemeUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 1932 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 1933 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 1934 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1935 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 1936 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1937 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 1938 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 1939 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 1940 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 1941 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] is being communicated. This is used in cases where a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] is returned for a data structure in the context of a (% style="color:#e74c3c" %)constraint(%%). | ||
| 1942 | |||
| 1943 | Element Documentation: | ||
| 1944 | |||
| 1945 | |**Name**|**Type**|**Documentation** | ||
| 1946 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 1947 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 1948 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1949 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1950 | |(%%)(% style="color:#e74c3c" %)Concept|ConceptType|(%%)(% style="color:#e74c3c" %)Concept(%%) describes the details of a (% style="color:#e74c3c" %)concept(%%) within a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]. | ||
| 1951 | |||
| 1952 | **ConceptBaseType:** ConceptBaseType is an abstract base type the forms the basis of the ConceptType by requiring a name and id, and restricting the content of the id. | ||
| 1953 | |||
| 1954 | Derivation: | ||
| 1955 | AnnotableType (extension) | ||
| 1956 | IdentifiableType (extension) | ||
| 1957 | NameableType (restriction) | ||
| 1958 | ItemBaseType (extension) | ||
| 1959 | ItemType (restriction) | ||
| 1960 | ConceptBaseType | ||
| 1961 | |||
| 1962 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1963 | id, urn?, uri? | ||
| 1964 | |||
| 1965 | Content: | ||
| 1966 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, Parent? | ||
| 1967 | |||
| 1968 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1969 | |||
| 1970 | |**Name**|**Type**|**Documentation**| | ||
| 1971 | |id|NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the (% style="color:#e74c3c" %)concept(%%). The type of this id is restricted to the common:NCNNameIDType. This is necessary, since (% style="color:#e74c3c" %)concept(%%) id may be used to create XML elements and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 1972 | |urn|ConceptUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | ||
| 1973 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | ||
| 1974 | |||
| 1975 | Element Documentation: | ||
| 1976 | |||
| 1977 | |**Name**|**Type**|**Documentation**| | ||
| 1978 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 1979 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 1980 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 1981 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 1982 | |Parent|SingleNCNameIDType|Parent captures the semantic relationships between (% style="color:#e74c3c" %)concepts(%%) which occur within a single [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]. This identifies the (% style="color:#e74c3c" %)concept(%%) of which the current (% style="color:#e74c3c" %)concept(%%) is a qualification (in the ISO 11179 sense) or subclass.| | ||
| 1983 | |||
| 1984 | **ConceptType:** ConceptType describes the details of a (% style="color:#e74c3c" %)concept(%%). A (% style="color:#e74c3c" %)concept(%%) is defined as a unit of knowledge created by a unique combination of characteristics. If a (% style="color:#e74c3c" %)concept(%%) does not specify a TextFormat or a core [[representation>>doc:sdmx:Glossary.Representation.WebHome]], then the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)concept(%%) is assumed to be represented by any set of valid characters (corresponding to the xs:string datatype of W3C XML Schema). | ||
| 1985 | |||
| 1986 | Derivation: | ||
| 1987 | AnnotableType (extension) | ||
| 1988 | IdentifiableType (extension) | ||
| 1989 | NameableType (restriction) | ||
| 1990 | ItemBaseType (extension) | ||
| 1991 | ItemType (restriction) | ||
| 1992 | ConceptBaseType (extension) | ||
| 1993 | ConceptType | ||
| 1994 | |||
| 1995 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1996 | id, urn?, uri? | ||
| 1997 | |||
| 1998 | Content: | ||
| 1999 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, Parent?, CoreRepresentation?, ISOConceptReference? | ||
| 2000 | |||
| 2001 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2002 | |||
| 2003 | |**Name**|**Type**|**Documentation**| | ||
| 2004 | |urn|ConceptUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | ||
| 2005 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | ||
| 2006 | |||
| 2007 | Element Documentation: | ||
| 2008 | |||
| 2009 | |**Name**|**Type**|**Documentation** | ||
| 2010 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 2011 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 2012 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2013 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2014 | |Parent|SingleNCNameIDType|Parent captures the semantic relationships between (% style="color:#e74c3c" %)concepts(%%) which occur within a single [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]. This identifies the (% style="color:#e74c3c" %)concept(%%) of which the current (% style="color:#e74c3c" %)concept(%%) is a qualification (in the ISO 11179 sense) or subclass. | ||
| 2015 | |CoreRepresentation|ConceptRepresentation| | ||
| 2016 | |ISOConceptReference|ISOConceptReferenceType|Provides a reference to an ISO 11179 (% style="color:#e74c3c" %)concept(%%). | ||
| 2017 | |||
| 2018 | **ConceptRepresentation:** ConceptRepresentation defines the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] that are allowed for a (% style="color:#e74c3c" %)concept(%%). The text format allowed for a (% style="color:#e74c3c" %)concept(%%) is that which is allowed for any non-target object component. | ||
| 2019 | |||
| 2020 | Derivation: | ||
| 2021 | RepresentationType (restriction) | ||
| 2022 | ConceptRepresentation | ||
| 2023 | |||
| 2024 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2025 | minOccurs?, maxOccurs? | ||
| 2026 | |||
| 2027 | Content: | ||
| 2028 | (TextFormat|(Enumeration, EnumerationFormat?)) | ||
| 2029 | |||
| 2030 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2031 | |||
| 2032 | |**Name**|**Type**|**Documentation** | ||
| 2033 | |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the minimum number of value that must be reported for the component. | ||
| 2034 | |maxOccurs|OccurenceType|The maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the maximum number of values that can be reported for the component. | ||
| 2035 | |||
| 2036 | Element Documentation: | ||
| 2037 | |||
| 2038 | |**Name**|**Type**|**Documentation** | ||
| 2039 | |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format. | ||
| 2040 | |Enumeration|AnyCodelistReference Type|Enumeration references a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] which enumerates the possible values that can be used as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of this (% style="color:#e74c3c" %)concept(%%). | ||
| 2041 | |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the [[facets>>doc:sdmx:Glossary.Facet.WebHome]] of the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] enumeration. This is for the most part, informational. | ||
| 2042 | |||
| 2043 | **ISOConceptReferenceType:** ISOConceptReferenceType provides a reference to and ISO 11179 (% style="color:#e74c3c" %)concept(%%). | ||
| 2044 | |||
| 2045 | Content: | ||
| 2046 | ConceptAgency, ConceptSchemeID, ConceptID | ||
| 2047 | |||
| 2048 | Element Documentation: | ||
| 2049 | |||
| 2050 | |**Name**|**Type**|**Documentation**| | ||
| 2051 | |ConceptAgency|xs:string| | ||
| 2052 | |ConceptSchemeID|xs:string| | ||
| 2053 | |ConceptID|xs:string| | ||
| 2054 | |||
| 2055 | **ConstraintBaseType:** ConstraintBaseType is an abstract base type that forms the basis of the main abstract ConstraintType. It requires that a name be provided. | ||
| 2056 | |||
| 2057 | Derivation: | ||
| 2058 | |||
| 2059 | AnnotableType (extension) | ||
| 2060 | IdentifiableType (extension) | ||
| 2061 | NameableType (extension) | ||
| 2062 | VersionableType (restriction) | ||
| 2063 | MaintainableBaseType (extension) | ||
| 2064 | MaintainableType (restriction) | ||
| 2065 | ConstraintBaseType | ||
| 2066 | |||
| 2067 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2068 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 2069 | |||
| 2070 | Content: | ||
| 2071 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description | ||
| 2072 | |||
| 2073 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2074 | |||
| 2075 | |**Name**|**Type**|**Documentation**| | ||
| 2076 | |id|IDType|The id is the identifier for the object.| | ||
| 2077 | |urn|MaintainableUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | ||
| 2078 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | ||
| 2079 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned.| | ||
| 2080 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2081 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2082 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object.| | ||
| 2083 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 2084 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface.| | ||
| 2085 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object.| | ||
| 2086 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 2087 | |||
| 2088 | Element Documentation: | ||
| 2089 | |||
| 2090 | |**Name**|**Type**|**Documentation**| | ||
| 2091 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 2092 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 2093 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2094 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2095 | |||
| 2096 | **ConstraintType:** ConstraintType is an abstract base type that specific types of (% style="color:#e74c3c" %)constraints(%%) (data and metadata) restrict and extend to describe their details. These (% style="color:#e74c3c" %)constraint(%%) types both define a (% style="color:#e74c3c" %)constraint(%%) attachment and a release calendar. | ||
| 2097 | |||
| 2098 | Derivation: | ||
| 2099 | |||
| 2100 | AnnotableType (extension) | ||
| 2101 | IdentifiableType (extension) | ||
| 2102 | NameableType (extension) | ||
| 2103 | VersionableType (restriction) | ||
| 2104 | MaintainableBaseType (extension) | ||
| 2105 | MaintainableType (restriction) | ||
| 2106 | ConstraintBaseType (extension) | ||
| 2107 | ConstraintType | ||
| 2108 | |||
| 2109 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2110 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, role | ||
| 2111 | |||
| 2112 | Content: | ||
| 2113 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar? | ||
| 2114 | |||
| 2115 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2116 | |||
| 2117 | |**Name**|**Type**|**Documentation** | ||
| 2118 | |id|IDType|The id is the identifier for the object. | ||
| 2119 | |urn|MaintainableUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details). | ||
| 2120 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message. | ||
| 2121 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned. | ||
| 2122 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 2123 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%). | ||
| 2124 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 2125 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 2126 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface. | ||
| 2127 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object. | ||
| 2128 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 2129 | |role|ConstraintRoleType|The role [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this (% style="color:#e74c3c" %)constraint(%%) states what data is actually present for the (% style="color:#e74c3c" %)constraint(%%) attachment, or if it defines what content is allowed. | ||
| 2130 | |||
| 2131 | Element Documentation: | ||
| 2132 | |||
| 2133 | |**Name**|**Type**|**Documentation** | ||
| 2134 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 2135 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 2136 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2137 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2138 | |ConstraintAttachment|*ConstraintAttachment Type*|ConstraintAttachment describes the collection of constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that the (% style="color:#e74c3c" %)constraint(%%) is attached to. | ||
| 2139 | |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available. | ||
| 2140 | |||
| 2141 | **DataConstraintBaseType:** DataConstraintBaseType is an abstract base refinement of ConstraintType. The (% style="color:#e74c3c" %)constraint(%%) attachment is restricted to constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] related to data. | ||
| 2142 | |||
| 2143 | Derivation: | ||
| 2144 | |||
| 2145 | AnnotableType (extension) | ||
| 2146 | IdentifiableType (extension) | ||
| 2147 | NameableType (extension) | ||
| 2148 | VersionableType (restriction) | ||
| 2149 | MaintainableBaseType (extension) | ||
| 2150 | MaintainableType (restriction) | ||
| 2151 | ConstraintBaseType (extension) | ||
| 2152 | ConstraintType (restriction) | ||
| 2153 | DataConstraintBaseType | ||
| 2154 | |||
| 2155 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2156 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, role | ||
| 2157 | |||
| 2158 | Content: | ||
| 2159 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar? | ||
| 2160 | |||
| 2161 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2162 | |||
| 2163 | |**Name**|**Type**|**Documentation**| | ||
| 2164 | |id|IDType|The id is the identifier for the object.| | ||
| 2165 | |urn|DataConstraintUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | ||
| 2166 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | ||
| 2167 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned.| | ||
| 2168 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2169 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2170 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object.| | ||
| 2171 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 2172 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface.| | ||
| 2173 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object.| | ||
| 2174 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 2175 | |role|ConstraintRoleType|The role [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this (% style="color:#e74c3c" %)constraint(%%) states what data is actually present for the (% style="color:#e74c3c" %)constraint(%%) attachment, or if it defines what content is allowed.| | ||
| 2176 | |||
| 2177 | Element Documentation: | ||
| 2178 | |||
| 2179 | |**Name**|**Type**|**Documentation**| | ||
| 2180 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 2181 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 2182 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2183 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2184 | |ConstraintAttachment|DataConstraintAttach mentType|ConstraintAttachment describes the collection of constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that the (% style="color:#e74c3c" %)constraint(%%) is attached to.| | ||
| 2185 | |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.| | ||
| 2186 | |||
| 2187 | **DataConstraintType:** DataConstraintType defines the structure of a data (% style="color:#e74c3c" %)constraint(%%). A data (% style="color:#e74c3c" %)constraint(%%) can specify either the available set of keys (DataKeySet) or set of [[component>>doc:sdmx:Glossary.Component.WebHome]] values (CubeRegion) in a [[data source>>doc:sdmx:Glossary.Data source.WebHome]], or the allowable keys that can be constructed from a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Multiple such (% style="color:#e74c3c" %)constraints(%%) may be present for a constrained [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. For instance, there may be a constraing that specifies the values allowed for the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (role is "Allowed") which can be used for validation or for constructing a partial [[code list>>doc:sdmx:Glossary.Code list.WebHome]], whilst another constraing can specify the actual content of a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (role is "Actual"). | ||
| 2188 | |||
| 2189 | Derivation: | ||
| 2190 | |||
| 2191 | AnnotableType (extension) | ||
| 2192 | IdentifiableType (extension) | ||
| 2193 | NameableType (extension) | ||
| 2194 | VersionableType (restriction) | ||
| 2195 | MaintainableBaseType (extension) | ||
| 2196 | MaintainableType (restriction) | ||
| 2197 | ConstraintBaseType (extension) | ||
| 2198 | ConstraintType (restriction) | ||
| 2199 | DataConstraintBaseType (extension) | ||
| 2200 | DataConstraintType | ||
| 2201 | |||
| 2202 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2203 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, role | ||
| 2204 | |||
| 2205 | Content: | ||
| 2206 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?, DataKeySet*, CubeRegion[0..2] | ||
| 2207 | |||
| 2208 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2209 | |||
| 2210 | |**Name**|**Type**|**Documentation**| | ||
| 2211 | |id|IDType|The id is the identifier for the object.| | ||
| 2212 | |urn|DataConstraintUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | ||
| 2213 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | ||
| 2214 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned.| | ||
| 2215 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2216 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2217 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object.| | ||
| 2218 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 2219 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface.| | ||
| 2220 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object.| | ||
| 2221 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 2222 | |role|ConstraintRoleType|The role [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this (% style="color:#e74c3c" %)constraint(%%) states what data is actually present for the (% style="color:#e74c3c" %)constraint(%%) attachment, or if it defines what content is allowed.| | ||
| 2223 | |||
| 2224 | Element Documentation: | ||
| 2225 | |||
| 2226 | |**Name**|**Type**|**Documentation**| | ||
| 2227 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 2228 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 2229 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2230 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2231 | |ConstraintAttachment|DataConstraintAttach mentType|ConstraintAttachment describes the collection of constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that the (% style="color:#e74c3c" %)constraint(%%) is attached to.| | ||
| 2232 | |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.| | ||
| 2233 | |DataKeySet|DataKeySetType|DataKeySet defines a full, distinct set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the key.| | ||
| 2234 | |CubeRegion|CubeRegionType|CubeRegion defines a slice of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] ([[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values) for the constrained [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. A set of included or excluded regions can be described.| | ||
| 2235 | |||
| 2236 | ***MetadataConstraintBaseType*:** MetadataConstraintBaseType is an abstract base refinement of ConstraintType. The (% style="color:#e74c3c" %)constraint(%%) attachment is restricted to constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] related to metadata, and the only possible role is "Allowed". | ||
| 2237 | |||
| 2238 | Derivation: | ||
| 2239 | |||
| 2240 | AnnotableType (extension) | ||
| 2241 | IdentifiableType (extension) | ||
| 2242 | NameableType (extension) | ||
| 2243 | VersionableType (restriction) | ||
| 2244 | MaintainableBaseType (extension) | ||
| 2245 | MaintainableType (restriction) | ||
| 2246 | ConstraintBaseType (extension) | ||
| 2247 | ConstraintType (restriction) | ||
| 2248 | MetadataConstraintBaseType | ||
| 2249 | |||
| 2250 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2251 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, role | ||
| 2252 | |||
| 2253 | Content: | ||
| 2254 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar? | ||
| 2255 | |||
| 2256 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2257 | |||
| 2258 | |**Name**|**Type**|**Documentation**| | ||
| 2259 | |id|IDType|The id is the identifier for the object.| | ||
| 2260 | |urn|MetadataConstraintUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | ||
| 2261 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | ||
| 2262 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned.| | ||
| 2263 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2264 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2265 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object.| | ||
| 2266 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 2267 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface.| | ||
| 2268 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object.| | ||
| 2269 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 2270 | |role (fixed: Allowed)|ConstraintRoleType|The role [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this (% style="color:#e74c3c" %)constraint(%%) states what data is actually present for the (% style="color:#e74c3c" %)constraint(%%) attachment, or if it defines what content is allowed.| | ||
| 2271 | |||
| 2272 | Element Documentation: | ||
| 2273 | |||
| 2274 | |**Name**|**Type**|**Documentation**| | ||
| 2275 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 2276 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 2277 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2278 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2279 | |ConstraintAttachment|MetadataConstraintAttachmentType|ConstraintAttachment describes the collection of constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that the (% style="color:#e74c3c" %)constraint(%%) is attached to.| | ||
| 2280 | |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.| | ||
| 2281 | |||
| 2282 | **MetadataConstraintType:** MetadataConstraintType defines the structure of a metadata (% style="color:#e74c3c" %)constraint(%%). A metadata (% style="color:#e74c3c" %)constraint(%%) can specify allowed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for metadata described by the constrained [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. | ||
| 2283 | |||
| 2284 | Derivation: | ||
| 2285 | |||
| 2286 | AnnotableType (extension) | ||
| 2287 | IdentifiableType (extension) | ||
| 2288 | NameableType (extension) | ||
| 2289 | VersionableType (restriction) | ||
| 2290 | MaintainableBaseType (extension) | ||
| 2291 | MaintainableType (restriction) | ||
| 2292 | ConstraintBaseType (extension) | ||
| 2293 | ConstraintType (restriction) | ||
| 2294 | MetadataConstraintBaseType (extension) | ||
| 2295 | MetadataConstraintType | ||
| 2296 | |||
| 2297 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2298 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, role | ||
| 2299 | |||
| 2300 | Content: | ||
| 2301 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?, MetadataTargetRegion[0..2] | ||
| 2302 | |||
| 2303 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2304 | |||
| 2305 | |**Name**|**Type**|**Documentation**| | ||
| 2306 | |id|IDType|The id is the identifier for the object.| | ||
| 2307 | |urn|MetadataConstraintUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | ||
| 2308 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | ||
| 2309 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned.| | ||
| 2310 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2311 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2312 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object.| | ||
| 2313 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 2314 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface.| | ||
| 2315 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object.| | ||
| 2316 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 2317 | |role (fixed: Allowed)|ConstraintRoleType|The role [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this (% style="color:#e74c3c" %)constraint(%%) states what data is actually present for the (% style="color:#e74c3c" %)constraint(%%) attachment, or if it defines what content is allowed.| | ||
| 2318 | |||
| 2319 | Element Documentation: | ||
| 2320 | |||
| 2321 | |**Name**|**Type**|**Documentation**| | ||
| 2322 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 2323 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 2324 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2325 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2326 | |ConstraintAttachment|MetadataConstraintAttachmentType|ConstraintAttachment describes the collection of constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that the (% style="color:#e74c3c" %)constraint(%%) is attached to.| | ||
| 2327 | |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.| | ||
| 2328 | |MetadataTargetRegion|MetadataTargetRegionType|MetadataTargetRegion describes the values allowed for metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].| | ||
| 2329 | |||
| 2330 | **ReleaseCalendarType:** ReleaseCalendarType describes information about the timing of releases of the constrained data. All of these values use the standard "P7D" - style format. | ||
| 2331 | |||
| 2332 | Content: | ||
| 2333 | Periodicity, Offset, Tolerance | ||
| 2334 | |||
| 2335 | Element Documentation | ||
| 2336 | |||
| 2337 | |**Name**|**Type**|**Documentation**| | ||
| 2338 | |Periodicity|xs:string|Periodicity is the period between releases of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].| | ||
| 2339 | |Offset|xs:string|Offset is the interval between January first and the first release of data within the year.| | ||
| 2340 | |Tolerance|xs:string|Tolerance is the period after which the release of data may be deemed late.| | ||
| 2341 | |||
| 2342 | **DataKeySetType:** DataKeySetType defines a collection of full or partial data keys ([[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values). | ||
| 2343 | |||
| 2344 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2345 | isIncluded | ||
| 2346 | |||
| 2347 | Content: | ||
| 2348 | Key+ | ||
| 2349 | |||
| 2350 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2351 | |||
| 2352 | |**Name**|**Type**|**Documentation** | ||
| 2353 | |isIncluded|xs:boolean|The isIncluded [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the keys defined in this key set are inclusive or exclusive to the (% style="color:#e74c3c" %)constraint(%%). | ||
| 2354 | |||
| 2355 | Element Documentation: | ||
| 2356 | |||
| 2357 | |**Name**|**Type**|**Documentation** | ||
| 2358 | |Key|DataKeyType|Key contains a set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which identify a full set of data. | ||
| 2359 | |||
| 2360 | **ConstraintAttachmentType:** ConstraintAttachmentType describes a collection of references to constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. | ||
| 2361 | |||
| 2362 | Content: | ||
| 2363 | (DataProvider|MetadataProvider|MetadataSet+|SimpleDataSource+|(DataStructure+, QueryableDataSource*)|(MetadataStructure+, QueryableDataSource*)|([[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]+, QueryableDataSource*)|([[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]+, QueryableDataSource*)|(ProvisionAgreement+, QueryableDataSource*)|(MetadataProvisionAgreement+, QueryableDataSource*)) | ||
| 2364 | |||
| 2365 | Element Documentation: | ||
| 2366 | |||
| 2367 | |**Name**|**Type**|**Documentation**| | ||
| 2368 | |DataProvider|DataProviderReferenceType|DataProvider is reference to a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. If this is used, then only the [[release calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]] is relevant. The referenced is provided as a URN and/or a full set of reference fields.| | ||
| 2369 | |MetadataProvider|MetadataProviderReferenceType|MetadataProvider is reference to a metadata provider to which the (% style="color:#e74c3c" %)constraint(%%) is attached. If this is used, then only the [[release calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]] is relevant. The referenced is provided as a URN and/or a full set of reference fields.| | ||
| 2370 | |MetadataSet|MetadataSetReferenceType|MetadataSet is reference to a [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields.| | ||
| 2371 | |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which is a URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data or metadata message.| | ||
| 2372 | |DataStructure|DataStructureReferenceType|DataStructure is reference to a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2373 | |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2374 | |MetadataStructure|MetadataStructureReferenceType|MetadataStructure is reference to a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2375 | |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2376 | |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|DataflowReferenceType|[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is reference to a [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) can be attached to more than one [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], and the [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] do not necessarily have to be usages of the same data structure. However, a (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2377 | |QueryableDataSource|QueryableDataSourcType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2378 | |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|MetadataflowReferenceType|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] is reference to a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) can be attached to more than one [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], and the [[metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]] do not necessarily have to be usages of the same metadata structure. However, a (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2379 | |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2380 | |ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreementReference is reference to a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) can be attached to more than one provision aggreement, and the [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] do not necessarily have to be references structure usages based on the same structure. However, a (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] must only express key sets and/or cube/target regions where the identifier of the [[components>>doc:sdmx:Glossary.Component.WebHome]] are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2381 | |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2382 | |MetadataProvisionAgreement|MetadataProvisionAgreementReferenceType|ProvisionAgreementReference is reference to a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) can be attached to more than one provision aggreement, and the [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] do not necessarily have to be references structure usages based on the same structure. However, a (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] must only express key sets and/or cube/target regions where the identifier of the [[components>>doc:sdmx:Glossary.Component.WebHome]] are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2383 | |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2384 | |||
| 2385 | **DataConstraintAttachmentType:** DataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] related to data. | ||
| 2386 | |||
| 2387 | Derivation: | ||
| 2388 | |||
| 2389 | ConstraintAttachmentType (restriction) | ||
| 2390 | DataConstraintAttachmentType | ||
| 2391 | |||
| 2392 | Content: | ||
| 2393 | (DataProvider|SimpleDataSource+|(DataStructure+, QueryableDataSource*)|([[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]+, QueryableDataSource*)|(ProvisionAgreement+, QueryableDataSource*)) | ||
| 2394 | |||
| 2395 | Element Documentation: | ||
| 2396 | |||
| 2397 | |**Name**|**Type**|**Documentation**| | ||
| 2398 | |DataProvider|DataProviderReferenc eType|DataProvider is reference to a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. If this is used, then only the [[release calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]] is relevant. The referenced is provided as a URN and/or a full set of reference fields.| | ||
| 2399 | |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which is a URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data or metadata message.| | ||
| 2400 | |DataStructure|DataStructureReferenceType|DataStructure is reference to a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2401 | |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2402 | |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|DataflowReferenceType|[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is reference to a [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) can be attached to more than one [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], and the [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] do not necessarily have to be usages of the same data structure. However, a (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2403 | |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2404 | |ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreementReference is reference to a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) can be attached to more than one provision aggreement, and the [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] do not necessarily have to be references structure usages based on the same structure. However, a (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] must only express key sets and/or cube/target regions where the identifier of the [[components>>doc:sdmx:Glossary.Component.WebHome]] are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2405 | |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2406 | |||
| 2407 | **MetadataConstraintAttachmentType:** MetadataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] related to metadata. | ||
| 2408 | |||
| 2409 | Derivation: | ||
| 2410 | |||
| 2411 | ConstraintAttachmentType (restriction) | ||
| 2412 | MetadataConstraintAttachmentType | ||
| 2413 | |||
| 2414 | Content: | ||
| 2415 | (MetadataProvider|MetadataSet+|SimpleDataSource+|(MetadataStructure+, QueryableDataSource*)|([[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]+, QueryableDataSource*)|(MetadataProvisionAgreement+, QueryableDataSource*)) | ||
| 2416 | |||
| 2417 | Element Documentation: | ||
| 2418 | |||
| 2419 | |**Name**|**Type**|**Documentation**| | ||
| 2420 | |MetadataProvider|MetadataProviderReferenceType|MetadataProvider is reference to a metadata provider to which the (% style="color:#e74c3c" %)constraint(%%) is attached. If this is used, then only the [[release calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]] is relevant. The referenced is provided as a URN and/or a full set of reference fields.| | ||
| 2421 | |MetadataSet|MetadataSetReferenceType|MetadataSet is reference to a [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields.| | ||
| 2422 | |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which is a URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data or metadata message.| | ||
| 2423 | |MetadataStructure|MetadataStructureReferenceType|MetadataStructure is reference to a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2424 | |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2425 | |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|MetadataflowReferenceype|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] is reference to a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) can be attached to more than one [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], and the [[metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]] do not necessarily have to be usages of the same metadata structure. However, a (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2426 | |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2427 | |MetadataProvisionAgr eement|MetadataProvisionAgreementReferenceType|ProvisionAgreementReference is reference to a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. The referenced is provided as a URN and/or a full set of reference fields. A (% style="color:#e74c3c" %)constraint(%%) can be attached to more than one provision aggreement, and the [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] do not necessarily have to be references structure usages based on the same structure. However, a (% style="color:#e74c3c" %)constraint(%%) which is attached to more than one [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] must only express key sets and/or cube/target regions where the identifier of the [[components>>doc:sdmx:Glossary.Component.WebHome]] are common across all structures to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2428 | |QueryableDataSource|QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached.| | ||
| 2429 | |||
| 2430 | ***RegionType*:** RegionType is an abstract type which defines a generic (% style="color:#e74c3c" %)constraint(%%) region. This type can be refined to define regions for data or [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]]. A region is defined by a collection of key values - each of which a collection of values for a [[component>>doc:sdmx:Glossary.Component.WebHome]] which disambiguates data (i.e. [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] of a [[dataset>>doc:sdmx:Glossary.Data set.WebHome]]). For each region, a collection of [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values can be provided. Taken together, the key values and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] serve to identify or describe a subset of a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. Finally, the region can flagged as being included or excluded, although this flag only makes sense when the region is used in a particular context. | ||
| 2431 | |||
| 2432 | Derivation: | ||
| 2433 | |||
| 2434 | AnnotableType (extension) | ||
| 2435 | RegionType | ||
| 2436 | |||
| 2437 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2438 | |||
| 2439 | include?, validFrom?, validTo? | ||
| 2440 | |||
| 2441 | Content: | ||
| 2442 | |||
| 2443 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, KeyValue*, [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 2444 | |||
| 2445 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2446 | |||
| 2447 | |**Name**|**Type**|**Documentation**| | ||
| 2448 | |include (default: true)|xs:boolean|The include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content (% style="color:#e74c3c" %)constraint(%%), the exclude flag would mean the data identified by the region is not present.| | ||
| 2449 | |validFrom|StandardTimePeriodType| | | ||
| 2450 | |validTo|StandardTimePeriodType| | | ||
| 2451 | |||
| 2452 | Element Documentation: | ||
| 2453 | |||
| 2454 | |**Name**|**Type**|**Documentation**| | ||
| 2455 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 2456 | |KeyValue|*MemberSelectionType*|KeyValue contains a reference to a [[component>>doc:sdmx:Glossary.Component.WebHome]] which disambiguates the data (i.e. a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]) and provides a collection of values for the [[component>>doc:sdmx:Glossary.Component.WebHome]]. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key [[component>>doc:sdmx:Glossary.Component.WebHome]] that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key [[components>>doc:sdmx:Glossary.Component.WebHome]]. Further, this assumption applies to the values of the [[components>>doc:sdmx:Glossary.Component.WebHome]] as well. The values for any given [[component>>doc:sdmx:Glossary.Component.WebHome]] can only be sub-setted in the region by explicit inclusion or exclusion. For example, a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of true and the values of 1 and 2, the only the values of 1 and 2 for [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] X are included in the definition of the region. If the key value is defined with an inclusion [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of false and the value of 1, then the values of 2 and 3 for [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] X are included in the definition of the region. Note that any given key [[component>>doc:sdmx:Glossary.Component.WebHome]] must only be referenced once in the region.| | ||
| 2457 | |[[Component>>doc:sdmx:Glossary.Component.WebHome]]|*MemberSelectionType*|[[Component>>doc:sdmx:Glossary.Component.WebHome]] contains a reference to a [[component>>doc:sdmx:Glossary.Component.WebHome]] (data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or [[measure>>doc:sdmx:Glossary.Measure.WebHome]]) and provides a collection of values for the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]]. This serves to state that for the key which defines the region, the [[components>>doc:sdmx:Glossary.Component.WebHome]] that are specified here have or do not have (depending on the include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the value set) the values provided. It is possible to provide a [[component>>doc:sdmx:Glossary.Component.WebHome]] reference without specifying values, for the purpose of stating the [[component>>doc:sdmx:Glossary.Component.WebHome]] is absent (include = false) or present with an unbounded set of values. As opposed to key [[components>>doc:sdmx:Glossary.Component.WebHome]], which are assumed to be wild carded if absent, no assumptions are made about the absence of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. Only [[components>>doc:sdmx:Glossary.Component.WebHome]] which are explicitly stated to be present or absent from the region will be know. All unstated [[components>>doc:sdmx:Glossary.Component.WebHome]] for the set cannot be assumed to absent or present.| | ||
| 2458 | |||
| 2459 | **MemberSelectionType:** MemberSelectionType is an abstract base type which is used to provide a set of values for a referenced [[component>>doc:sdmx:Glossary.Component.WebHome]]. Implementations of this type will be based on a particular [[component>>doc:sdmx:Glossary.Component.WebHome]] type and refine the allowed values to reflect the types of values that are possible for that type of [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 2460 | |||
| 2461 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2462 | |||
| 2463 | id, include?, removePrefix?, validFrom?, validTo? | ||
| 2464 | |||
| 2465 | Content: | ||
| 2466 | |||
| 2467 | (Value+|TimeRange)? | ||
| 2468 | |||
| 2469 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2470 | |||
| 2471 | |**Name**|**Type**|**Documentation**| | ||
| 2472 | |id|NestedNCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the identifier for the [[component>>doc:sdmx:Glossary.Component.WebHome]] for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). However, specific implementations will restrict this [[representation>>doc:sdmx:Glossary.Representation.WebHome]] to only allow single (% style="color:#e74c3c" %)level(%%) identifiers where appropriate.| | ||
| 2473 | |include (default: true)|xs:boolean|The include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the values provided for the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]] are to be included or excluded from the region in which they are defined.| | ||
| 2474 | |removePrefix|xs:boolean|The removePrefix [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether [[codes>>doc:sdmx:Glossary.Code.WebHome]] should keep or not the prefix, as defined in the extension of [[codelist>>doc:sdmx:Glossary.Code list.WebHome]].| | ||
| 2475 | |validFrom|StandardTimePeriodType| | | ||
| 2476 | |validTo|StandardTimePeriodType| | | ||
| 2477 | |||
| 2478 | Element Documentation: | ||
| 2479 | |||
| 2480 | |**Name**|**Type**|**Documentation**| | ||
| 2481 | |Value|SimpleComponentValueType|Value provides a simple value for the [[component>>doc:sdmx:Glossary.Component.WebHome]], such as a coded, numeric, or simple text value. This type of [[component>>doc:sdmx:Glossary.Component.WebHome]] value is applicable for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].| | ||
| 2482 | |TimeRange|TimeRangeValueType|TimeValue provides a value for a [[component>>doc:sdmx:Glossary.Component.WebHome]] which has a time [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).| | ||
| 2483 | |||
| 2484 | **DataKeyType:** DataKeyType is a region which defines a distinct full or partial data key. The key consists of a set of values, each referencing a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] and providing a single value for that [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. The purpose of the key is to define a subset of a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (i.e. the observed value and data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) which have the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values provided in this definition. Any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] not stated explicitly in this key is assumed to be wild carded, thus allowing for the definition of partial data keys. | ||
| 2485 | |||
| 2486 | Derivation: | ||
| 2487 | |||
| 2488 | AnnotableType (extension) | ||
| 2489 | RegionType (restriction) | ||
| 2490 | DataKeyType | ||
| 2491 | |||
| 2492 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2493 | |||
| 2494 | include?, validFrom?, validTo? | ||
| 2495 | |||
| 2496 | Content: | ||
| 2497 | |||
| 2498 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, KeyValue*, [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 2499 | |||
| 2500 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2501 | |||
| 2502 | |**Name**|**Type**|**Documentation**| | ||
| 2503 | |include (fixed: true)|xs:boolean|The include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a fixed value of true for a distinct key, since such a key is always assumed to identify existing data or metadata.| | ||
| 2504 | |validFrom|StandardTimePeriodType| | | ||
| 2505 | |validTo|StandardTimePeriodType| | | ||
| 2506 | |||
| 2507 | Element Documentation: | ||
| 2508 | |||
| 2509 | |**Name**|**Type**|**Documentation**| | ||
| 2510 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 2511 | |KeyValue|DataKeyValueType|KeyValue contains a reference to a [[component>>doc:sdmx:Glossary.Component.WebHome]] which disambiguates the data (i.e. a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]) and provides a collection of values for the [[component>>doc:sdmx:Glossary.Component.WebHome]]. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key [[component>>doc:sdmx:Glossary.Component.WebHome]] that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key [[components>>doc:sdmx:Glossary.Component.WebHome]]. Further, this assumption applies to the values of the [[components>>doc:sdmx:Glossary.Component.WebHome]] as well. The values for any given [[component>>doc:sdmx:Glossary.Component.WebHome]] can only be sub-setted in the region by explicit inclusion or exclusion. For example, a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of true and the values of 1 and 2, the only the values of 1 and 2 for [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] X are included in the definition of the region. If the key value is defined with an inclusion [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of false and the value of 1, then the values of 2 and 3 for [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] X are included in the definition of the region. Note that any given key [[component>>doc:sdmx:Glossary.Component.WebHome]] must only be referenced once in the region.| | ||
| 2512 | |[[Component>>doc:sdmx:Glossary.Component.WebHome]]|DataComponentValueSetType|[[Component>>doc:sdmx:Glossary.Component.WebHome]] contains a reference to a [[component>>doc:sdmx:Glossary.Component.WebHome]] (data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or [[measure>>doc:sdmx:Glossary.Measure.WebHome]]) and provides a collection of values for the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]]. This serves to state that for the key which defines the region, the [[components>>doc:sdmx:Glossary.Component.WebHome]] that are specified here have or do not have (depending on the include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the value set) the values provided. It is possible to provide a [[component>>doc:sdmx:Glossary.Component.WebHome]] reference without specifying values, for the purpose of stating the [[component>>doc:sdmx:Glossary.Component.WebHome]] is absent (include = false) or present with an unbounded set of values. As opposed to key [[components>>doc:sdmx:Glossary.Component.WebHome]], which are assumed to be wild carded if absent, no assumptions are made about the absence of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. Only [[components>>doc:sdmx:Glossary.Component.WebHome]] which are explicitly stated to be present or absent from the region will be know. All unstated [[components>>doc:sdmx:Glossary.Component.WebHome]] for the set cannot be assumed to absent or present.| | ||
| 2513 | |||
| 2514 | **DataKeyValueType:** DataKeyValueType is a type for providing a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value for the purpose of defining a distinct data key. Only a single value can be provided for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 2515 | |||
| 2516 | Derivation: | ||
| 2517 | |||
| 2518 | MemberSelectionType (restriction) | ||
| 2519 | DataKeyValueType | ||
| 2520 | |||
| 2521 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2522 | |||
| 2523 | id, include?, removePrefix? | ||
| 2524 | |||
| 2525 | Content: | ||
| 2526 | |||
| 2527 | Value | ||
| 2528 | |||
| 2529 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2530 | |||
| 2531 | |**Name**|**Type**|**Documentation**| | ||
| 2532 | |id|SingleNCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the identifier for the [[component>>doc:sdmx:Glossary.Component.WebHome]] for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). However, specific implementations will restrict this [[representation>>doc:sdmx:Glossary.Representation.WebHome]] to only allow single (% style="color:#e74c3c" %)level(%%) identifiers where appropriate.| | ||
| 2533 | |include (fixed: true)|xs:boolean|The include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the values provided for the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]] are to be included or excluded from the region in which they are defined.| | ||
| 2534 | |removePrefix|xs:boolean|The removePrefix [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether [[codes>>doc:sdmx:Glossary.Code.WebHome]] should keep or not the prefix, as defined in the extension of [[codelist>>doc:sdmx:Glossary.Code list.WebHome]].| | ||
| 2535 | |||
| 2536 | Element Documentation: | ||
| 2537 | |||
| 2538 | |**Name**|**Type**|**Documentation**| | ||
| 2539 | |Value|SimpleKeyValueType|Value provides a simple value for the [[component>>doc:sdmx:Glossary.Component.WebHome]], such as a coded, numeric, or simple text value. This type of [[component>>doc:sdmx:Glossary.Component.WebHome]] value is applicable for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].| | ||
| 2540 | |||
| 2541 | **DataComponentValueSetType:** DataComponentValueSetType defines the structure for providing values for a data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], [[measures>>doc:sdmx:Glossary.Measure.WebHome]], or metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. If no values are provided, the [[component>>doc:sdmx:Glossary.Component.WebHome]] is implied to include/excluded from the region in which it is defined, with no regard to the value of the [[component>>doc:sdmx:Glossary.Component.WebHome]]. Note that for metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which occur within other metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], a nested identifier can be provided. For example, a value of (% style="color:#e74c3c" %)CONTACT(%%).ADDRESS.STREET refers to the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with the identifier STREET which exists in the ADDRESS metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the (% style="color:#e74c3c" %)CONTACT(%%) metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], which is defined at the root of the report structure. | ||
| 2542 | |||
| 2543 | Derivation: | ||
| 2544 | |||
| 2545 | MemberSelectionType (restriction) | ||
| 2546 | DataComponentValueSetType | ||
| 2547 | |||
| 2548 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2549 | |||
| 2550 | id, include?, removePrefix? | ||
| 2551 | |||
| 2552 | Content: | ||
| 2553 | |||
| 2554 | (Value+|TimeRange)? | ||
| 2555 | |||
| 2556 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2557 | |||
| 2558 | |**Name**|**Type**|**Documentation**| | ||
| 2559 | |id|NestedNCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the identifier for the [[component>>doc:sdmx:Glossary.Component.WebHome]] for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). However, specific implementations will restrict this [[representation>>doc:sdmx:Glossary.Representation.WebHome]] to only allow single (% style="color:#e74c3c" %)level(%%) identifiers where appropriate.| | ||
| 2560 | |include (default: true)|xs:boolean|The include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the values provided for the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]] are to be included or excluded from the region in which they are defined.| | ||
| 2561 | |removePrefix|xs:boolean|The removePrefix [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether [[codes>>doc:sdmx:Glossary.Code.WebHome]] should keep or not the prefix, as defined in the extension of [[codelist>>doc:sdmx:Glossary.Code list.WebHome]].| | ||
| 2562 | |||
| 2563 | Element Documentation: | ||
| 2564 | |||
| 2565 | |**Name**|**Type**|**Documentation**| | ||
| 2566 | |Value|DataComponentValueTy pe|Value provides a simple value for the [[component>>doc:sdmx:Glossary.Component.WebHome]], such as a coded, numeric, or simple text value. This type of [[component>>doc:sdmx:Glossary.Component.WebHome]] value is applicable for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].| | ||
| 2567 | |TimeRange|TimeRangeValueType|TimeValue provides a value for a [[component>>doc:sdmx:Glossary.Component.WebHome]] which has a time [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).| | ||
| 2568 | |||
| 2569 | **CubeRegionType:** CubeRegionType defines the structure of a data cube region. This is based on the abstract RegionType and simply refines the key and [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values to conform with what is applicable for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], respectively. See the documentation of the base type for more details on how a region is defined. | ||
| 2570 | |||
| 2571 | Derivation: | ||
| 2572 | |||
| 2573 | AnnotableType (extension) | ||
| 2574 | RegionType (restriction) | ||
| 2575 | CubeRegionType | ||
| 2576 | |||
| 2577 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2578 | |||
| 2579 | include? | ||
| 2580 | |||
| 2581 | Content: | ||
| 2582 | |||
| 2583 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, KeyValue*, [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 2584 | |||
| 2585 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2586 | |||
| 2587 | |**Name**|**Type**|**Documentation**| | ||
| 2588 | |include (default: true)|xs:boolean|The include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content (% style="color:#e74c3c" %)constraint(%%), the exclude flag would mean the data identified by the region is not present.| | ||
| 2589 | |||
| 2590 | Element Documentation: | ||
| 2591 | |||
| 2592 | |**Name**|**Type**|**Documentation** | ||
| 2593 | |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 2594 | |KeyValue|CubeRegionKeyType|KeyValue contains a reference to a [[component>>doc:sdmx:Glossary.Component.WebHome]] which disambiguates the data (i.e. a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]) and provides a collection of values for the [[component>>doc:sdmx:Glossary.Component.WebHome]]. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key [[component>>doc:sdmx:Glossary.Component.WebHome]] that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key [[components>>doc:sdmx:Glossary.Component.WebHome]]. Further, this assumption applies to the values of the [[components>>doc:sdmx:Glossary.Component.WebHome]] as well. The values for any given [[component>>doc:sdmx:Glossary.Component.WebHome]] can only be sub-setted in the region by explicit inclusion or exclusion. For example, a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of true and the values of 1 and 2, the only the values of 1 and 2 for [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] X are included in the definition of the region. If the key value is defined with an inclusion [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of false and the value of 1, then the values of 2 and 3 for [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] X are included in the definition of the region. Note that any given key [[component>>doc:sdmx:Glossary.Component.WebHome]] must only be referenced once in the region. | ||
| 2595 | |[[Component>>doc:sdmx:Glossary.Component.WebHome]]|ComponentValueSetType|[[Component>>doc:sdmx:Glossary.Component.WebHome]] contains a reference to a [[component>>doc:sdmx:Glossary.Component.WebHome]] (data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or [[measure>>doc:sdmx:Glossary.Measure.WebHome]]) and provides a collection of values for the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]]. This serves to state that for the key which defines the region, the [[components>>doc:sdmx:Glossary.Component.WebHome]] that are specified here have or do not have (depending on the include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the value set) the values provided. It is possible to provide a [[component>>doc:sdmx:Glossary.Component.WebHome]] reference without specifying values, for the purpose of stating the [[component>>doc:sdmx:Glossary.Component.WebHome]] is absent (include = false) or present with an unbounded set of values. As opposed to key [[components>>doc:sdmx:Glossary.Component.WebHome]], which are assumed to be wild carded if absent, no assumptions are made about the absence of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. Only [[components>>doc:sdmx:Glossary.Component.WebHome]] which are explicitly stated to be present or absent from the region will be know. All unstated [[components>>doc:sdmx:Glossary.Component.WebHome]] for the set cannot be assumed to absent or present. | ||
| 2596 | |||
| 2597 | **MetadataTargetRegionType:** MetadataTargetRegionType defines the structure of a metadata target region. A metadata target region must define the report structure and the metadata target from that structure on which the region is based. This type is based on the abstract RegionType and simply refines the key and [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values to conform with what is applicable for target objects and metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], respectively. See the documentation of the base type for more details on how a region is defined. | ||
| 2598 | |||
| 2599 | Derivation: | ||
| 2600 | |||
| 2601 | AnnotableType (extension) | ||
| 2602 | RegionType (restriction) | ||
| 2603 | MetadataTargetRegionType | ||
| 2604 | |||
| 2605 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2606 | |||
| 2607 | include?, validFrom?, validTo? | ||
| 2608 | |||
| 2609 | Content: | ||
| 2610 | |||
| 2611 | [[Component>>doc:sdmx:Glossary.Component.WebHome]] | ||
| 2612 | |||
| 2613 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2614 | |||
| 2615 | |**Name**|**Type**|**Documentation**| | ||
| 2616 | |include (default: true)|xs:boolean|The include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content (% style="color:#e74c3c" %)constraint(%%), the exclude flag would mean the data identified by the region is not present.| | ||
| 2617 | |validFrom|StandardTimePeriodTy pe| | | ||
| 2618 | |validTo|StandardTimePeriodTy pe| | | ||
| 2619 | |||
| 2620 | Element Documentation: | ||
| 2621 | |||
| 2622 | |**Name**|**Type**|**Documentation**| | ||
| 2623 | |[[Component>>doc:sdmx:Glossary.Component.WebHome]]|MetadataAttributeVal ueSetType|[[Component>>doc:sdmx:Glossary.Component.WebHome]] contains a reference to a [[component>>doc:sdmx:Glossary.Component.WebHome]] (data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or [[measure>>doc:sdmx:Glossary.Measure.WebHome]]) and provides a collection of values for the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]]. This serves to state that for the key which defines the region, the [[components>>doc:sdmx:Glossary.Component.WebHome]] that are specified here have or do not have (depending on the include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the value set) the values provided. It is possible to provide a [[component>>doc:sdmx:Glossary.Component.WebHome]] reference without specifying values, for the purpose of stating the [[component>>doc:sdmx:Glossary.Component.WebHome]] is absent (include = false) or present with an unbounded set of values. As opposed to key [[components>>doc:sdmx:Glossary.Component.WebHome]], which are assumed to be wild carded if absent, no assumptions are made about the absence of a [[component>>doc:sdmx:Glossary.Component.WebHome]]. Only [[components>>doc:sdmx:Glossary.Component.WebHome]] which are explicitly stated to be present or absent from the region will be know. All unstated [[components>>doc:sdmx:Glossary.Component.WebHome]] for the set cannot be assumed to absent or present.| | ||
| 2624 | |||
| 2625 | **CubeRegionKeyType:** CubeRegionKeyType is a type for providing a set of values for a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] for the purpose of defining a data cube region. A set of distinct value can be provided, or if this [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is represented as time, and time range can be specified. | ||
| 2626 | |||
| 2627 | Derivation: | ||
| 2628 | |||
| 2629 | MemberSelectionType (restriction) | ||
| 2630 | CubeRegionKeyType | ||
| 2631 | |||
| 2632 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2633 | |||
| 2634 | id, include?, removePrefix?, validFrom?, validTo? | ||
| 2635 | |||
| 2636 | Content: | ||
| 2637 | |||
| 2638 | (Value+|TimeRange) | ||
| 2639 | |||
| 2640 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2641 | |||
| 2642 | |**Name**|**Type**|**Documentation**| | ||
| 2643 | |id|SingleNCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the identifier for the [[component>>doc:sdmx:Glossary.Component.WebHome]] for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). However, specific implementations will restrict this [[representation>>doc:sdmx:Glossary.Representation.WebHome]] to only allow single (% style="color:#e74c3c" %)level(%%) identifiers where appropriate.| | ||
| 2644 | |include (default: true)|xs:boolean|The include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the values provided for the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]] are to be included or excluded from the region in which they are defined.| | ||
| 2645 | |removePrefix|xs:boolean|The removePrefix [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether [[codes>>doc:sdmx:Glossary.Code.WebHome]] should keep or not the prefix, as defined in the extension of [[codelist>>doc:sdmx:Glossary.Code list.WebHome]].| | ||
| 2646 | |validFrom|StandardTimePeriodType| | | ||
| 2647 | |validTo|StandardTimePeriodType| | | ||
| 2648 | |||
| 2649 | Element Documentation: | ||
| 2650 | |||
| 2651 | |**Name**|**Type**|**Documentation**| | ||
| 2652 | |Value|CubeKeyValueType|Value provides a simple value for the [[component>>doc:sdmx:Glossary.Component.WebHome]], such as a coded, numeric, or simple text value. This type of [[component>>doc:sdmx:Glossary.Component.WebHome]] value is applicable for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].| | ||
| 2653 | |TimeRange|TimeRangeValueType|TimeValue provides a value for a [[component>>doc:sdmx:Glossary.Component.WebHome]] which has a time [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).| | ||
| 2654 | |||
| 2655 | **ComponentValueSetType:** ComponentValueSetType defines the structure for providing values for a data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], [[measures>>doc:sdmx:Glossary.Measure.WebHome]], or metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. If no values are provided, the [[component>>doc:sdmx:Glossary.Component.WebHome]] is implied to include/excluded from the region in which it is defined, with no regard to the value of the [[component>>doc:sdmx:Glossary.Component.WebHome]]. Note that for metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which occur within other metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], a nested identifier can be provided. For example, a value of (% style="color:#e74c3c" %)CONTACT(%%).ADDRESS.STREET refers to the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with the identifier STREET which exists in the ADDRESS metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the (% style="color:#e74c3c" %)CONTACT(%%) metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], which is defined at the root of the report structure. | ||
| 2656 | |||
| 2657 | Derivation: | ||
| 2658 | |||
| 2659 | MemberSelectionType (restriction) | ||
| 2660 | ComponentValueSetType | ||
| 2661 | |||
| 2662 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2663 | |||
| 2664 | id, include?, removePrefix? | ||
| 2665 | |||
| 2666 | Content: | ||
| 2667 | |||
| 2668 | (Value+|TimeRange)? | ||
| 2669 | |||
| 2670 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2671 | |||
| 2672 | |**Name**|**Type**|**Documentation**| | ||
| 2673 | |id|NestedNCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the identifier for the [[component>>doc:sdmx:Glossary.Component.WebHome]] for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). However, specific implementations will restrict this [[representation>>doc:sdmx:Glossary.Representation.WebHome]] to only allow single (% style="color:#e74c3c" %)level(%%) identifiers where appropriate.| | ||
| 2674 | |include (default: true)|xs:boolean|The include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the values provided for the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]] are to be included or excluded from the region in which they are defined.| | ||
| 2675 | |removePrefix|xs:boolean|The removePrefix [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether [[codes>>doc:sdmx:Glossary.Code.WebHome]] should keep or not the prefix, as defined in the extension of [[codelist>>doc:sdmx:Glossary.Code list.WebHome]].| | ||
| 2676 | |||
| 2677 | Element Documentation: | ||
| 2678 | |||
| 2679 | |**Name**|**Type**|**Documentation**| | ||
| 2680 | |Value|SimpleComponentValueType|Value provides a simple value for the [[component>>doc:sdmx:Glossary.Component.WebHome]], such as a coded, numeric, or simple text value. This type of [[component>>doc:sdmx:Glossary.Component.WebHome]] value is applicable for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].| | ||
| 2681 | |TimeRange|TimeRangeValueType|TimeValue provides a value for a [[component>>doc:sdmx:Glossary.Component.WebHome]] which has a time [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).| | ||
| 2682 | |||
| 2683 | **MetadataAttributeValueSetType:** MetadataAttributeValueSetType defines the structure for providing values for a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. If no values are provided, the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is implied to include/excluded from the region in which it is defined, with no regard to the value of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 2684 | |||
| 2685 | Derivation: | ||
| 2686 | |||
| 2687 | MemberSelectionType (restriction) | ||
| 2688 | MetadataAttributeValueSetType | ||
| 2689 | |||
| 2690 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2691 | |||
| 2692 | id, include?, removePrefix? | ||
| 2693 | |||
| 2694 | Content: | ||
| 2695 | |||
| 2696 | (Value+|TimeRange)? | ||
| 2697 | |||
| 2698 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2699 | |||
| 2700 | |**Name**|**Type**|**Documentation**| | ||
| 2701 | |id|NestedNCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the identifier for the [[component>>doc:sdmx:Glossary.Component.WebHome]] for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested [[component>>doc:sdmx:Glossary.Component.WebHome]] (i.e. a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]). However, specific implementations will restrict this [[representation>>doc:sdmx:Glossary.Representation.WebHome]] to only allow single (% style="color:#e74c3c" %)level(%%) identifiers where appropriate.| | ||
| 2702 | |include (default: true)|xs:boolean|The include [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the values provided for the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]] are to be included or excluded from the region in which they are defined.| | ||
| 2703 | |removePrefix|xs:boolean|The removePrefix [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether [[codes>>doc:sdmx:Glossary.Code.WebHome]] should keep or not the prefix, as defined in the extension of [[codelist>>doc:sdmx:Glossary.Code list.WebHome]].| | ||
| 2704 | |||
| 2705 | Element Documentation: | ||
| 2706 | |||
| 2707 | |**Name**|**Type**|**Documentation**| | ||
| 2708 | |Value|SimpleComponentValueType|Value provides a simple value for the [[component>>doc:sdmx:Glossary.Component.WebHome]], such as a coded, numeric, or simple text value. This type of [[component>>doc:sdmx:Glossary.Component.WebHome]] value is applicable for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].| | ||
| 2709 | |TimeRange|TimeRangeValueType|TimeValue provides a value for a [[component>>doc:sdmx:Glossary.Component.WebHome]] which has a time [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).| | ||
| 2710 | |||
| 2711 | **SimpleComponentValueType:** SimpleValueType contains a simple value for a [[component>>doc:sdmx:Glossary.Component.WebHome]], and if that value is from a [[code list>>doc:sdmx:Glossary.Code list.WebHome]], the ability to indicate that child [[codes>>doc:sdmx:Glossary.Code.WebHome]] in a simple [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] are part of the value set of the [[component>>doc:sdmx:Glossary.Component.WebHome]] for the region. | ||
| 2712 | |||
| 2713 | Derivation: | ||
| 2714 | |||
| 2715 | xs:anySimpleType (restriction) | ||
| 2716 | xs:string (extension) | ||
| 2717 | SimpleComponentValueType | ||
| 2718 | |||
| 2719 | Attributes: | ||
| 2720 | cascadeValues?, xml:lang?, validFrom?, validTo? | ||
| 2721 | |||
| 2722 | Content: | ||
| 2723 | |||
| 2724 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2725 | |||
| 2726 | |**Name**|**Type**|**Documentation**| | ||
| 2727 | |cascadeValues (default: false)|CascadeSelectionType|The cascadeValues [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that if the value is taken from a [[code>>doc:sdmx:Glossary.Code.WebHome]] all child [[codes>>doc:sdmx:Glossary.Code.WebHome]] in a simple [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] are understood be included in the region.| | ||
| 2728 | |xml:lang|xs:language|The xml:lang [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies a language [[code>>doc:sdmx:Glossary.Code.WebHome]] for the value. This is used when the [[component>>doc:sdmx:Glossary.Component.WebHome]] value support multi-lingual values.| | ||
| 2729 | |validFrom|StandardTimePeriodTy pe| | | ||
| 2730 | |validTo|StandardTimePeriodTy pe| | | ||
| 2731 | |||
| 2732 | **CubeKeyValueType:** CubeKeyValueType derives from the SimpleValueType, but does not allow for a locale (xml:lang). | ||
| 2733 | |||
| 2734 | Derivation: | ||
| 2735 | |||
| 2736 | xs:anySimpleType (restriction) | ||
| 2737 | xs:string (extension) | ||
| 2738 | SimpleComponentValueType (restriction) | ||
| 2739 | CubeKeyValueType | ||
| 2740 | |||
| 2741 | Attributes: | ||
| 2742 | |||
| 2743 | cascadeValues?, validFrom?, validTo? | ||
| 2744 | |||
| 2745 | Content: | ||
| 2746 | |||
| 2747 | |||
| 2748 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2749 | |||
| 2750 | |**Name**|**Type**|**Documentation** | ||
| 2751 | |cascadeValues (default: false)|CascadeSelectionType|The cascadeValues [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that if the value is taken from a [[code>>doc:sdmx:Glossary.Code.WebHome]] all child [[codes>>doc:sdmx:Glossary.Code.WebHome]] in a simple [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] are understood be included in the region. | ||
| 2752 | |validFrom|StandardTimePeriodType| | ||
| 2753 | |validTo|StandardTimePeriodType| | ||
| 2754 | |||
| 2755 | **DataComponentValueType:** DataComponentValueType derives from the SimpleValueType, but does not allow for validity dates. | ||
| 2756 | |||
| 2757 | Derivation: | ||
| 2758 | |||
| 2759 | xs:anySimpleType (restriction) | ||
| 2760 | xs:string (extension) | ||
| 2761 | SimpleComponentValueType (restriction) | ||
| 2762 | DataComponentValueType | ||
| 2763 | |||
| 2764 | Attributes: | ||
| 2765 | |||
| 2766 | cascadeValues?, xml:lang? | ||
| 2767 | |||
| 2768 | Content: | ||
| 2769 | |||
| 2770 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2771 | |||
| 2772 | |**Name**|**Type**|**Documentation** | ||
| 2773 | |cascadeValues (default: false)|CascadeSelectionType|The cascadeValues [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that if the value is taken from a [[code>>doc:sdmx:Glossary.Code.WebHome]] all child [[codes>>doc:sdmx:Glossary.Code.WebHome]] in a simple [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] are understood be included in the region. | ||
| 2774 | |xml:lang|xs:language|The xml:lang [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies a language [[code>>doc:sdmx:Glossary.Code.WebHome]] for the value. This is used when the [[component>>doc:sdmx:Glossary.Component.WebHome]] value support multi-lingual values. | ||
| 2775 | |||
| 2776 | **SimpleKeyValueType:** SimpleKeyValueType derives from the SimpleValueType, but does not allow for the cascading of value in the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], as keys are meant to describe a distinct full or partial key. | ||
| 2777 | |||
| 2778 | Derivation: | ||
| 2779 | |||
| 2780 | xs:anySimpleType (restriction) | ||
| 2781 | xs:string (extension) | ||
| 2782 | SimpleComponentValueType (restriction) | ||
| 2783 | SimpleKeyValueType | ||
| 2784 | |||
| 2785 | Content: | ||
| 2786 | |||
| 2787 | **TimeRangeValueType:** TimeRangeValueType allows a [[time period>>doc:sdmx:Glossary.Time period.WebHome]] value to be expressed as a range. It can be expressed as the period before a period, after a period, or between two periods. Each of these properties can specify their inclusion in regards to the range. | ||
| 2788 | |||
| 2789 | Attributes: | ||
| 2790 | validFrom?, validTo? | ||
| 2791 | |||
| 2792 | Content: | ||
| 2793 | (BeforePeriod|AfterPeriod|(StartPeriod, EndPeriod)) | ||
| 2794 | |||
| 2795 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2796 | |||
| 2797 | (% style="width:1030.29px" %) | ||
| 2798 | |(% style="width:242px" %)**Name**|(% style="width:245px" %)**Type**|(% style="width:539px" %)**Documentation** | ||
| 2799 | |(% style="width:242px" %)validFrom|(% style="width:245px" %)StandardTimePeriodType|(% style="width:539px" %) | ||
| 2800 | |(% style="width:242px" %)validTo|(% style="width:245px" %)StandardTimePeriodType|(% style="width:539px" %) | ||
| 2801 | |||
| 2802 | Element Documentation: | ||
| 2803 | |||
| 2804 | |**Name**|**Type**|**Documentation**| | ||
| 2805 | |BeforePeriod|TimePeriodRangeType|BeforePeriod is the period before which the period is meant to cover. This date may be inclusive or exclusive in the range.| | ||
| 2806 | |AfterPeriod|TimePeriodRangeType|AfterPeriod is the period after which the period is meant to cover. This date may be inclusive or exclusive in the range.| | ||
| 2807 | |StartPeriod|TimePeriodRangeType|StartPeriod is the start date or the range that the queried date must occur within. This date may be inclusive or exclusive in the range.| | ||
| 2808 | |EndPeriod|TimePeriodRangeType|EndPeriod is the end period of the range. This date may be inclusive or exclusive in the range.| | ||
| 2809 | |||
| 2810 | **TimePeriodRangeType:** TimePeriodRangeType defines a [[time period>>doc:sdmx:Glossary.Time period.WebHome]], and indicates whether it is inclusive in a range. | ||
| 2811 | |||
| 2812 | Derivation: | ||
| 2813 | |||
| 2814 | xs:anySimpleType (restriction) | ||
| 2815 | ObservationalTimePeriodType (extension) | ||
| 2816 | TimePeriodRangeType | ||
| 2817 | |||
| 2818 | Attributes: | ||
| 2819 | isInclusive? | ||
| 2820 | |||
| 2821 | Content: | ||
| 2822 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2823 | |||
| 2824 | |**Name**|**Type**|**Documentation**| | ||
| 2825 | |isInclusive (default: true)|xs:boolean|The isInclusive [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], when true, indicates that the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] specified is included in the range.| | ||
| 2826 | |||
| 2827 | //**DataStructureBaseType:** //DataStructureBaseType describes base refinement of the StructureType for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. A [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] is defined as a collection of metadata (% style="color:#e74c3c" %)concepts(%%), their structure and usage when used to collect or disseminate data. | ||
| 2828 | |||
| 2829 | Derivation: | ||
| 2830 | |||
| 2831 | AnnotableType (extension) | ||
| 2832 | IdentifiableType (extension) | ||
| 2833 | NameableType (extension) | ||
| 2834 | VersionableType (restriction) | ||
| 2835 | MaintainableBaseType (extension) | ||
| 2836 | MaintainableType (restriction) | ||
| 2837 | StructureType (restriction) | ||
| 2838 | DataStructureBaseType | ||
| 2839 | |||
| 2840 | Attributes: | ||
| 2841 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 2842 | |||
| 2843 | Content: | ||
| 2844 | [[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, DataStructureComponents? | ||
| 2845 | |||
| 2846 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2847 | |||
| 2848 | |**Name**|**Type**|**Documentation**| | ||
| 2849 | |id|IDType|The id is the identifier for the object.| | ||
| 2850 | |urn|DataStructureUrnType|The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).| | ||
| 2851 | |uri|xs:anyURI|The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.| | ||
| 2852 | |(%%)(% style="color:#e74c3c" %)version|VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned.| | ||
| 2853 | |validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2854 | |validTo|xs:dateTime|The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).| | ||
| 2855 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object.| | ||
| 2856 | |[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 2857 | |serviceURL|xs:anyURI|The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface.| | ||
| 2858 | |structureURL|xs:anyURI|The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object.| | ||
| 2859 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 2860 | |||
| 2861 | Element Documentation: | ||
| 2862 | |||
| 2863 | |**Name**|**Type**|**Documentation**| | ||
| 2864 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 2865 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 2866 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2867 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 2868 | |DataStructureComponents|DataStructureComponentsType|DataStructureComponents defines the grouping of the sets of metadata concepts that have a defined structural role in the data structure definition. Note that for any component or group defined in a data structure definition, its id must be unique. This applies to the identifiers explicitly defined by the components as well as those inherited from the concept identity of a component. For example, if two dimensions take their identity from concepts with same identity (regardless of whether the concepts exist in different schemes) one of the dimensions must be provided a different explicit identifier. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a component takes its identity cannot be validated against this constraint. Therefore, systems processing data structure definitions will have to perform this check outside of the XML validation. There are also two reserved identifiers in a data structure definition; TIME\_PERIOD, and REPORTING\_YEAR\_START\_DAY. These identifiers may not be used outside of their respective defintions (TimeDimension and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the components or groups as well as an identifier inherited by a component from its concept identity. For example, if an ordinary dimension (i.e. not the time dimension) takes its concept identity from a concept with the identifier TIME\_PERIOD, that dimension must provide a different explicit identifier.| | ||
| 2869 | |||
| 2870 | **DataStructureType:** DataStructureType defines the structure for a data structure definition. A data structure definition is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate data. | ||
| 2871 | |||
| 2872 | Derivation: | ||
| 2873 | |||
| 2874 | AnnotableType (extension) | ||
| 2875 | IdentifiableType (extension) | ||
| 2876 | NameableType (extension) | ||
| 2877 | VersionableType (restriction) | ||
| 2878 | MaintainableBaseType (extension) | ||
| 2879 | MaintainableType (restriction) | ||
| 2880 | StructureType (restriction) | ||
| 2881 | DataStructureBaseType (extension) | ||
| 2882 | DataStructureType | ||
| 2883 | |||
| 2884 | Attributes: | ||
| 2885 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 2886 | |||
| 2887 | Content: | ||
| 2888 | Annotations?, Link*, Name+, Description*, DataStructureComponents?, Metadata? | ||
| 2889 | |||
| 2890 | Attribute Documentation: | ||
| 2891 | |||
| 2892 | (% style="width:2116.68px" %) | ||
| 2893 | |**Name**|**Type**|(% style="width:1572.38px" %)**Documentation** | ||
| 2894 | |id|IDType|(% style="width:1572.38px" %)The id is the identifier for the object. | ||
| 2895 | |urn|DataStructureUrnType|(% style="width:1572.38px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 2896 | |uri|xs:anyURI|(% style="width:1572.38px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 2897 | |version|VersionType|(% style="width:1572.38px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 2898 | |validFrom|xs:dateTime|(% style="width:1572.38px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 2899 | |validTo|xs:dateTime|(% style="width:1572.38px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 2900 | |agencyID|NestedNCNameIDType|(% style="width:1572.38px" %)The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 2901 | |isExternalReference (default: false)|xs:boolean|(% style="width:1572.38px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 2902 | |serviceURL|xs:anyURI|(% style="width:1572.38px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 2903 | |structureURL|xs:anyURI|(% style="width:1572.38px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 2904 | |isPartialLanguage (default: false)|xs:boolean|(% style="width:1572.38px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 2905 | |||
| 2906 | Element Documentation: | ||
| 2907 | |||
| 2908 | |**Name**|**Type**|**Documentation** | ||
| 2909 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 2910 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 2911 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2912 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2913 | |DataStructureComponents|DataStructureComponentsType|DataStructureComponents defines the grouping of the sets of metadata concepts that have a defined structural role in the data structure definition. Note that for any component or group defined in a data structure definition, its id must be unique. This applies to the identifiers explicitly defined by the components as well as those inherited from the concept identity of a component. For example, if two dimensions take their identity from concepts with same identity (regardless of whether the concepts exist in different schemes) one of the dimensions must be provided a different explicit identifier. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a component takes its identity cannot be validated against this constraint. Therefore, systems processing data structure definitions will have to perform this check outside of the XML validation. There are also two reserved identifiers in a data structure definition; TIME\_PERIOD, and REPORTING\_YEAR\_START\_DAY. These identifiers may not be used outside of their respective defintions (TimeDimension and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the components or groups as well as an identifier inherited by a component from its concept identity. For example, if an ordinary dimension (i.e. not the time dimension) takes its concept identity from a concept with the identifier TIME\_PERIOD, that dimension must provide a different explicit identifier. | ||
| 2914 | |Metadata|MetadataStructureReferenceType|A data structure definition may be related to a metadata structure definition in order to use its metadata attributes as part of the data. Note that the referenced metadata set cannot contain nested metadata attributes, as these are not supported in the data. By default all metadata attributes can be associated at any level of the data. However, a metadata attribute usage can be used to provide a specific attribute relationshp for a given metadata attribute. | ||
| 2915 | |||
| 2916 | ***DataStructureComponentsBaseType*:** DataStructureComponentsBaseType is an abstract base type the serves as the basis for the DataStructureComponentsType. This type is necessary to allow for valid substitutions of component lists. | ||
| 2917 | |||
| 2918 | Derivation: | ||
| 2919 | |||
| 2920 | GroupingType (restriction) | ||
| 2921 | DataStructureComponentsBaseType | ||
| 2922 | |||
| 2923 | Content: | ||
| 2924 | {Empty} | ||
| 2925 | |||
| 2926 | **DataStructureComponentsType:** DataStructureComponentsType describes the structure of the grouping to the sets of metadata concepts that have a defined structural role in the data structure definition. At a minimum at least one dimension must be defined. | ||
| 2927 | |||
| 2928 | Derivation: | ||
| 2929 | |||
| 2930 | GroupingType (restriction) | ||
| 2931 | DataStructureComponentsBaseType (extension) | ||
| 2932 | DataStructureComponentsType | ||
| 2933 | |||
| 2934 | Content: | ||
| 2935 | DimensionList, Group*, AttributeList?, MeasureList? | ||
| 2936 | |||
| 2937 | Element Documentation: | ||
| 2938 | |||
| 2939 | |**Name**|**Type**|**Documentation**| | ||
| 2940 | |DimensionList|DimensionListType|DimensionList describes the key descriptor for the data structure definition. It is an ordered set of metadata concepts that, combined, classify a statistical series, such as a time series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific series.| | ||
| 2941 | |Group|GroupType|Group describes a group descriptor in a data structure definition. It is a set metadata concepts (and possibly their values) that define a partial key derived from the key descriptor in a data structure definition.| | ||
| 2942 | |AttributeList|AttributeListType|AttributeList describes the attribute descriptor for the data structure definition. It is a collection of metadata concepts that define the attributes of the data structure definition.| | ||
| 2943 | |MeasureList|MeasureListType|MeasureList describes the measure descriptor for a data structure.| | ||
| 2944 | |||
| 2945 | ***AttributeListBaseType*:** AttributeListBaseType is an abstract base type used as the basis for the AttributeListType. | ||
| 2946 | |||
| 2947 | Derivation: | ||
| 2948 | |||
| 2949 | AnnotableType (extension) | ||
| 2950 | IdentifiableType (extension) | ||
| 2951 | ComponentListType (restriction) | ||
| 2952 | AttributeListBaseType | ||
| 2953 | |||
| 2954 | Attributes: | ||
| 2955 | id?, urn?, uri? | ||
| 2956 | |||
| 2957 | Content: | ||
| 2958 | Annotations?, Link | ||
| 2959 | |||
| 2960 | Attribute Documentation: | ||
| 2961 | |||
| 2962 | |**Name**|**Type**|**Documentation**| | ||
| 2963 | |id (fixed: AttributeDescriptor)|IDType|The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor.| | ||
| 2964 | |urn|AttributeDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 2965 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 2966 | |||
| 2967 | Element Documentation: | ||
| 2968 | |||
| 2969 | |**Name**|**Type**|**Documentation**| | ||
| 2970 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 2971 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 2972 | |||
| 2973 | **AttributeListType:** AttributeListType describes the attribute descriptor for the data structure definition. | ||
| 2974 | |||
| 2975 | Derivation: | ||
| 2976 | |||
| 2977 | AnnotableType (extension) | ||
| 2978 | IdentifiableType (extension) | ||
| 2979 | ComponentListType (restriction) | ||
| 2980 | AttributeListBaseType (extension) | ||
| 2981 | AttributeListType | ||
| 2982 | |||
| 2983 | Attributes: | ||
| 2984 | id?, urn?, uri? | ||
| 2985 | |||
| 2986 | Content: | ||
| 2987 | Annotations?, Link*, (Attribute|MetadataAttributeUsage)+ | ||
| 2988 | |||
| 2989 | Attribute Documentation: | ||
| 2990 | |||
| 2991 | |**Name**|**Type**|**Documentation**| | ||
| 2992 | |id (fixed: AttributeDescriptor)|IDType|The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor.| | ||
| 2993 | |urn|AttributeDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 2994 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 2995 | |||
| 2996 | Element Documentation: | ||
| 2997 | |||
| 2998 | |**Name**|**Type**|**Documentation**| | ||
| 2999 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3000 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3001 | |Attribute|AttributeType|Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity.| | ||
| 3002 | |MetadataAttributeUsage|MetadataAttributeUsageType|MetadataAttributeUsage refines the details of how a metadata attribute from the metadata structure referenced from the data structure is used. By default, metadata attributes can be expressed at any level of the data. This allows an attribute relationship to be defined in order restrict the reporing of a metadata attribute to a specific part of the data.| | ||
| 3003 | |||
| 3004 | ***AttributeBaseType*:** AttributeBaseType is an abstract base type that serves as the basis for the AttributeType. It restricts the text format base to a text format valid for data components (that does not allow for XHTML representation). The local representation is restricted to the values defined in codelist. The concept role is restricted to the values valid for a data attribute. | ||
| 3005 | |||
| 3006 | Derivation: | ||
| 3007 | |||
| 3008 | AnnotableType (extension) | ||
| 3009 | IdentifiableType (extension) | ||
| 3010 | ComponentBaseType (extension) | ||
| 3011 | ComponentType (restriction) | ||
| 3012 | AttributeBaseType | ||
| 3013 | |||
| 3014 | Attributes: | ||
| 3015 | id?, urn?, uri? | ||
| 3016 | |||
| 3017 | Content: | ||
| 3018 | Annotations?, Link*, ConceptIdentity, LocalRepresentation? | ||
| 3019 | |||
| 3020 | Attribute Documentation: | ||
| 3021 | |||
| 3022 | |**Name**|**Type**|**Documentation** | ||
| 3023 | |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 3024 | |urn|DataAttributeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 3025 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 3026 | |||
| 3027 | Element Documentation: | ||
| 3028 | |||
| 3029 | |**Name**|**Type**|**Documentation** | ||
| 3030 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 3031 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 3032 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. | ||
| 3033 | |LocalRepresentation|AttributeRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. | ||
| 3034 | |||
| 3035 | **AttributeType:** AttributeType describes the structure of a data attribute, which is defined as a characteristic of an object or entity. The attribute takes its semantic, and in some cases it representation, from its concept identity. An attribute can be coded by referencing a code list from its coded local representation. It can also specify its text format, which is used as the representation of the attribute if a coded representation is not defined. Neither the coded or uncoded representation are necessary, since the attribute may take these from the referenced concept. An attribute specifies its relationship with other data structure components and is given an assignment status. These two properties dictate where in a data message the attribute will be attached, and whether or not the attribute will be required to be given a value. A set of roles defined in concept scheme can be assigned to the attribute. | ||
| 3036 | |||
| 3037 | Derivation: | ||
| 3038 | |||
| 3039 | AnnotableType (extension) | ||
| 3040 | IdentifiableType (extension) | ||
| 3041 | ComponentBaseType (extension) | ||
| 3042 | ComponentType (restriction) | ||
| 3043 | AttributeBaseType (extension) | ||
| 3044 | AttributeType | ||
| 3045 | |||
| 3046 | Attributes: | ||
| 3047 | id?, urn?, uri?, usage? | ||
| 3048 | |||
| 3049 | Content: | ||
| 3050 | Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*, AttributeRelationship, MeasureRelationship? | ||
| 3051 | |||
| 3052 | Attribute Documentation: | ||
| 3053 | |||
| 3054 | |**Name**|**Type**|**Documentation** | ||
| 3055 | |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). | ||
| 3056 | |urn|DataAttributeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 3057 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 3058 | |usage (default: optional)|UsageType|The usage attribute indicates whether an attribute value must be available for any corresponding existing observation. | ||
| 3059 | |||
| 3060 | Element Documentation: | ||
| 3061 | |||
| 3062 | |**Name**|**Type**|**Documentation**| | ||
| 3063 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3064 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3065 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.| | ||
| 3066 | |LocalRepresentation|AttributeRepresentat ionType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.| | ||
| 3067 | |ConceptRole|ConceptReferenceType|ConceptRole references concepts which define roles which this attribute serves.| | ||
| 3068 | |AttributeRelationshi p|AttributeRelationshi pType|AttributeRelationship describes how the value of this attribute varies with the values of other components. These relationships will be used to determine the attachment level of the attribute in the various data formats.| | ||
| 3069 | |MeasureRelationship|MeasureRelationshipT ype|MeasureRelationship identifies the measures that the attribute applies to. If this is not used, the attribute is assumed to apply to all measures.| | ||
| 3070 | |||
| 3071 | **AttributeRelationshipType:** AttributeRelationshipType defines the structure for stating the relationship between an attribute and other data structure definition components. | ||
| 3072 | |||
| 3073 | Content: | ||
| 3074 | |||
| 3075 | (Dataflow|Dimension+|Group|Observation) | ||
| 3076 | |||
| 3077 | Element Documentation: | ||
| 3078 | |||
| 3079 | |**Name**|**Type**|**Documentation**| | ||
| 3080 | |Dataflow|EmptyType|This means that the value of the attribute varies per dataflow. It is the data modeller's responsibility to design or use non-overlapping dataflows that do not have observations in common, otherwise the integrity of dataflow-specific attribute values is not assured by the model, e.g. when querying those data through its DSD.| | ||
| 3081 | |Dimension|OptionalLocalDimensionReferenceType|This is used to reference dimensions in the data structure definition on which the value of this attribute depends. An attribute using this relationship can be either a group, series (or section), or observation level attribute. The attachment level of the attribute will be determined by the data format and which dimensions are referenced.| | ||
| 3082 | |Group|IDType|This is used as a convenience to referencing all of the dimension defined by the referenced group. The attribute will also be attached to this group.| | ||
| 3083 | |Observation|EmptyType|This is used to specify that the value of the attribute is dependent upon the observed value. An attribute with this relationship will always be treated as an observation level attribute.| | ||
| 3084 | |||
| 3085 | **OptionalLocalDimensionReferenceType:** | ||
| 3086 | |||
| 3087 | Derivation: | ||
| 3088 | |||
| 3089 | xs:anySimpleType (restriction) | ||
| 3090 | xs:string (restriction) | ||
| 3091 | NestedIDType (restriction) | ||
| 3092 | IDType (restriction) | ||
| 3093 | NCNameIDType (extension) | ||
| 3094 | OptionalLocalDimensionReferenceType | ||
| 3095 | |||
| 3096 | Attributes: | ||
| 3097 | |||
| 3098 | optional? | ||
| 3099 | |||
| 3100 | Content: | ||
| 3101 | |||
| 3102 | Attribute Documentation: | ||
| 3103 | |||
| 3104 | (% style="width:1017.29px" %) | ||
| 3105 | |(% style="width:332px" %)**Name**|(% style="width:307px" %)**Type**|(% style="width:375px" %)**Documentation** | ||
| 3106 | |(% style="width:332px" %)optional (default: false)|(% style="width:307px" %)xs:boolean|(% style="width:375px" %) | ||
| 3107 | |||
| 3108 | **MeasureRelationshipType:** MeasureRelationshipType allows for the description of an attributes relationship to one or more measures | ||
| 3109 | |||
| 3110 | Content: | ||
| 3111 | |||
| 3112 | Measure+ | ||
| 3113 | |||
| 3114 | Element Documentation: | ||
| 3115 | |||
| 3116 | |**Name**|**Type**|**Documentation**| | ||
| 3117 | |Measure|NCNameIDType|This is a reference to a measure defined in this data structure definition.| | ||
| 3118 | |||
| 3119 | **MetadataAttributeUsageBaseType:** MetadataAttributeUsageBaseType is the abstract base refinement of a metadata attribute usage. Since this is a usage of metadata attribute already defined in metadata structure, the typical id, concept identity, and representation are excluded in place of a local refernce to the metadata attribute being used. | ||
| 3120 | |||
| 3121 | Derivation: | ||
| 3122 | |||
| 3123 | AnnotableType (extension) | ||
| 3124 | IdentifiableType (extension) | ||
| 3125 | ComponentBaseType (extension) | ||
| 3126 | ComponentType (restriction) | ||
| 3127 | MetadataAttributeUsageBaseType | ||
| 3128 | |||
| 3129 | Attributes: | ||
| 3130 | |||
| 3131 | urn?, uri? | ||
| 3132 | |||
| 3133 | Content: | ||
| 3134 | |||
| 3135 | Annotations?, Link? | ||
| 3136 | |||
| 3137 | Attribute Documentation: | ||
| 3138 | |||
| 3139 | |**Name**|**Type**|**Documentation**| | ||
| 3140 | |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3141 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3142 | |||
| 3143 | Element Documentation: | ||
| 3144 | |||
| 3145 | |**Name**|**Type**|**Documentation**| | ||
| 3146 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3147 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3148 | |||
| 3149 | **MetadataAttributeUsageType:** MetadataAttributeUsageType defines the structure of how a metadata attribute is used in a data structure. This is a local reference to a metadata attribute from the metadata structure referenced by the data structure. An attribute relationship can be defined in order to describe the relationship of the metadata attribute to the data structure components. | ||
| 3150 | |||
| 3151 | Derivation: | ||
| 3152 | |||
| 3153 | AnnotableType (extension) | ||
| 3154 | IdentifiableType (extension) | ||
| 3155 | ComponentBaseType (extension) | ||
| 3156 | ComponentType (restriction) | ||
| 3157 | MetadataAttributeUsageBaseType (extension) | ||
| 3158 | MetadataAttributeUsageType | ||
| 3159 | |||
| 3160 | Attributes: | ||
| 3161 | urn?, uri? | ||
| 3162 | |||
| 3163 | Content: | ||
| 3164 | |||
| 3165 | Annotations?, Link?, MetadataAttributeReference, AttributeRelationship | ||
| 3166 | |||
| 3167 | Attribute Documentation: | ||
| 3168 | |||
| 3169 | |**Name**|**Type**|**Documentation**| | ||
| 3170 | |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3171 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3172 | |||
| 3173 | Element Documentation: | ||
| 3174 | |||
| 3175 | |**Name**|**Type**|**Documentation**| | ||
| 3176 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3177 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3178 | |MetadataAttributeReference|NCNameIDType|MetadataAttributeReference is a local reference to a metadata attribute defined in the metadata structure referenced by this data structure.| | ||
| 3179 | |AttributeRelationship|AttributeRelationshipType|AttributeRelationship defines the relationship between the referenced metadata attribute and the components of the data structure.| | ||
| 3180 | |||
| 3181 | ***DimensionListBaseType*:** DimensionListBaseType is an abstract base type used as the basis for the DimensionListType. | ||
| 3182 | |||
| 3183 | Derivation: | ||
| 3184 | |||
| 3185 | AnnotableType (extension) | ||
| 3186 | IdentifiableType (extension) | ||
| 3187 | ComponentListType (restriction) | ||
| 3188 | DimensionListBaseType | ||
| 3189 | |||
| 3190 | Attributes: | ||
| 3191 | |||
| 3192 | id?, urn?, uri? | ||
| 3193 | |||
| 3194 | Content: | ||
| 3195 | |||
| 3196 | Annotations?, Link | ||
| 3197 | |||
| 3198 | Attribute Documentation: | ||
| 3199 | |||
| 3200 | |**Name**|**Type**|**Documentation**| | ||
| 3201 | |id (fixed: DimensionDescriptor)|IDType|The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor.| | ||
| 3202 | |urn|DimensionDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3203 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3204 | |||
| 3205 | Element Documentation: | ||
| 3206 | |||
| 3207 | |**Name**|**Type**|**Documentation**| | ||
| 3208 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3209 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3210 | |||
| 3211 | **DimensionListType:** DimensionListType describes the key descriptor for a data structure definition. The order of the declaration of child dimensions is significant: it is used to describe the order in which they will appear in data formats for which key values are supplied in an ordered fashion (exclusive of the time dimension, which is not represented as a member of the ordered key). Any data structure definition which uses the time dimension should also declare a frequency dimension, conventionally the first dimension in the key (the set of ordered non-time dimensions). If is not necessary to assign a time dimension, as data can be organised in any fashion required. | ||
| 3212 | |||
| 3213 | Derivation: | ||
| 3214 | |||
| 3215 | AnnotableType (extension) | ||
| 3216 | IdentifiableType (extension) | ||
| 3217 | ComponentListType (restriction) | ||
| 3218 | DimensionListBaseType (extension) | ||
| 3219 | DimensionListType | ||
| 3220 | |||
| 3221 | Attributes: | ||
| 3222 | |||
| 3223 | id?, urn?, uri? | ||
| 3224 | |||
| 3225 | Content: | ||
| 3226 | |||
| 3227 | Annotations?, Link*, Dimension+, TimeDimension? | ||
| 3228 | |||
| 3229 | Attribute Documentation: | ||
| 3230 | |||
| 3231 | |**Name**|**Type**|**Documentation**| | ||
| 3232 | |id (fixed: DimensionDescriptor)|IDType|The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor.| | ||
| 3233 | |urn|DimensionDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3234 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3235 | |||
| 3236 | Element Documentation: | ||
| 3237 | |||
| 3238 | |**Name**|**Type**|**Documentation**| | ||
| 3239 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3240 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3241 | |Dimension|DimensionType|Dimension describes the structure of a dimension, which is defined as a statistical concept used (most probably together with other statistical concepts) to identify a statistical series, such as a time series, e.g. a statistical concept indicating certain economic activity or a geographical reference area.| | ||
| 3242 | |TimeDimension|TimeDimensionType|TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies.| | ||
| 3243 | |||
| 3244 | ***BaseDimensionBaseType*:** BaseDimensionBaseType is an abstract base type that serves as the basis for any dimension. It restricts the text format base to a text format valid for data components (that does not allow for XHTML representation). | ||
| 3245 | |||
| 3246 | Derivation: | ||
| 3247 | |||
| 3248 | AnnotableType (extension) | ||
| 3249 | IdentifiableType (extension) | ||
| 3250 | ComponentBaseType (extension) | ||
| 3251 | ComponentType (restriction) | ||
| 3252 | BaseDimensionBaseType | ||
| 3253 | |||
| 3254 | Attributes: | ||
| 3255 | |||
| 3256 | id?, urn?, uri? | ||
| 3257 | |||
| 3258 | Content: | ||
| 3259 | |||
| 3260 | Annotations?, Link*, ConceptIdentity, LocalRepresentation? | ||
| 3261 | |||
| 3262 | Attribute Documentation: | ||
| 3263 | |||
| 3264 | |**Name**|**Type**|**Documentation**| | ||
| 3265 | |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 3266 | |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3267 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3268 | |||
| 3269 | Element Documentation: | ||
| 3270 | |||
| 3271 | |**Name**|**Type**|**Documentation**| | ||
| 3272 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3273 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3274 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.| | ||
| 3275 | |LocalRepresentation|*DataStructureRepresentationType*|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.| | ||
| 3276 | |||
| 3277 | ***BaseDimensionType*:** BaseDimensionType is an abstract base type which defines the basic structure of all dimensions. | ||
| 3278 | |||
| 3279 | Derivation: | ||
| 3280 | |||
| 3281 | AnnotableType (extension) | ||
| 3282 | IdentifiableType (extension) | ||
| 3283 | ComponentBaseType (extension) | ||
| 3284 | ComponentType (restriction) | ||
| 3285 | BaseDimensionBaseType (extension) | ||
| 3286 | BaseDimensionType | ||
| 3287 | |||
| 3288 | Attributes: | ||
| 3289 | |||
| 3290 | id?, urn?, uri?, position? | ||
| 3291 | |||
| 3292 | Content: | ||
| 3293 | |||
| 3294 | Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole | ||
| 3295 | |||
| 3296 | Attribute Documentation: | ||
| 3297 | |||
| 3298 | |**Name**|**Type**|**Documentation**| | ||
| 3299 | |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 3300 | |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3301 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3302 | |position|xs:int|The order of the dimensions in the key descriptor (DimensionList element) defines the order of the dimensions in the data structure. This position attribute explicitly specifies the position of the dimension in the data structure. It is optional and if specified must be consistent with the position of the dimension in the key descriptor.| | ||
| 3303 | |||
| 3304 | Element Documentation: | ||
| 3305 | |||
| 3306 | |**Name**|**Type**|**Documentation**| | ||
| 3307 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3308 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3309 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.| | ||
| 3310 | |LocalRepresentation|*DataStructureRepresentationType*|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.| | ||
| 3311 | |ConceptRole|ConceptReferenceType|ConceptRole references concepts which define roles which this dimension serves.| | ||
| 3312 | |||
| 3313 | **DimensionType:** DimensionType describes the structure of an ordinary dimension, which is defined as a statistical concept used (most probably together with other statistical concepts) to identify a statistical series, such as a time series, e.g. a statistical concept indicating certain economic activity or a geographical reference area. The dimension takes its semantic, and in some cases it representation, from its concept identity. A dimension can be coded by referencing a code list from its coded local representation. It can also specify its text format, which is used as the representation of the dimension if a coded representation is not defined. Neither the coded or uncoded representation are necessary, since the dimension may take these from the referenced concept. | ||
| 3314 | |||
| 3315 | Derivation: | ||
| 3316 | |||
| 3317 | AnnotableType (extension) | ||
| 3318 | IdentifiableType (extension) | ||
| 3319 | ComponentBaseType (extension) | ||
| 3320 | ComponentType (restriction) | ||
| 3321 | BaseDimensionBaseType (extension) | ||
| 3322 | BaseDimensionType (restriction) | ||
| 3323 | DimensionType | ||
| 3324 | |||
| 3325 | Attributes: | ||
| 3326 | |||
| 3327 | id?, urn?, uri?, position? | ||
| 3328 | |||
| 3329 | Content: | ||
| 3330 | |||
| 3331 | Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole | ||
| 3332 | |||
| 3333 | Attribute Documentation: | ||
| 3334 | |||
| 3335 | |**Name**|**Type**|**Documentation**| | ||
| 3336 | |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 3337 | |urn|DimensionUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3338 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3339 | |position|xs:int|The order of the dimensions in the key descriptor (DimensionList element) defines the order of the dimensions in the data structure. This position attribute explicitly specifies the position of the dimension in the data structure. It is optional and if specified must be consistent with the position of the dimension in the key descriptor.| | ||
| 3340 | |||
| 3341 | Element Documentation: | ||
| 3342 | |||
| 3343 | |**Name**|**Type**|**Documentation** | ||
| 3344 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 3345 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 3346 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. | ||
| 3347 | |LocalRepresentation|SimpleDataStructureRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. | ||
| 3348 | |ConceptRole|ConceptReferenceType|ConceptRole references concepts which define roles which this dimension serves. | ||
| 3349 | |||
| 3350 | **TimeDimensionType:** TimeDimensionType describes the structure of a time dimension. The time dimension takes its semantic from its concept identity (usually the TIME\_PERIOD concept), yet is always has a fixed identifier (TIME\_PERIOD). The time dimension always has a fixed text format, which specifies that its format is always the in the value set of the observational time period (see common:ObservationalTimePeriodType). It is possible that the format may be a sub-set of the observational time period value set. For example, it is possible to state that the representation might always be a calendar year. See the enumerations of the textType attribute in the LocalRepresentation/TextFormat for more details of the possible sub-sets. It is also possible to facet this representation with start and end dates. The purpose of such facts is to restrict the value of the time dimension to occur within the specified range. If the time dimension is expected to allow for the standard reporting periods (see common:ReportingTimePeriodType) to be used, then it is strongly recommended that the reporting year start day attribute also be included in the data structure definition. When the reporting year start day attribute is used, any standard reporting period values will be assumed to be based on the start day contained in this attribute. If the reporting year start day attribute is not included and standard reporting periods are used, these values will be assumed to be based on a reporting year which begins January 1. | ||
| 3351 | |||
| 3352 | Derivation: | ||
| 3353 | |||
| 3354 | AnnotableType (extension) | ||
| 3355 | IdentifiableType (extension) | ||
| 3356 | ComponentBaseType (extension) | ||
| 3357 | ComponentType (restriction) | ||
| 3358 | BaseDimensionBaseType (extension) | ||
| 3359 | BaseDimensionType (restriction) | ||
| 3360 | TimeDimensionType | ||
| 3361 | |||
| 3362 | Attributes: | ||
| 3363 | id?, urn?, uri? | ||
| 3364 | |||
| 3365 | Content: | ||
| 3366 | nnotations?, Link*, ConceptIdentity, LocalRepresentation | ||
| 3367 | |||
| 3368 | Attribute Documentation: | ||
| 3369 | |||
| 3370 | |**Name**|**Type**|**Documentation**| | ||
| 3371 | |id (fixed: TIME\_PERIOD)|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 3372 | |urn|TimeDimensionUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3373 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3374 | |||
| 3375 | Element Documentation: | ||
| 3376 | |||
| 3377 | |**Name**|**Type**|**Documentation** | ||
| 3378 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 3379 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 3380 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. | ||
| 3381 | |LocalRepresentation|TimeDimensionRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. | ||
| 3382 | |||
| 3383 | **GroupBaseType:** GroupBaseType is an abstract base type that forms the basis for the GroupType. | ||
| 3384 | |||
| 3385 | Derivation: | ||
| 3386 | |||
| 3387 | AnnotableType (extension) | ||
| 3388 | IdentifiableType (extension) | ||
| 3389 | ComponentListType (restriction) | ||
| 3390 | GroupBaseType | ||
| 3391 | |||
| 3392 | Attributes: | ||
| 3393 | id, urn?, uri? | ||
| 3394 | |||
| 3395 | Content: | ||
| 3396 | Annotations? | ||
| 3397 | |||
| 3398 | Attribute Documentation: | ||
| 3399 | |||
| 3400 | |**Name**|**Type**|**Documentation** | ||
| 3401 | |id|IDType|The id is the identifier for the object. | ||
| 3402 | |urn|GroupDimensionDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 3403 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 3404 | |||
| 3405 | Element Documentation: | ||
| 3406 | |||
| 3407 | |**Name**|**Type**|**Documentation**| | ||
| 3408 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3409 | |||
| 3410 | **GroupType:** GroupType describes the structure of a group descriptor in a data structure definition. A group may consist of a of partial key, or collection of distinct cube regions or key sets to which attributes may be attached. The purpose of a group is to specify attributes values which have the same value based on some common dimensionality. All groups declared in the data structure must be unique - that is, you may not have duplicate partial keys. All groups must be given unique identifiers. | ||
| 3411 | |||
| 3412 | Derivation: | ||
| 3413 | |||
| 3414 | AnnotableType (extension) | ||
| 3415 | IdentifiableType (extension) | ||
| 3416 | ComponentListType (restriction) | ||
| 3417 | GroupBaseType (extension) | ||
| 3418 | GroupType | ||
| 3419 | |||
| 3420 | Attributes: | ||
| 3421 | |||
| 3422 | id, urn?, uri? | ||
| 3423 | |||
| 3424 | Content: | ||
| 3425 | |||
| 3426 | Annotations?, GroupDimension+ | ||
| 3427 | |||
| 3428 | Attribute Documentation: | ||
| 3429 | |||
| 3430 | |**Name**|**Type**|**Documentation**| | ||
| 3431 | |id|IDType|The id is the identifier for the object.| | ||
| 3432 | |urn|GroupDimensionDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3433 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3434 | |||
| 3435 | Element Documentation: | ||
| 3436 | |||
| 3437 | |**Name**|**Type**|**Documentation**| | ||
| 3438 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3439 | |GroupDimension|GroupDimensionType|GroupDimension is a component which contains only a reference to a dimension in the key descriptor (DimensionList). Although it is conventional to declare dimensions in the same order as they are declared in the ordered key, there is no requirement to do so - the ordering of the values of the key are taken from the order in which the dimensions are declared. Note that the id of a dimension may be inherited from its underlying concept - therefore this reference value may actually be the id of the concept.| | ||
| 3440 | |||
| 3441 | ***GroupDimensionBaseType*:** GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType. | ||
| 3442 | |||
| 3443 | Derivation: | ||
| 3444 | |||
| 3445 | AnnotableType (extension) | ||
| 3446 | IdentifiableType (extension) | ||
| 3447 | ComponentBaseType (extension) | ||
| 3448 | ComponentType (restriction) | ||
| 3449 | GroupDimensionBaseType | ||
| 3450 | |||
| 3451 | Content: | ||
| 3452 | |||
| 3453 | {Empty} | ||
| 3454 | |||
| 3455 | **GroupDimensionType:** GroupDimensionType defines a dimension component with a group key descriptor component list. Although technically a component, this is essentially a reference to a dimension defined in the key descriptor. Therefore, the identification, name, and description, concept identity and representation properties that are typically available for a component are not allowed here, as they are all inherited from the referenced dimension. | ||
| 3456 | |||
| 3457 | Derivation: | ||
| 3458 | |||
| 3459 | AnnotableType (extension) | ||
| 3460 | IdentifiableType (extension) | ||
| 3461 | ComponentBaseType (extension) | ||
| 3462 | ComponentType (restriction) | ||
| 3463 | GroupDimensionBaseType (extension) | ||
| 3464 | GroupDimensionType | ||
| 3465 | |||
| 3466 | Content: | ||
| 3467 | |||
| 3468 | DimensionReference | ||
| 3469 | |||
| 3470 | Element Documentation: | ||
| 3471 | |||
| 3472 | |**Name**|**Type**|**Documentation**| | ||
| 3473 | |DimensionReference|NCNameIDType|DimensionReference provides a reference to a dimension defined in the key descriptor of the data structure definition in which this group key descriptor is defined.| | ||
| 3474 | |||
| 3475 | **MeasureListType:** MeasureListType describes the structure of the measure descriptor for a data structure definition. | ||
| 3476 | |||
| 3477 | Derivation: | ||
| 3478 | |||
| 3479 | AnnotableType (extension) | ||
| 3480 | IdentifiableType (extension) | ||
| 3481 | ComponentListType (restriction) | ||
| 3482 | MeasureListType | ||
| 3483 | |||
| 3484 | Attributes: | ||
| 3485 | |||
| 3486 | id?, urn?, uri? | ||
| 3487 | |||
| 3488 | Content: | ||
| 3489 | |||
| 3490 | Annotations?, Link*, Measure+ | ||
| 3491 | |||
| 3492 | Attribute Documentation: | ||
| 3493 | |||
| 3494 | |**Name**|**Type**|**Documentation**| | ||
| 3495 | |id (fixed: MeasureDescriptor)|IDType|The id is the identifier for the object.| | ||
| 3496 | |urn|MeasureDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3497 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3498 | |||
| 3499 | Element Documentation: | ||
| 3500 | |||
| 3501 | |**Name**|**Type**|**Documentation**| | ||
| 3502 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3503 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3504 | |Measure|MeasureType|Measure defines the structure of a measure, which is the concept that is the value of the phenomenon to be measured in a data set.| | ||
| 3505 | |||
| 3506 | ***MeasureBaseType*:** MeasureBaseType is an abstract base type that refines ComponentType to rerstrict the represenations to those which are applicable for a measure. | ||
| 3507 | |||
| 3508 | Derivation: | ||
| 3509 | |||
| 3510 | AnnotableType (extension) | ||
| 3511 | IdentifiableType (extension) | ||
| 3512 | ComponentBaseType (extension) | ||
| 3513 | ComponentType (restriction) | ||
| 3514 | MeasureBaseType | ||
| 3515 | |||
| 3516 | Attributes: | ||
| 3517 | |||
| 3518 | id?, urn?, uri? | ||
| 3519 | |||
| 3520 | Content: | ||
| 3521 | |||
| 3522 | Annotations?, Link*, ConceptIdentity, LocalRepresentation? | ||
| 3523 | |||
| 3524 | Attribute Documentation: | ||
| 3525 | |||
| 3526 | |**Name**|**Type**|**Documentation**| | ||
| 3527 | |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 3528 | |urn|MeasureUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3529 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3530 | |||
| 3531 | Element Documentation: | ||
| 3532 | |||
| 3533 | |**Name**|**Type**|**Documentation**| | ||
| 3534 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3535 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3536 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.| | ||
| 3537 | |LocalRepresentation|MeasureRepresentatio nType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.| | ||
| 3538 | |||
| 3539 | **MeasureType:** MeasureType defines the structure of a measure descriptor. In addition to the identifying concept and representation, a usage status and max occurs can be defined. | ||
| 3540 | |||
| 3541 | Derivation: | ||
| 3542 | |||
| 3543 | AnnotableType (extension) | ||
| 3544 | IdentifiableType (extension) | ||
| 3545 | ComponentBaseType (extension) | ||
| 3546 | ComponentType (restriction) | ||
| 3547 | MeasureBaseType (extension) | ||
| 3548 | MeasureType | ||
| 3549 | |||
| 3550 | Attributes: | ||
| 3551 | |||
| 3552 | id?, urn?, uri?, usage? | ||
| 3553 | |||
| 3554 | Content: | ||
| 3555 | |||
| 3556 | Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole | ||
| 3557 | |||
| 3558 | Attribute Documentation: | ||
| 3559 | |||
| 3560 | |**Name**|**Type**|**Documentation**| | ||
| 3561 | |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 3562 | |urn|MeasureUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3563 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3564 | |usage (default: optional)|UsageType|The usage attribute indicates whether a measure value must be available for any corresponding existing observation.| | ||
| 3565 | |||
| 3566 | Element Documentation: | ||
| 3567 | |||
| 3568 | |**Name**|**Type**|**Documentation**| | ||
| 3569 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3570 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3571 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.| | ||
| 3572 | |LocalRepresentation|MeasureRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.| | ||
| 3573 | |ConceptRole|ConceptReferenceType|ConceptRole references concepts which define roles which this measure serves.| | ||
| 3574 | |||
| 3575 | ***DataStructureRepresentationType*:** DataStructureRepresentationType is an abstract base type which defines the allowable representations for any data structure definition component. The enumeration must be restricted to the proper type for item scheme for a given component. | ||
| 3576 | |||
| 3577 | Derivation: | ||
| 3578 | |||
| 3579 | RepresentationType (restriction) | ||
| 3580 | DataStructureRepresentationType | ||
| 3581 | |||
| 3582 | Attributes: | ||
| 3583 | |||
| 3584 | maxOccurs? | ||
| 3585 | |||
| 3586 | Content: | ||
| 3587 | |||
| 3588 | (TextFormat|(Enumeration, EnumerationFormat?)) | ||
| 3589 | |||
| 3590 | Attribute Documentation: | ||
| 3591 | |||
| 3592 | |**Name**|**Type**|**Documentation**| | ||
| 3593 | |maxOccurs|OccurenceType|The maxOccurs attribute indicates the maximum number of values that can be reported for the component.| | ||
| 3594 | |||
| 3595 | Element Documentation: | ||
| 3596 | |||
| 3597 | |**Name**|**Type**|**Documentation**| | ||
| 3598 | |TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format.| | ||
| 3599 | |Enumeration|AnyCodelistReference Type|Enumeration references an item scheme that enumerates the allowable values for this representation.| | ||
| 3600 | |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.| | ||
| 3601 | |||
| 3602 | **AttributeRepresentationType:** AttributeRepresentationType defines the representation for a data attribute. A data attribute can be text (including XHTML and multi-lingual values), a simple value, or an enumerated value. | ||
| 3603 | |||
| 3604 | Derivation: | ||
| 3605 | |||
| 3606 | RepresentationType (restriction) | ||
| 3607 | AttributeRepresentationType | ||
| 3608 | |||
| 3609 | Attributes: | ||
| 3610 | |||
| 3611 | minOccurs?, maxOccurs? | ||
| 3612 | |||
| 3613 | Content: | ||
| 3614 | |||
| 3615 | (TextFormat|(Enumeration, EnumerationFormat?)) | ||
| 3616 | |||
| 3617 | Attribute Documentation: | ||
| 3618 | |||
| 3619 | |**Name**|**Type**|**Documentation**| | ||
| 3620 | |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of value that must be reported for the component.| | ||
| 3621 | |maxOccurs (default: 1)|OccurenceType|The maxOccurs attribute indicates the maximum number of values that can be reported for the component.| | ||
| 3622 | |||
| 3623 | Element Documentation: | ||
| 3624 | |||
| 3625 | |**Name**|**Type**|**Documentation**| | ||
| 3626 | |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.| | ||
| 3627 | |Enumeration|AnyCodelistReference Type|Enumeration references an item scheme that enumerates the allowable values for this representation.| | ||
| 3628 | |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.| | ||
| 3629 | |||
| 3630 | **MeasureRepresentationType:** MeasureRepresentationType defines the representation for a measure. A measure can be text (including XHTML and multi-lingual values), a simple value, or an enumerated value. | ||
| 3631 | |||
| 3632 | Derivation: | ||
| 3633 | |||
| 3634 | RepresentationType (restriction) | ||
| 3635 | MeasureRepresentationType | ||
| 3636 | |||
| 3637 | Attributes: | ||
| 3638 | minOccurs?, maxOccurs? | ||
| 3639 | |||
| 3640 | Content: | ||
| 3641 | (TextFormat|(Enumeration, EnumerationFormat?)) | ||
| 3642 | |||
| 3643 | Attribute Documentation: | ||
| 3644 | |||
| 3645 | |**Name**|**Type**|**Documentation**| | ||
| 3646 | |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of value that must be reported for the component.| | ||
| 3647 | |maxOccurs (default: 1)|OccurenceType|The maxOccurs attribute indicates the maximum number of values that can be reported for the component.| | ||
| 3648 | |||
| 3649 | Element Documentation: | ||
| 3650 | |||
| 3651 | |**Name**|**Type**|**Documentation**| | ||
| 3652 | |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.| | ||
| 3653 | |Enumeration|AnyCodelistReference Type|Enumeration references an item scheme that enumerates the allowable values for this representation.| | ||
| 3654 | |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.| | ||
| 3655 | |||
| 3656 | **SimpleDataStructureRepresentationType:** SimpleDataStructureRepresentationType defines the representation for any non-time dimension data structure definition component. | ||
| 3657 | |||
| 3658 | Derivation: | ||
| 3659 | |||
| 3660 | RepresentationType (restriction) | ||
| 3661 | DataStructureRepresentationType (restriction) | ||
| 3662 | SimpleDataStructureRepresentationType | ||
| 3663 | |||
| 3664 | Content: | ||
| 3665 | (TextFormat|(Enumeration, EnumerationFormat?)) | ||
| 3666 | |||
| 3667 | Element Documentation: | ||
| 3668 | |||
| 3669 | |**Name**|**Type**|**Documentation**| | ||
| 3670 | |TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format.| | ||
| 3671 | |Enumeration|CodelistReferenceTyp e|Enumeration references an item scheme that enumerates the allowable values for this representation.| | ||
| 3672 | |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.| | ||
| 3673 | |||
| 3674 | **TimeDimensionRepresentationType:** TimeDimensionRepresentationType defines the representation for the time dimension. Enumerated values are not allowed. | ||
| 3675 | |||
| 3676 | Derivation: | ||
| 3677 | |||
| 3678 | RepresentationType (restriction) | ||
| 3679 | DataStructureRepresentationType (restriction) | ||
| 3680 | SimpleDataStructureRepresentationType (restriction) | ||
| 3681 | TimeDimensionRepresentationType | ||
| 3682 | |||
| 3683 | Content: | ||
| 3684 | TextFormat | ||
| 3685 | |||
| 3686 | Element Documentation: | ||
| 3687 | |||
| 3688 | |**Name**|**Type**|**Documentation**| | ||
| 3689 | |TextFormat|TimeTextFormatType|TextFormat describes an uncoded textual format.| | ||
| 3690 | |||
| 3691 | **DataflowType:** DataflowType describes the structure of a data flow. A data flow is defined as the structure of data that will provided for different reference periods. If this type is not referenced externally, then a reference to a data structure must be provided. | ||
| 3692 | |||
| 3693 | Derivation: | ||
| 3694 | |||
| 3695 | AnnotableType (extension) | ||
| 3696 | IdentifiableType (extension) | ||
| 3697 | NameableType (extension) | ||
| 3698 | VersionableType (restriction) | ||
| 3699 | MaintainableBaseType (extension) | ||
| 3700 | MaintainableType (restriction) | ||
| 3701 | StructureUsageType (restriction) | ||
| 3702 | DataflowType | ||
| 3703 | |||
| 3704 | Attributes: | ||
| 3705 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 3706 | |||
| 3707 | Content: | ||
| 3708 | Annotations?, Link*, Name+, Description*, Structure? | ||
| 3709 | |||
| 3710 | Attribute Documentation: | ||
| 3711 | |||
| 3712 | |**Name**|**Type**|**Documentation**| | ||
| 3713 | |id|IDType|The id is the identifier for the object.| | ||
| 3714 | |urn|DataflowUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3715 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3716 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 3717 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 3718 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 3719 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 3720 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 3721 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 3722 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 3723 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 3724 | |||
| 3725 | Element Documentation: | ||
| 3726 | |||
| 3727 | |**Name**|**Type**|**Documentation**| | ||
| 3728 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3729 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3730 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 3731 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 3732 | |Structure|DataStructureReferenceType|Structure provides a reference to the data structure definition which defines the structure of all data for this flow.| | ||
| 3733 | |||
| 3734 | ***HierarchyBaseType*:** HierarchyBaseType is an abstract base class that is the basis for the HierarchyType. It requires that a name be supplied. | ||
| 3735 | |||
| 3736 | Derivation: | ||
| 3737 | |||
| 3738 | AnnotableType (extension) | ||
| 3739 | IdentifiableType (extension) | ||
| 3740 | NameableType (extension) | ||
| 3741 | VersionableType (restriction) | ||
| 3742 | MaintainableBaseType (extension) | ||
| 3743 | MaintainableType (restriction) | ||
| 3744 | HierarchyBaseType | ||
| 3745 | |||
| 3746 | Attributes: | ||
| 3747 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 3748 | |||
| 3749 | Content: | ||
| 3750 | Annotations?, Link*, Name+, Description | ||
| 3751 | |||
| 3752 | Attribute Documentation: | ||
| 3753 | |||
| 3754 | |**Name**|**Type**|**Documentation** | ||
| 3755 | |id|IDType|The id is the identifier for the object. | ||
| 3756 | |urn|HierarchyUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 3757 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 3758 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 3759 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 3760 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 3761 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 3762 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 3763 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 3764 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 3765 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 3766 | |||
| 3767 | Element Documentation: | ||
| 3768 | |||
| 3769 | |**Name**|**Type**|**Documentation**| | ||
| 3770 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3771 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3772 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 3773 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 3774 | |||
| 3775 | **HierarchyType:** HierarchyType describes the structure of a hierarchical codelist. A hierarchical code list is defined as an organised collection of codes that may participate in many parent/child relationships with other codes in the list. | ||
| 3776 | |||
| 3777 | Derivation: | ||
| 3778 | |||
| 3779 | AnnotableType (extension) | ||
| 3780 | IdentifiableType (extension) | ||
| 3781 | NameableType (extension) | ||
| 3782 | VersionableType (restriction) | ||
| 3783 | MaintainableBaseType (extension) | ||
| 3784 | MaintainableType (restriction) | ||
| 3785 | HierarchyBaseType (extension) | ||
| 3786 | HierarchyType | ||
| 3787 | |||
| 3788 | Attributes: | ||
| 3789 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, hasFormalLevels | ||
| 3790 | |||
| 3791 | Content: | ||
| 3792 | Annotations?, Link*, Name+, Description*, Level?, HierarchicalCode+ | ||
| 3793 | |||
| 3794 | Attribute Documentation: | ||
| 3795 | |||
| 3796 | |**Name**|**Type**|**Documentation**| | ||
| 3797 | |id|IDType|The id is the identifier for the object.| | ||
| 3798 | |urn|HierarchyUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3799 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3800 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 3801 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 3802 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 3803 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 3804 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 3805 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 3806 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 3807 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 3808 | |hasFormalLevels|xs:boolean|If “true”, this indicates a hierarchy where the structure is arranged in levels of detail from the broadest to the most detailed level. If “false”, this indicates a hierarchy structure where the items in the hierarchy have no formal level structure.| | ||
| 3809 | |||
| 3810 | Element Documentation: | ||
| 3811 | |||
| 3812 | |**Name**|**Type**|**Documentation**| | ||
| 3813 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3814 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3815 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 3816 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 3817 | |Level|LevelType|In a formally leveled hierarchy, Level 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. In a value based hierarchy Level describes information about the codes at the specified nesting level. This structure is recursive to indicate the hierarchy of the levels.| | ||
| 3818 | |HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to assemble the codes from the codelist(s) referenced into a hierarchy.| | ||
| 3819 | |||
| 3820 | **HierarchicalCodeBaseType:** HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri. | ||
| 3821 | |||
| 3822 | Derivation: | ||
| 3823 | |||
| 3824 | AnnotableType (extension) | ||
| 3825 | IdentifiableType (extension) | ||
| 3826 | HierarchicalCodeBaseType | ||
| 3827 | |||
| 3828 | Attributes: | ||
| 3829 | id, urn?, uri? | ||
| 3830 | |||
| 3831 | Content: | ||
| 3832 | Annotations?, Link | ||
| 3833 | |||
| 3834 | Attribute Documentation: | ||
| 3835 | |||
| 3836 | |**Name**|**Type**|**Documentation**| | ||
| 3837 | |id|IDType|The id attribute allows for an id to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures.| | ||
| 3838 | |urn|HierarchicalCodeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3839 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3840 | |||
| 3841 | Element Documentation: | ||
| 3842 | |||
| 3843 | |**Name**|**Type**|**Documentation**| | ||
| 3844 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3845 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3846 | |||
| 3847 | **HierarchicalCodeType:** HierarchicalCodeType describes the structure of a hierarchical code. A hierarchical code provides for a reference to a code that is referenced within the hierarchical code list via either a complete reference to a code through either a URN or full set of reference fields. Codes are arranged in a hierarchy by this reference. Note that it is possible to reference a single code such that it has multiple parents within the hierarchy. Further, the hierarchy may or may not be a leveled one. | ||
| 3848 | |||
| 3849 | Derivation: | ||
| 3850 | |||
| 3851 | AnnotableType (extension) | ||
| 3852 | IdentifiableType (extension) | ||
| 3853 | HierarchicalCodeBaseType (extension) | ||
| 3854 | HierarchicalCodeType | ||
| 3855 | |||
| 3856 | Attributes: | ||
| 3857 | id, urn?, uri?, validFrom?, validTo? | ||
| 3858 | |||
| 3859 | Content: | ||
| 3860 | Annotations?, Link*, Code, HierarchicalCode*, Level? | ||
| 3861 | |||
| 3862 | Attribute Documentation: | ||
| 3863 | |||
| 3864 | |**Name**|**Type**|**Documentation** | ||
| 3865 | |id|IDType|The id attribute allows for an id to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures. | ||
| 3866 | |urn|HierarchicalCodeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 3867 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 3868 | |validFrom|xs:dateTime|The validFrom attriubte indicates the point in time in which the hiearchical code became effective. This can be used to track the historicity of codes changing over time. | ||
| 3869 | |validTo|xs:dateTime|The validTo attriubte indicates the point in time in which the hiearchical code became no longer effective. This can be used to track the historicity of codes changing over time. | ||
| 3870 | |||
| 3871 | Element Documentation: | ||
| 3872 | |||
| 3873 | |**Name**|**Type**|**Documentation** | ||
| 3874 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 3875 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 3876 | |Code|CodeReferenceType|Code provides a complete, explicit reference to a code through either its URN, or a complete reference to the codelist and code. | ||
| 3877 | |HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to nest referenced codes into a value based hierarchy. | ||
| 3878 | |Level|IDType|Level references a formal level defined within the hierarchy which defines this hierarchical code. This is only necessary if the nesting depth of the hierarchical code does not correspond to the nesting depth of the level to which it belongs (i.e. the hieararchical code is to skip down a level). Otherwise, the code is assumed to exist at the level in which the nesting depth of the level matches the nesting depth of the code. | ||
| 3879 | |||
| 3880 | **LevelBaseType:** LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id. | ||
| 3881 | |||
| 3882 | Derivation: | ||
| 3883 | |||
| 3884 | AnnotableType (extension) | ||
| 3885 | IdentifiableType (extension) | ||
| 3886 | NameableType (restriction) | ||
| 3887 | LevelBaseType | ||
| 3888 | |||
| 3889 | Attributes: | ||
| 3890 | id, urn?, uri? | ||
| 3891 | |||
| 3892 | Content: | ||
| 3893 | Annotations?, Link*, Name+, Description | ||
| 3894 | |||
| 3895 | Attribute Documentation: | ||
| 3896 | |||
| 3897 | |**Name**|**Type**|**Documentation**| | ||
| 3898 | |id|IDType|The id is the identifier for the object.| | ||
| 3899 | |urn|LevelUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3900 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3901 | |||
| 3902 | Element Documentation: | ||
| 3903 | |||
| 3904 | |**Name**|**Type**|**Documentation**| | ||
| 3905 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3906 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3907 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 3908 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 3909 | |||
| 3910 | **LevelType:** LevelType describes a level in a hierarchical codelist. Where level is defined as a group where codes can be characterised by homogeneous coding, and where the parent of each code in the group is at the same higher level of the hierarchy. | ||
| 3911 | |||
| 3912 | Derivation: | ||
| 3913 | |||
| 3914 | AnnotableType (extension) | ||
| 3915 | IdentifiableType (extension) | ||
| 3916 | NameableType (restriction) | ||
| 3917 | LevelBaseType (extension) | ||
| 3918 | LevelType | ||
| 3919 | |||
| 3920 | Attributes: | ||
| 3921 | |||
| 3922 | id, urn?, uri? | ||
| 3923 | |||
| 3924 | Content: | ||
| 3925 | |||
| 3926 | Annotations?, Link*, Name+, Description*, CodingFormat?, Level? | ||
| 3927 | |||
| 3928 | Attribute Documentation: | ||
| 3929 | |||
| 3930 | |**Name**|**Type**|**Documentation**| | ||
| 3931 | |id|IDType|The id is the identifier for the object.| | ||
| 3932 | |urn|LevelUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 3933 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 3934 | |||
| 3935 | Element Documentation: | ||
| 3936 | |||
| 3937 | |**Name**|**Type**|**Documentation**| | ||
| 3938 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 3939 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 3940 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 3941 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 3942 | |CodingFormat|CodingTextFormatType|CodingFormat specifies the text formatting of the codes in this level. This includes facets such as the expected characters and the length of the codes.| | ||
| 3943 | |Level|LevelType|Level describes the next level down in the hierarchy.| | ||
| 3944 | |||
| 3945 | **CodingTextFormatType:** | ||
| 3946 | |||
| 3947 | Derivation: | ||
| 3948 | |||
| 3949 | TextFormatType (restriction) | ||
| 3950 | BasicComponentTextFormatType (restriction) | ||
| 3951 | SimpleComponentTextFormatType (restriction) | ||
| 3952 | CodingTextFormatType | ||
| 3953 | |||
| 3954 | Attributes: | ||
| 3955 | textType?, isSequence?, interval?, startValue?, endValue?, minLength?, maxLength?, minValue?, maxValue?, pattern? | ||
| 3956 | |||
| 3957 | Content: | ||
| 3958 | |||
| 3959 | {Empty} | ||
| 3960 | |||
| 3961 | Attribute Documentation: | ||
| 3962 | |||
| 3963 | |**Name**|**Type**|**Documentation**| | ||
| 3964 | |textType|SimpleCodeDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.| | ||
| 3965 | |isSequence|xs:boolean|The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely.| | ||
| 3966 | |interval|xs:integer|The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true.| | ||
| 3967 | |startValue|xs:positiveInteger|The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.| | ||
| 3968 | |endValue|xs:positiveInteger|The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence.| | ||
| 3969 | |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.| | ||
| 3970 | |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.| | ||
| 3971 | |minValue|xs:positiveInteger|The minValue attribute 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 will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.| | ||
| 3972 | |maxValue|xs:positiveInteger|The maxValue attribute 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 will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.| | ||
| 3973 | |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.| | ||
| 3974 | |||
| 3975 | ***HierarchyAssociationBaseType*:** HierarchyAssociationBaseType defines the base refinement of the HierarchyAssociationType. Its purpose is to retrict the urn attribute. | ||
| 3976 | |||
| 3977 | Derivation: | ||
| 3978 | |||
| 3979 | AnnotableType (extension) | ||
| 3980 | IdentifiableType (extension) | ||
| 3981 | NameableType (extension) | ||
| 3982 | VersionableType (restriction) | ||
| 3983 | MaintainableBaseType (extension) | ||
| 3984 | MaintainableType (restriction) | ||
| 3985 | HierarchyAssociationBaseType | ||
| 3986 | |||
| 3987 | Attributes: | ||
| 3988 | |||
| 3989 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 3990 | |||
| 3991 | Content: | ||
| 3992 | |||
| 3993 | Annotations?, Link*, Name+, Description | ||
| 3994 | |||
| 3995 | Attribute Documentation: | ||
| 3996 | |||
| 3997 | |**Name**|**Type**|**Documentation** | ||
| 3998 | |id|IDType|The id is the identifier for the object. | ||
| 3999 | |urn|HierarchyAssociation UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 4000 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 4001 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 4002 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 4003 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 4004 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 4005 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 4006 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 4007 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 4008 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 4009 | |||
| 4010 | Element Documentation: | ||
| 4011 | |||
| 4012 | |**Name**|**Type**|**Documentation**| | ||
| 4013 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4014 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4015 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4016 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4017 | |||
| 4018 | **HierarchyAssociationType:** HierarchyAssociationType defines the structure of a hiearchy association, which links a hierarchy with and identifiable object in the context of another object (e.g. a dimension within the context of a dataflow). | ||
| 4019 | |||
| 4020 | Derivation: | ||
| 4021 | |||
| 4022 | AnnotableType (extension) | ||
| 4023 | IdentifiableType (extension) | ||
| 4024 | NameableType (extension) | ||
| 4025 | VersionableType (restriction) | ||
| 4026 | MaintainableBaseType (extension) | ||
| 4027 | MaintainableType (restriction) | ||
| 4028 | HierarchyAssociationType | ||
| 4029 | |||
| 4030 | Attributes: | ||
| 4031 | |||
| 4032 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 4033 | |||
| 4034 | Content: | ||
| 4035 | |||
| 4036 | Annotations?, Link*, Name+, Description*, LinkedHierarchy, LinkedObject, ContextObject? | ||
| 4037 | |||
| 4038 | Attribute Documentation: | ||
| 4039 | |||
| 4040 | |**Name**|**Type**|**Documentation**| | ||
| 4041 | |id|IDType|The id is the identifier for the object.| | ||
| 4042 | |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4043 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4044 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 4045 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 4046 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 4047 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 4048 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 4049 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 4050 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 4051 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 4052 | |||
| 4053 | Element Documentation: | ||
| 4054 | |||
| 4055 | |**Name**|**Type**|**Documentation**| | ||
| 4056 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4057 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4058 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4059 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4060 | |LinkedHierarchy|HierarchyReferenceType|The associated hierarchy.| | ||
| 4061 | |LinkedObject|UrnReferenceType|Associates the Identifiable Artefact that needs the Hierarchy.| | ||
| 4062 | |ContextObject|UrnReferenceType|The context within which the association is performed.| | ||
| 4063 | |||
| 4064 | ***MetadataflowBaseType*:** MetadataflowBaseType is an abstract base type that serves as the basis for the MetadataflowType. It restricts the structure to reference a metadata structure definition. | ||
| 4065 | |||
| 4066 | Derivation: | ||
| 4067 | |||
| 4068 | AnnotableType (extension) | ||
| 4069 | IdentifiableType (extension) | ||
| 4070 | NameableType (extension) | ||
| 4071 | VersionableType (restriction) | ||
| 4072 | MaintainableBaseType (extension) | ||
| 4073 | MaintainableType (restriction) | ||
| 4074 | StructureUsageType (restriction) | ||
| 4075 | MetadataflowBaseType | ||
| 4076 | |||
| 4077 | Attributes: | ||
| 4078 | |||
| 4079 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 4080 | |||
| 4081 | Content: | ||
| 4082 | |||
| 4083 | Annotations?, Link*, Name+, Description*, Structure? | ||
| 4084 | |||
| 4085 | Attribute Documentation: | ||
| 4086 | |||
| 4087 | |**Name**|**Type**|**Documentation**| | ||
| 4088 | |id|IDType|The id is the identifier for the object.| | ||
| 4089 | |urn|MetadataflowUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4090 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4091 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 4092 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 4093 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 4094 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 4095 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 4096 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 4097 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 4098 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 4099 | |||
| 4100 | Element Documentation: | ||
| 4101 | |||
| 4102 | |**Name**|**Type**|**Documentation**| | ||
| 4103 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4104 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4105 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4106 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4107 | |Structure|MetadataStructureReferenceType|Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow.| | ||
| 4108 | |||
| 4109 | **MetadataflowType:** MetadataflowType describes the structure of a metadata flow. A dataflow is defined as the structure of reference metadata that will be provided for different reference periods. If this type is not referenced externally, then a reference to a metadata structure definition must be provided | ||
| 4110 | |||
| 4111 | Derivation: | ||
| 4112 | |||
| 4113 | AnnotableType (extension) | ||
| 4114 | IdentifiableType (extension) | ||
| 4115 | NameableType (extension) | ||
| 4116 | VersionableType (restriction) | ||
| 4117 | MaintainableBaseType (extension) | ||
| 4118 | MaintainableType (restriction) | ||
| 4119 | StructureUsageType (restriction) | ||
| 4120 | MetadataflowBaseType (extension) | ||
| 4121 | MetadataflowType | ||
| 4122 | |||
| 4123 | Attributes: | ||
| 4124 | |||
| 4125 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 4126 | |||
| 4127 | Content: | ||
| 4128 | |||
| 4129 | Annotations?, Link*, Name+, Description*, Structure?, Target+ | ||
| 4130 | |||
| 4131 | Attribute Documentation: | ||
| 4132 | |||
| 4133 | |**Name**|**Type**|**Documentation**| | ||
| 4134 | |id|IDType|The id is the identifier for the object.| | ||
| 4135 | |urn|MetadataflowUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4136 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4137 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 4138 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 4139 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 4140 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 4141 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 4142 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 4143 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 4144 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 4145 | |||
| 4146 | Element Documentation: | ||
| 4147 | |||
| 4148 | |**Name**|**Type**|**Documentation**| | ||
| 4149 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4150 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4151 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4152 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4153 | |Structure|MetadataStructureRef erenceType|Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow.| | ||
| 4154 | |Target|WildcardUrnType|References identifiable structures to which the refernece metadata described by the referenced metadata structure should be restricted to. These references may include wildcards for parts of the reference.| | ||
| 4155 | |||
| 4156 | **MetadataStructureType:** MetadataStructureType is used to describe a metadata structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata. | ||
| 4157 | |||
| 4158 | Derivation: | ||
| 4159 | |||
| 4160 | AnnotableType (extension) | ||
| 4161 | IdentifiableType (extension) | ||
| 4162 | NameableType (extension) | ||
| 4163 | VersionableType (restriction) | ||
| 4164 | MaintainableBaseType (extension) | ||
| 4165 | MaintainableType (restriction) | ||
| 4166 | StructureType (restriction) | ||
| 4167 | MetadataStructureType | ||
| 4168 | |||
| 4169 | Attributes: | ||
| 4170 | |||
| 4171 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 4172 | |||
| 4173 | Content: | ||
| 4174 | |||
| 4175 | Annotations?, Link*, Name+, Description*, MetadataStructureComponents? | ||
| 4176 | |||
| 4177 | Attribute Documentation: | ||
| 4178 | |||
| 4179 | |**Name**|**Type**|**Documentation**| | ||
| 4180 | |id|IDType|The id is the identifier for the object.| | ||
| 4181 | |urn|MetadataStructureUrn Type|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4182 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4183 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 4184 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 4185 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 4186 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 4187 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 4188 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 4189 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 4190 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 4191 | |||
| 4192 | Element Documentation: | ||
| 4193 | |||
| 4194 | |**Name**|**Type**|**Documentation**| | ||
| 4195 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4196 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4197 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4198 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4199 | |MetadataStructureCom ponents|MetadataStructureCom ponentsType|MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition.| | ||
| 4200 | |||
| 4201 | **MetadataStructureComponentsBaseType:** MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType. | ||
| 4202 | |||
| 4203 | Derivation: | ||
| 4204 | |||
| 4205 | GroupingType (restriction) | ||
| 4206 | MetadataStructureComponentsBaseType | ||
| 4207 | |||
| 4208 | Content: | ||
| 4209 | |||
| 4210 | {Empty} | ||
| 4211 | |||
| 4212 | **MetadataStructureComponentsType:** MetadataStructureComponentsType describes the structure of the grouping of the sets of the components that make up the metadata structure definition. | ||
| 4213 | |||
| 4214 | Derivation: | ||
| 4215 | |||
| 4216 | GroupingType (restriction) | ||
| 4217 | MetadataStructureComponentsBaseType (extension) | ||
| 4218 | MetadataStructureComponentsType | ||
| 4219 | |||
| 4220 | Content: | ||
| 4221 | |||
| 4222 | MetadataAttributeList | ||
| 4223 | |||
| 4224 | Element Documentation: | ||
| 4225 | |||
| 4226 | |**Name**|**Type**|**Documentation** | ||
| 4227 | |MetadataAttributeList|MetadataAttributeListType|MetadataAttributeList defines the set of metadata attributes that can be defined as a hierarchy, for reporting reference metadata about a target object. The identification of metadata attributes must be unique at any given level of the metadata structure. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a metadata attribute takes its identity cannot be validated against this constraint. Therefore, systems processing metadata structure definitions will have to perform this check outside of the XML validation. | ||
| 4228 | |||
| 4229 | **MetadataAttributeListType:** MetadataAttributeListType describes the structure of a meta data attribute list. It comprises a set of metadata attributes that can be defined as a hierarchy. | ||
| 4230 | |||
| 4231 | Derivation: | ||
| 4232 | |||
| 4233 | AnnotableType (extension) | ||
| 4234 | IdentifiableType (extension) | ||
| 4235 | ComponentListType (restriction) | ||
| 4236 | MetadataAttributeListType | ||
| 4237 | |||
| 4238 | Attributes: | ||
| 4239 | |||
| 4240 | id?, urn?, uri? | ||
| 4241 | |||
| 4242 | Content: | ||
| 4243 | |||
| 4244 | Annotations?, Link*, MetadataAttribute+ | ||
| 4245 | |||
| 4246 | Attribute Documentation: | ||
| 4247 | |||
| 4248 | |**Name**|**Type**|**Documentation**| | ||
| 4249 | |id (fixed: MetadataAttributeDescriptor)|IDType|The id attribute is provided in this case for completeness. However, its value is fixed to MetadataAttributeDescriptor.| | ||
| 4250 | |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4251 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4252 | |||
| 4253 | Element Documentation: | ||
| 4254 | |||
| 4255 | |**Name**|**Type**|**Documentation**| | ||
| 4256 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4257 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4258 | |MetadataAttribute|MetadataAttributeType|MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition.| | ||
| 4259 | |||
| 4260 | **MetadataAttributeBaseType:** MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType. | ||
| 4261 | |||
| 4262 | Derivation: | ||
| 4263 | |||
| 4264 | AnnotableType (extension) | ||
| 4265 | IdentifiableType (extension) | ||
| 4266 | ComponentBaseType (extension) | ||
| 4267 | ComponentType (restriction) | ||
| 4268 | MetadataAttributeBaseType | ||
| 4269 | |||
| 4270 | Attributes: | ||
| 4271 | |||
| 4272 | id?, urn?, uri? | ||
| 4273 | |||
| 4274 | Content: | ||
| 4275 | |||
| 4276 | Annotations?, Link*, ConceptIdentity, LocalRepresentation? | ||
| 4277 | |||
| 4278 | Attribute Documentation: | ||
| 4279 | |||
| 4280 | |**Name**|**Type**|**Documentation**| | ||
| 4281 | |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 4282 | |urn|MetadataAttributeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4283 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4284 | |||
| 4285 | Element Documentation: | ||
| 4286 | |||
| 4287 | |**Name**|**Type**|**Documentation** | ||
| 4288 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 4289 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 4290 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. | ||
| 4291 | |LocalRepresentation|MetadataAttributeRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. | ||
| 4292 | |||
| 4293 | **MetadataAttributeType:** MetadataAttributeType describes the structure of a metadata attribute. The metadata attribute takes its semantic, and in some cases it representation, from its concept identity. A metadata attribute may be coded (via the local representation), uncoded (via the text format), or take no value. In addition to this value, the metadata attribute may also specify subordinate metadata attributes. If a metadata attribute only serves the purpose of containing subordinate metadata attributes, then the isPresentational attribute should be used. Otherwise, it is assumed to also take a value. If the metadata attribute does take a value, and a representation is not defined, it will be inherited from the concept it takes its semantic from. The optional id on the metadata attribute uniquely identifies it within the metadata structured definition. If this id is not supplied, its value is assumed to be that of the concept referenced from the concept identity. Note that a metadata attribute (as identified by the id attribute) definition must be unique across the entire metadata structure definition. | ||
| 4294 | |||
| 4295 | Derivation: | ||
| 4296 | |||
| 4297 | AnnotableType (extension) | ||
| 4298 | IdentifiableType (extension) | ||
| 4299 | ComponentBaseType (extension) | ||
| 4300 | ComponentType (restriction) | ||
| 4301 | MetadataAttributeBaseType (extension) | ||
| 4302 | MetadataAttributeType | ||
| 4303 | |||
| 4304 | Attributes: | ||
| 4305 | |||
| 4306 | id?, urn?, uri?, minOccurs?, maxOccurs?, isPresentational? | ||
| 4307 | |||
| 4308 | Content: | ||
| 4309 | |||
| 4310 | Annotations?, Link*, ConceptIdentity, LocalRepresentation?, MetadataAttribute | ||
| 4311 | |||
| 4312 | Attribute Documentation: | ||
| 4313 | |||
| 4314 | |**Name**|**Type**|**Documentation**| | ||
| 4315 | |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 4316 | |urn|MetadataAttributeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4317 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4318 | |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of times this metadata attribute must occur within its parent object.| | ||
| 4319 | |maxOccurs (default: 1)|OccurenceType|The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object.| | ||
| 4320 | |isPresentational (default: false)|xs:boolean|The isPresentational attribute indicates whether the metadata attribute should allow for a value. A value of true, meaning the metadata attribute is presentational means that the attribute only contains child metadata attributes, and does not contain a value. If this attribute is not set to true, and a representation (coded or uncoded) is not defined, then the representation of the metadata attribute will be inherited from the concept from which it takes its identity.| | ||
| 4321 | |||
| 4322 | Element Documentation: | ||
| 4323 | |||
| 4324 | |**Name**|**Type**|**Documentation**| | ||
| 4325 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4326 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4327 | |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.| | ||
| 4328 | |LocalRepresentation|MetadataAttributeRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.| | ||
| 4329 | |MetadataAttribute|MetadataAttributeType|MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition.| | ||
| 4330 | |||
| 4331 | **MetadataAttributeRepresentationType:** MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute. | ||
| 4332 | |||
| 4333 | Derivation: | ||
| 4334 | |||
| 4335 | RepresentationType (restriction) | ||
| 4336 | MetadataAttributeRepresentationType | ||
| 4337 | |||
| 4338 | Content: | ||
| 4339 | |||
| 4340 | (TextFormat|(Enumeration, EnumerationFormat?)) | ||
| 4341 | |||
| 4342 | Element Documentation: | ||
| 4343 | |||
| 4344 | |**Name**|**Type**|**Documentation**| | ||
| 4345 | |TextFormat|BasicComponentTextFormatType|TextFormat describes an uncoded textual format.| | ||
| 4346 | |Enumeration|CodelistReferenceType|Enumeration references an item scheme that enumerates the allowable values for this representation.| | ||
| 4347 | |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.| | ||
| 4348 | |||
| 4349 | ***OrganisationSchemeBaseType*:** OrganisationSchemeBaseType is an abstract base type for any organisation scheme. | ||
| 4350 | |||
| 4351 | Derivation: | ||
| 4352 | |||
| 4353 | AnnotableType (extension) | ||
| 4354 | IdentifiableType (extension) | ||
| 4355 | NameableType (extension) | ||
| 4356 | VersionableType (restriction) | ||
| 4357 | MaintainableBaseType (extension) | ||
| 4358 | MaintainableType (restriction) | ||
| 4359 | ItemSchemeType (restriction) | ||
| 4360 | OrganisationSchemeBaseType | ||
| 4361 | |||
| 4362 | Attributes: | ||
| 4363 | |||
| 4364 | id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial? | ||
| 4365 | |||
| 4366 | Content: | ||
| 4367 | |||
| 4368 | Annotations?, Link*, Name+, Description | ||
| 4369 | |||
| 4370 | Attribute Documentation: | ||
| 4371 | |||
| 4372 | |**Name**|**Type**|**Documentation**| | ||
| 4373 | |id|IDType|The id is the identifier for the object.| | ||
| 4374 | |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4375 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4376 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 4377 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 4378 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 4379 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 4380 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 4381 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 4382 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 4383 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.| | ||
| 4384 | |||
| 4385 | Element Documentation: | ||
| 4386 | |||
| 4387 | |**Name**|**Type**|**Documentation**| | ||
| 4388 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4389 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4390 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4391 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4392 | |||
| 4393 | **OrganisationSchemeType:** OrganisationSchemeType describes the structure of an organisation scheme. | ||
| 4394 | |||
| 4395 | Derivation: | ||
| 4396 | |||
| 4397 | AnnotableType (extension) | ||
| 4398 | IdentifiableType (extension) | ||
| 4399 | NameableType (extension) | ||
| 4400 | VersionableType (restriction) | ||
| 4401 | MaintainableBaseType (extension) | ||
| 4402 | MaintainableType (restriction) | ||
| 4403 | ItemSchemeType (restriction) | ||
| 4404 | OrganisationSchemeBaseType (extension) | ||
| 4405 | OrganisationSchemeType | ||
| 4406 | |||
| 4407 | Attributes: | ||
| 4408 | |||
| 4409 | id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial? | ||
| 4410 | |||
| 4411 | Content: | ||
| 4412 | |||
| 4413 | Annotations?, Link*, Name+, Description*, Organisation* | ||
| 4414 | |||
| 4415 | Attribute Documentation: | ||
| 4416 | |||
| 4417 | |**Name**|**Type**|**Documentation**| | ||
| 4418 | |id|IDType|The id is the identifier for the object.| | ||
| 4419 | |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4420 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4421 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 4422 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 4423 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 4424 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 4425 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 4426 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 4427 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 4428 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.| | ||
| 4429 | |||
| 4430 | Element Documentation: | ||
| 4431 | |||
| 4432 | |(% style="width:120px" %)**Name**|(% style="width:175px" %)**Type**|**Documentation**| | ||
| 4433 | |(% style="width:120px" %)Annotations|(% style="width:175px" %)AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4434 | |(% style="width:120px" %)Link|(% style="width:175px" %)LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4435 | |(% style="width:120px" %)Name|(% style="width:175px" %)TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4436 | |(% style="width:120px" %)Description|(% style="width:175px" %)TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4437 | |(% style="width:120px" %)//Organisation//|(% style="width:175px" %)//OrganisationType//|Organisation is an abstract substitution head for a generic organisation.| | ||
| 4438 | |||
| 4439 | **BaseOrganisationType:** BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType. | ||
| 4440 | |||
| 4441 | Derivation: | ||
| 4442 | |||
| 4443 | AnnotableType (extension) | ||
| 4444 | IdentifiableType (extension) | ||
| 4445 | NameableType (restriction) | ||
| 4446 | ItemBaseType (extension) | ||
| 4447 | ItemType (restriction) | ||
| 4448 | BaseOrganisationType | ||
| 4449 | |||
| 4450 | Attributes: | ||
| 4451 | |||
| 4452 | id, urn?, uri? | ||
| 4453 | |||
| 4454 | Content: | ||
| 4455 | |||
| 4456 | Annotations?, Link*, Name+, Description*, Parent? | ||
| 4457 | |||
| 4458 | Attribute Documentation: | ||
| 4459 | |||
| 4460 | |**Name**|**Type**|**Documentation**| | ||
| 4461 | |id|IDType|The id is the identifier for the object.| | ||
| 4462 | |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4463 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4464 | |||
| 4465 | Element Documentation: | ||
| 4466 | |||
| 4467 | |**Name**|**Type**|**Documentation**| | ||
| 4468 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4469 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4470 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4471 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4472 | |Parent|IDType|If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship.| | ||
| 4473 | |||
| 4474 | **OrganisationType:** OrganisationType in an abstract type which describes the structure of the details of an organisation. In addition to the basic organisation identification, contact details can be provided. | ||
| 4475 | |||
| 4476 | Derivation: | ||
| 4477 | |||
| 4478 | AnnotableType (extension) | ||
| 4479 | IdentifiableType (extension) | ||
| 4480 | NameableType (restriction) | ||
| 4481 | ItemBaseType (extension) | ||
| 4482 | ItemType (restriction) | ||
| 4483 | BaseOrganisationType (extension) | ||
| 4484 | OrganisationType | ||
| 4485 | |||
| 4486 | Attributes: | ||
| 4487 | |||
| 4488 | id, urn?, uri? | ||
| 4489 | |||
| 4490 | Content: | ||
| 4491 | |||
| 4492 | Annotations?, Link*, Name+, Description*, Parent?, Contact | ||
| 4493 | |||
| 4494 | Attribute Documentation: | ||
| 4495 | |||
| 4496 | |**Name**|**Type**|**Documentation**| | ||
| 4497 | |id|IDType|The id is the identifier for the object.| | ||
| 4498 | |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4499 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4500 | |||
| 4501 | Element Documentation: | ||
| 4502 | |||
| 4503 | |**Name**|**Type**|**Documentation**| | ||
| 4504 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4505 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4506 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4507 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4508 | |Parent|IDType|If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship.| | ||
| 4509 | |Contact|ContactType|Contact describes a contact for the organisation,| | ||
| 4510 | |||
| 4511 | **AgencySchemeType:** AgencySchemeType defines a specific type of organisation scheme which contains only maintenance agencies. The agency scheme maintained by a particular maintenance agency is always provided a fixed identifier and is never versioned. Therefore, agencies can be added or removed without have to version the scheme. Agencies schemes have no hierarchy, meaning that no agency may define a relationship with another agency in the scheme. In fact, the actual parent agency for an agency in a scheme is the agency which defines the scheme. | ||
| 4512 | |||
| 4513 | Derivation: | ||
| 4514 | |||
| 4515 | AnnotableType (extension) | ||
| 4516 | IdentifiableType (extension) | ||
| 4517 | NameableType (extension) | ||
| 4518 | VersionableType (restriction) | ||
| 4519 | MaintainableBaseType (extension) | ||
| 4520 | MaintainableType (restriction) | ||
| 4521 | ItemSchemeType (restriction) | ||
| 4522 | OrganisationSchemeBaseType (extension) | ||
| 4523 | OrganisationSchemeType (restriction) | ||
| 4524 | AgencySchemeType | ||
| 4525 | |||
| 4526 | Attributes: | ||
| 4527 | |||
| 4528 | id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial? | ||
| 4529 | |||
| 4530 | Content: | ||
| 4531 | |||
| 4532 | Annotations?, Link*, Name+, Description*, Agency | ||
| 4533 | |||
| 4534 | Attribute Documentation: | ||
| 4535 | |||
| 4536 | |**Name**|**Type**|**Documentation**| | ||
| 4537 | |id (fixed: AGENCIES)|IDType|The id is the identifier for the object.| | ||
| 4538 | |urn|AgencySchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4539 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4540 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 4541 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 4542 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 4543 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 4544 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 4545 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 4546 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 4547 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.| | ||
| 4548 | |||
| 4549 | Element Documentation: | ||
| 4550 | |||
| 4551 | |**Name**|**Type**|**Documentation**| | ||
| 4552 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4553 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4554 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4555 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4556 | |Agency|AgencyType|Agency is an organisation which maintains structural metadata such as classifications, concepts, data structures, and metadata structures.| | ||
| 4557 | |||
| 4558 | **DataConsumerSchemeType:** DataConsumerSchemeType defines a type of organisation scheme which contains only data consumers. The data consumer scheme maintained by a particular maintenance agency is always provided a fixed identifier and is never versioned. Therefore, consumers can be added or removed without have to version the scheme. This scheme has no hierarchy, meaning that no organisation may define a relationship with another organisation in the scheme. | ||
| 4559 | |||
| 4560 | Derivation: | ||
| 4561 | |||
| 4562 | AnnotableType (extension) | ||
| 4563 | IdentifiableType (extension) | ||
| 4564 | NameableType (extension) | ||
| 4565 | VersionableType (restriction) | ||
| 4566 | MaintainableBaseType (extension) | ||
| 4567 | MaintainableType (restriction) | ||
| 4568 | ItemSchemeType (restriction) | ||
| 4569 | OrganisationSchemeBaseType (extension) | ||
| 4570 | OrganisationSchemeType (restriction) | ||
| 4571 | DataConsumerSchemeType | ||
| 4572 | |||
| 4573 | Attributes: | ||
| 4574 | |||
| 4575 | id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial? | ||
| 4576 | |||
| 4577 | Content: | ||
| 4578 | |||
| 4579 | Annotations?, Link*, Name+, Description*, DataConsumer | ||
| 4580 | |||
| 4581 | Attribute Documentation: | ||
| 4582 | |||
| 4583 | |**Name**|**Type**|**Documentation**| | ||
| 4584 | |id (fixed: DATA\_CONSUMERS)|IDType|The id is the identifier for the object.| | ||
| 4585 | |urn|DataConsumerSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4586 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4587 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 4588 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 4589 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 4590 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 4591 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 4592 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 4593 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 4594 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.| | ||
| 4595 | |||
| 4596 | Element Documentation: | ||
| 4597 | |||
| 4598 | |**Name**|**Type**|**Documentation**| | ||
| 4599 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4600 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4601 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4602 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4603 | |DataConsumer|DataConsumerType|DataConsumer describes an organisation using data as input for further processing.| | ||
| 4604 | |||
| 4605 | **DataProviderSchemeType:** DataProviderSchemeType defines a type of organisation scheme which contains only data providers. The data provider scheme maintained by a particular maintenance agency is always provided a fixed identifier and is never versioned. Therefore, providers can be added or removed without have to version the scheme. This scheme has no hierarchy, meaning that no organisation may define a relationship with another organisation in the scheme | ||
| 4606 | |||
| 4607 | Derivation: | ||
| 4608 | |||
| 4609 | AnnotableType (extension) | ||
| 4610 | IdentifiableType (extension) | ||
| 4611 | NameableType (extension) | ||
| 4612 | VersionableType (restriction) | ||
| 4613 | MaintainableBaseType (extension) | ||
| 4614 | MaintainableType (restriction) | ||
| 4615 | ItemSchemeType (restriction) | ||
| 4616 | OrganisationSchemeBaseType (extension) | ||
| 4617 | OrganisationSchemeType (restriction) | ||
| 4618 | DataProviderSchemeType | ||
| 4619 | |||
| 4620 | Attributes: | ||
| 4621 | |||
| 4622 | id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial? | ||
| 4623 | |||
| 4624 | Content: | ||
| 4625 | |||
| 4626 | Annotations?, Link*, Name+, Description*, DataProvider | ||
| 4627 | |||
| 4628 | Attribute Documentation: | ||
| 4629 | |||
| 4630 | |**Name**|**Type**|**Documentation** | ||
| 4631 | |id (fixed: DATA\_PROVIDERS)|IDType|The id is the identifier for the object. | ||
| 4632 | |urn|DataProviderSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 4633 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 4634 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 4635 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 4636 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 4637 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 4638 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 4639 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 4640 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 4641 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. | ||
| 4642 | |||
| 4643 | Element Documentation: | ||
| 4644 | |||
| 4645 | |**Name**|**Type**|**Documentation** | ||
| 4646 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 4647 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 4648 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4649 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4650 | |DataProvider|DataProviderType|DataProvider describes an organisation that produces data. | ||
| 4651 | |||
| 4652 | **MetadataProviderSchemeType:** MetadataProviderSchemeType defines a type of organisation scheme which contains only metadata providers. The metadata provider scheme maintained by a particular maintenance agency is always provided a fixed identifier and is never versioned. Therefore, providers can be added or removed without have to version the scheme. This scheme has no hierarchy, meaning that no organisation may define a relationship with another organisation in the scheme | ||
| 4653 | |||
| 4654 | Derivation: | ||
| 4655 | |||
| 4656 | AnnotableType (extension) | ||
| 4657 | IdentifiableType (extension) | ||
| 4658 | NameableType (extension) | ||
| 4659 | VersionableType (restriction) | ||
| 4660 | MaintainableBaseType (extension) | ||
| 4661 | MaintainableType (restriction) | ||
| 4662 | ItemSchemeType (restriction) | ||
| 4663 | OrganisationSchemeBaseType (extension) | ||
| 4664 | OrganisationSchemeType (restriction) | ||
| 4665 | MetadataProviderSchemeType | ||
| 4666 | |||
| 4667 | Attributes: | ||
| 4668 | |||
| 4669 | id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial? | ||
| 4670 | |||
| 4671 | Content: | ||
| 4672 | |||
| 4673 | Annotations?, Link*, Name+, Description*, MetadataProvider | ||
| 4674 | |||
| 4675 | Attribute Documentation: | ||
| 4676 | |||
| 4677 | |**Name**|**Type**|**Documentation** | ||
| 4678 | |id (fixed: METADATA\_PROVIDERS)|IDType|The id is the identifier for the object. | ||
| 4679 | |urn|MetadataProviderSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 4680 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 4681 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 4682 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 4683 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 4684 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 4685 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 4686 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 4687 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 4688 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. | ||
| 4689 | |||
| 4690 | Element Documentation: | ||
| 4691 | |||
| 4692 | |**Name**|**Type**|**Documentation**| | ||
| 4693 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4694 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4695 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4696 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4697 | |MetadataProvider|MetadataProviderType|MetadataProvider describes an organisation that produces metadata .| | ||
| 4698 | |||
| 4699 | **OrganisationUnitSchemeType:** OrganisationUnitSchemeType defines a type of organisation scheme which simply defines organisations and there parent child relationships. Organisations in this scheme are assigned no particular role, and may in fact exist within the other type of organisation schemes as well. | ||
| 4700 | |||
| 4701 | Derivation: | ||
| 4702 | |||
| 4703 | AnnotableType (extension) | ||
| 4704 | IdentifiableType (extension) | ||
| 4705 | NameableType (extension) | ||
| 4706 | VersionableType (restriction) | ||
| 4707 | MaintainableBaseType (extension) | ||
| 4708 | MaintainableType (restriction) | ||
| 4709 | ItemSchemeType (restriction) | ||
| 4710 | OrganisationSchemeBaseType (extension) | ||
| 4711 | OrganisationSchemeType (restriction) | ||
| 4712 | OrganisationUnitSchemeType | ||
| 4713 | |||
| 4714 | Attributes: | ||
| 4715 | |||
| 4716 | id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial? | ||
| 4717 | |||
| 4718 | Content: | ||
| 4719 | |||
| 4720 | Annotations?, Link*, Name+, Description*, OrganisationUnit | ||
| 4721 | |||
| 4722 | Attribute Documentation: | ||
| 4723 | |||
| 4724 | |**Name**|**Type**|**Documentation**| | ||
| 4725 | |id|IDType|The id is the identifier for the object.| | ||
| 4726 | |urn|OrganisationUnitSche meUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4727 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4728 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 4729 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 4730 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 4731 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 4732 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 4733 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 4734 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 4735 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.| | ||
| 4736 | |||
| 4737 | Element Documentation: | ||
| 4738 | |||
| 4739 | |**Name**|**Type**|**Documentation**| | ||
| 4740 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4741 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4742 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4743 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4744 | |OrganisationUnit|OrganisationUnitType|OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX.| | ||
| 4745 | |||
| 4746 | **AgencyType:** AgencyType defines the structure of an agency description. The contacts defined for the organisation are specific to the agency role the organisation is serving. | ||
| 4747 | |||
| 4748 | Derivation: | ||
| 4749 | |||
| 4750 | AnnotableType (extension) | ||
| 4751 | IdentifiableType (extension) | ||
| 4752 | NameableType (restriction) | ||
| 4753 | ItemBaseType (extension) | ||
| 4754 | ItemType (restriction) | ||
| 4755 | BaseOrganisationType (extension) | ||
| 4756 | OrganisationType (restriction) | ||
| 4757 | AgencyType | ||
| 4758 | |||
| 4759 | Attributes: | ||
| 4760 | |||
| 4761 | id, urn?, uri? | ||
| 4762 | |||
| 4763 | Content: | ||
| 4764 | |||
| 4765 | Annotations?, Link*, Name+, Description*, Contact | ||
| 4766 | |||
| 4767 | Attribute Documentation: | ||
| 4768 | |||
| 4769 | |**Name**|**Type**|**Documentation**| | ||
| 4770 | |id|NCNameIDType|The id attribute holds the identification of the agency. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the agency identifier will be used as part of the name for simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).| | ||
| 4771 | |urn|AgencyUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4772 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4773 | |||
| 4774 | Element Documentation: | ||
| 4775 | |||
| 4776 | |**Name**|**Type**|**Documentation**| | ||
| 4777 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4778 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4779 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4780 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4781 | |Contact|ContactType|Contact describes a contact for the organisation,| | ||
| 4782 | |||
| 4783 | **DataConsumerType:** DataConsumerType defines the structure of a data consumer description. The contacts defined for the organisation are specific to the data consumer role the organisation is serving. | ||
| 4784 | |||
| 4785 | Derivation: | ||
| 4786 | |||
| 4787 | AnnotableType (extension) | ||
| 4788 | IdentifiableType (extension) | ||
| 4789 | NameableType (restriction) | ||
| 4790 | ItemBaseType (extension) | ||
| 4791 | ItemType (restriction) | ||
| 4792 | BaseOrganisationType (extension) | ||
| 4793 | OrganisationType (restriction) | ||
| 4794 | DataConsumerType | ||
| 4795 | |||
| 4796 | Attributes: | ||
| 4797 | |||
| 4798 | id, urn?, uri? | ||
| 4799 | |||
| 4800 | Content: | ||
| 4801 | |||
| 4802 | Annotations?, Link*, Name+, Description*, Contact | ||
| 4803 | |||
| 4804 | Attribute Documentation: | ||
| 4805 | |||
| 4806 | |**Name**|**Type**|**Documentation**| | ||
| 4807 | |id|IDType|The id is the identifier for the object.| | ||
| 4808 | |urn|DataConsumerUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4809 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4810 | |||
| 4811 | Element Documentation: | ||
| 4812 | |||
| 4813 | |**Name**|**Type**|**Documentation**| | ||
| 4814 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4815 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4816 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4817 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4818 | |Contact|ContactType|Contact describes a contact for the organisation,| | ||
| 4819 | |||
| 4820 | **DataProviderType:** DataProviderType defines the structure of a data provider description. The contacts defined for the organisation are specific to the data provider role the organisation is serving. | ||
| 4821 | |||
| 4822 | Derivation: | ||
| 4823 | |||
| 4824 | AnnotableType (extension) | ||
| 4825 | IdentifiableType (extension) | ||
| 4826 | NameableType (restriction) | ||
| 4827 | ItemBaseType (extension) | ||
| 4828 | ItemType (restriction) | ||
| 4829 | BaseOrganisationType (extension) | ||
| 4830 | OrganisationType (restriction) | ||
| 4831 | DataProviderType | ||
| 4832 | |||
| 4833 | Attributes: | ||
| 4834 | |||
| 4835 | id, urn?, uri? | ||
| 4836 | |||
| 4837 | Content: | ||
| 4838 | |||
| 4839 | Annotations?, Link*, Name+, Description*, Contact | ||
| 4840 | |||
| 4841 | Attribute Documentation: | ||
| 4842 | |||
| 4843 | |**Name**|**Type**|**Documentation**| | ||
| 4844 | |id|IDType|The id is the identifier for the object.| | ||
| 4845 | |urn|DataProviderUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 4846 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 4847 | |||
| 4848 | Element Documentation: | ||
| 4849 | |||
| 4850 | |**Name**|**Type**|**Documentation**| | ||
| 4851 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4852 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4853 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4854 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4855 | |Contact|ContactType|Contact describes a contact for the organisation,| | ||
| 4856 | |||
| 4857 | **MetadataProviderType:** MetadataProviderType defines the structure of a metadata provider description. The contacts defined for the organisation are specific to the metadata provider role the organisation is serving. | ||
| 4858 | |||
| 4859 | Derivation: | ||
| 4860 | |||
| 4861 | AnnotableType (extension) | ||
| 4862 | IdentifiableType (extension) | ||
| 4863 | NameableType (restriction) | ||
| 4864 | ItemBaseType (extension) | ||
| 4865 | ItemType (restriction) | ||
| 4866 | BaseOrganisationType (extension) | ||
| 4867 | OrganisationType (restriction) | ||
| 4868 | MetadataProviderType | ||
| 4869 | |||
| 4870 | Attributes: | ||
| 4871 | |||
| 4872 | id, urn?, uri? | ||
| 4873 | |||
| 4874 | Content: | ||
| 4875 | |||
| 4876 | Annotations?, Link*, Name+, Description*, Contact | ||
| 4877 | |||
| 4878 | Attribute Documentation: | ||
| 4879 | |||
| 4880 | (% style="width:1051.29px" %) | ||
| 4881 | |**Name**|**Type**|(% style="width:660px" %)**Documentation** | ||
| 4882 | |id|IDType|(% style="width:660px" %)The id is the identifier for the object. | ||
| 4883 | |urn|MetadataProviderUrnType|(% style="width:660px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 4884 | |uri|xs:anyURI|(% style="width:660px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 4885 | |||
| 4886 | Element Documentation: | ||
| 4887 | |||
| 4888 | |**Name**|**Type**|**Documentation**| | ||
| 4889 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4890 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4891 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4892 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4893 | |Contact|ContactType|Contact describes a contact for the organisation,| | ||
| 4894 | |||
| 4895 | **OrganisationUnitType:** OrganisationUnitType defines the structure of an organisation unit description. In addition to general identification and contact information, an organisation unit can specify a relationship with another organisation unit from the same scheme which is its parent organisation. | ||
| 4896 | |||
| 4897 | Derivation: | ||
| 4898 | |||
| 4899 | AnnotableType (extension) | ||
| 4900 | IdentifiableType (extension) | ||
| 4901 | NameableType (restriction) | ||
| 4902 | ItemBaseType (extension) | ||
| 4903 | ItemType (restriction) | ||
| 4904 | BaseOrganisationType (extension) | ||
| 4905 | OrganisationType (restriction) | ||
| 4906 | OrganisationUnitType | ||
| 4907 | |||
| 4908 | Attributes: | ||
| 4909 | |||
| 4910 | id, urn?, uri? | ||
| 4911 | |||
| 4912 | Content: | ||
| 4913 | |||
| 4914 | Annotations?, Link*, Name+, Description*, Parent?, Contact | ||
| 4915 | |||
| 4916 | Attribute Documentation: | ||
| 4917 | |||
| 4918 | (% style="width:999.294px" %) | ||
| 4919 | |**Name**|**Type**|**Documentation** | ||
| 4920 | |id|IDType|The id is the identifier for the object. | ||
| 4921 | |urn|OrganisationUnitUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 4922 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 4923 | |||
| 4924 | Element Documentation: | ||
| 4925 | |||
| 4926 | |**Name**|**Type**|**Documentation**| | ||
| 4927 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4928 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 4929 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4930 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 4931 | |Parent|IDType|If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship.| | ||
| 4932 | |Contact|ContactType|Contact describes a contact for the organisation,| | ||
| 4933 | |||
| 4934 | **ContactType:** ContactType describes the structure of a contact's details. | ||
| 4935 | |||
| 4936 | Attributes: | ||
| 4937 | |||
| 4938 | id? | ||
| 4939 | |||
| 4940 | Content: | ||
| 4941 | |||
| 4942 | Name*, Department*, Role*, (Telephone|Fax|X400|URI|Email) | ||
| 4943 | |||
| 4944 | Attribute Documentation: | ||
| 4945 | |||
| 4946 | |**Name**|**Type**|**Documentation**| | ||
| 4947 | |id|IDType|The id attribute is used to carry user id information for the contact.| | ||
| 4948 | |||
| 4949 | Element Documentation: | ||
| 4950 | |||
| 4951 | |**Name**|**Type**|**Documentation**| | ||
| 4952 | |Name|TextType|Name is a reusable element, used for providing a human-readable name for an object.| | ||
| 4953 | |Department|TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.| | ||
| 4954 | |Role|TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.| | ||
| 4955 | |Telephone|xs:string|Telephone holds the telephone number for the contact person.| | ||
| 4956 | |Fax|xs:string|Fax holds the fax number for the contact person.| | ||
| 4957 | |X400|xs:string|X400 holds the X.400 address for the contact person.| | ||
| 4958 | |URI|xs:anyURI|URI holds an information URL for the contact person.| | ||
| 4959 | |Email|xs:string|Email holds the email address for the contact person.| | ||
| 4960 | |||
| 4961 | //**ProvisionAgreementBaseType:**// ProvisionAgreementBaseType defines the base refinement of the ProvisionAgreementType. Its purpose is to retrict the urn attribute. | ||
| 4962 | |||
| 4963 | Derivation: | ||
| 4964 | |||
| 4965 | AnnotableType (extension) | ||
| 4966 | IdentifiableType (extension) | ||
| 4967 | NameableType (extension) | ||
| 4968 | VersionableType (restriction) | ||
| 4969 | MaintainableBaseType (extension) | ||
| 4970 | MaintainableType (restriction) | ||
| 4971 | ProvisionAgreementBaseType | ||
| 4972 | |||
| 4973 | Attributes: | ||
| 4974 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 4975 | |||
| 4976 | Content: | ||
| 4977 | Annotations?, Link*, Name+, Description | ||
| 4978 | |||
| 4979 | Attribute Documentation: | ||
| 4980 | |||
| 4981 | (% style="width:1155.29px" %) | ||
| 4982 | |**Name**|**Type**|(% style="width:737px" %)**Documentation** | ||
| 4983 | |id|IDType|(% style="width:737px" %)The id is the identifier for the object. | ||
| 4984 | |urn|ProvisionAgreementUrnType|(% style="width:737px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 4985 | |uri|xs:anyURI|(% style="width:737px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 4986 | |version|VersionType|(% style="width:737px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 4987 | |validFrom|xs:dateTime|(% style="width:737px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 4988 | |validTo|xs:dateTime|(% style="width:737px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 4989 | |agencyID|NestedNCNameIDType|(% style="width:737px" %)The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 4990 | |isExternalReference (default: false)|xs:boolean|(% style="width:737px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 4991 | |serviceURL|xs:anyURI|(% style="width:737px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 4992 | |structureURL|xs:anyURI|(% style="width:737px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 4993 | |isPartialLanguage (default: false)|xs:boolean|(% style="width:737px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 4994 | |||
| 4995 | Element Documentation: | ||
| 4996 | |||
| 4997 | |**Name**|**Type**|**Documentation**| | ||
| 4998 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 4999 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5000 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5001 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5002 | |||
| 5003 | **ProvisionAgreementType:** ProvisionAgreementType describes the structure of a provision agreement. A provision agreement defines an agreement for a data provider to report data against a dataflow. Attributes which describe how the registry must behave when data or metadata is registered against this provision agreement are supplied. | ||
| 5004 | |||
| 5005 | Derivation: | ||
| 5006 | |||
| 5007 | AnnotableType (extension) | ||
| 5008 | IdentifiableType (extension) | ||
| 5009 | NameableType (extension) | ||
| 5010 | VersionableType (restriction) | ||
| 5011 | MaintainableBaseType (extension) | ||
| 5012 | MaintainableType (restriction) | ||
| 5013 | ProvisionAgreementBaseType (extension) | ||
| 5014 | ProvisionAgreementType | ||
| 5015 | |||
| 5016 | Attributes: | ||
| 5017 | |||
| 5018 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5019 | |||
| 5020 | Content: | ||
| 5021 | |||
| 5022 | Annotations?, Link*, Name+, Description*, Dataflow, DataProvider | ||
| 5023 | |||
| 5024 | Attribute Documentation: | ||
| 5025 | |||
| 5026 | |**Name**|**Type**|**Documentation**| | ||
| 5027 | |id|IDType|The id is the identifier for the object.| | ||
| 5028 | |urn|ProvisionAgreementUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5029 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5030 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 5031 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 5032 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 5033 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 5034 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 5035 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 5036 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 5037 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 5038 | |||
| 5039 | Element Documentation: | ||
| 5040 | |||
| 5041 | |**Name**|**Type**|**Documentation**| | ||
| 5042 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5043 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5044 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5045 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5046 | |Dataflow|DataflowReferenceTyp e|Dataflow provides a reference to a pre-existing dataflow in the registry. The reference is provided via a URN and/or a full set of reference fields.| | ||
| 5047 | |DataProvider|DataProviderReferenc eType|DataProvider provides a reference to a pre-existing data provider in the registry. The reference is provided via a URN and/or a full set of reference fields.| | ||
| 5048 | |||
| 5049 | //**MetadataProvisionAgreementBaseType:**// MetadataProvisionAgreementBaseType defines the base refinement of the MetadataProvisionAgreementType. Its purpose is to retrict the urn attribute. | ||
| 5050 | |||
| 5051 | Derivation: | ||
| 5052 | |||
| 5053 | AnnotableType (extension) | ||
| 5054 | IdentifiableType (extension) | ||
| 5055 | NameableType (extension) | ||
| 5056 | VersionableType (restriction) | ||
| 5057 | MaintainableBaseType (extension) | ||
| 5058 | MaintainableType (restriction) | ||
| 5059 | MetadataProvisionAgreementBaseType | ||
| 5060 | |||
| 5061 | Attributes: | ||
| 5062 | |||
| 5063 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5064 | |||
| 5065 | Content: | ||
| 5066 | |||
| 5067 | Annotations?, Link*, Name+, Description | ||
| 5068 | |||
| 5069 | Attribute Documentation: | ||
| 5070 | |||
| 5071 | (% style="width:1191.29px" %) | ||
| 5072 | |**Name**|**Type**|**Documentation** | ||
| 5073 | |id|IDType|The id is the identifier for the object. | ||
| 5074 | |urn|MetadataProvisionAgreementUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5075 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 5076 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 5077 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5078 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5079 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5080 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 5081 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 5082 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 5083 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 5084 | |||
| 5085 | Element Documentation: | ||
| 5086 | |||
| 5087 | |**Name**|**Type**|**Documentation**| | ||
| 5088 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5089 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5090 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5091 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5092 | |||
| 5093 | **MetadataProvisionAgreementType:** ProvisionAgreementType describes the structure of a provision agreement. A provision agreement defines an agreement for a data provider to report data or reference metadata against a flow. Attributes which describe how the registry must behave when data or metadata is registered against this provision agreement are supplied. | ||
| 5094 | |||
| 5095 | Derivation: | ||
| 5096 | |||
| 5097 | AnnotableType (extension) | ||
| 5098 | IdentifiableType (extension) | ||
| 5099 | NameableType (extension) | ||
| 5100 | VersionableType (restriction) | ||
| 5101 | MaintainableBaseType (extension) | ||
| 5102 | MaintainableType (restriction) | ||
| 5103 | MetadataProvisionAgreementBaseType (extension) | ||
| 5104 | MetadataProvisionAgreementType | ||
| 5105 | |||
| 5106 | Attributes: | ||
| 5107 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5108 | |||
| 5109 | Content: | ||
| 5110 | Annotations?, Link*, Name+, Description*, Metadataflow, MetadataProvider, Target | ||
| 5111 | |||
| 5112 | Attribute Documentation: | ||
| 5113 | |||
| 5114 | |**Name**|**Type**|**Documentation**| | ||
| 5115 | |id|IDType|The id is the identifier for the object.| | ||
| 5116 | |urn|MetadataProvisionAgr eementUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5117 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5118 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 5119 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 5120 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 5121 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 5122 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 5123 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 5124 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 5125 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 5126 | |||
| 5127 | Element Documentation: | ||
| 5128 | |||
| 5129 | (% style="width:1114.29px" %) | ||
| 5130 | |**Name**|**Type**|(% style="width:693px" %)**Documentation** | ||
| 5131 | |Annotations|AnnotationsType|(% style="width:693px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5132 | |Link|LinkType|(% style="width:693px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 5133 | |Name|TextType|(% style="width:693px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5134 | |Description|TextType|(% style="width:693px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5135 | |Metadataflow|MetadataflowReferenceType|(% style="width:693px" %)Metadataflow provides a reference to a pre-existing metadataflow in the registry. The reference is provided via a URN and/or a full set of reference fields. | ||
| 5136 | |MetadataProvider|MetadataProviderReferenceType|(% style="width:693px" %)MetadataProvider provides a reference to a pre-existing metadata provider in the registry. The reference is provided via a URN and/or a full set of reference fields. | ||
| 5137 | |Target|WildcardUrnType|(% style="width:693px" %)References identifiable structures to which the refernece metadata described by the metadata structure used by the metadaflow should be restricted to. These references may include wildcards for parts of the reference. | ||
| 5138 | |||
| 5139 | ***ProcessBaseType*:** ProcessBaseType defines the base refinement of the ProcessType. Its purpose is to retrict the urn attribute. | ||
| 5140 | |||
| 5141 | Derivation: | ||
| 5142 | |||
| 5143 | AnnotableType (extension) | ||
| 5144 | IdentifiableType (extension) | ||
| 5145 | NameableType (extension) | ||
| 5146 | VersionableType (restriction) | ||
| 5147 | MaintainableBaseType (extension) | ||
| 5148 | MaintainableType (restriction) | ||
| 5149 | ProcessBaseType | ||
| 5150 | |||
| 5151 | Attributes: | ||
| 5152 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5153 | |||
| 5154 | Content: | ||
| 5155 | Annotations?, Link*, Name+, Description | ||
| 5156 | |||
| 5157 | Attribute Documentation: | ||
| 5158 | |||
| 5159 | |**Name**|**Type**|**Documentation**| | ||
| 5160 | |id|IDType|The id is the identifier for the object.| | ||
| 5161 | |urn|ProcessUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5162 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5163 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 5164 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 5165 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 5166 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 5167 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 5168 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 5169 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 5170 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 5171 | |||
| 5172 | Element Documentation: | ||
| 5173 | |||
| 5174 | |**Name**|**Type**|**Documentation**| | ||
| 5175 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5176 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5177 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5178 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5179 | |||
| 5180 | **ProcessType:** ProcessType describes the structure of a process, which is a scheme which defines or documents the operations performed on data in order to validate data or to derive new information according to a given set of rules. Processes occur in order, and will continue in order unless a transition dictates another step should occur. | ||
| 5181 | |||
| 5182 | Derivation: | ||
| 5183 | |||
| 5184 | AnnotableType (extension) | ||
| 5185 | IdentifiableType (extension) | ||
| 5186 | NameableType (extension) | ||
| 5187 | VersionableType (restriction) | ||
| 5188 | MaintainableBaseType (extension) | ||
| 5189 | MaintainableType (restriction) | ||
| 5190 | ProcessBaseType (extension) | ||
| 5191 | ProcessType | ||
| 5192 | |||
| 5193 | Attributes: | ||
| 5194 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5195 | |||
| 5196 | Content: | ||
| 5197 | Annotations?, Link*, Name+, Description*, ProcessStep | ||
| 5198 | |||
| 5199 | Attribute Documentation: | ||
| 5200 | |||
| 5201 | |**Name**|**Type**|**Documentation**| | ||
| 5202 | |id|IDType|The id is the identifier for the object.| | ||
| 5203 | |urn|ProcessUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5204 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5205 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 5206 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 5207 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 5208 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 5209 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 5210 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 5211 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 5212 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 5213 | |||
| 5214 | Element Documentation: | ||
| 5215 | |||
| 5216 | |**Name**|**Type**|**Documentation**| | ||
| 5217 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5218 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5219 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5220 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5221 | |ProcessStep|ProcessStepType|ProcessStep defines a process step, which is a specific operation, performed on data in order to validate or to derive new information according to a given set of rules.| | ||
| 5222 | |||
| 5223 | ***ProcessStepBaseType*:** ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType. | ||
| 5224 | |||
| 5225 | Derivation: | ||
| 5226 | |||
| 5227 | AnnotableType (extension) | ||
| 5228 | IdentifiableType (extension) | ||
| 5229 | NameableType (restriction) | ||
| 5230 | ProcessStepBaseType | ||
| 5231 | |||
| 5232 | Attributes: | ||
| 5233 | id, urn?, uri? | ||
| 5234 | |||
| 5235 | Content: | ||
| 5236 | Annotations?, Link*, Name+, Description | ||
| 5237 | |||
| 5238 | Attribute Documentation: | ||
| 5239 | |||
| 5240 | |**Name**|**Type**|**Documentation**| | ||
| 5241 | |id|IDType|The id is the identifier for the object.| | ||
| 5242 | |urn|ProcessStepUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5243 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5244 | |||
| 5245 | Element Documentation: | ||
| 5246 | |||
| 5247 | |**Name**|**Type**|**Documentation**| | ||
| 5248 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5249 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5250 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5251 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5252 | |||
| 5253 | **ProcessStepType:** ProcessStepType describes the structure of a process step. A nested process step is automatically sub-ordinate, and followed as the next step. If the following step is conditional, it should be referenced in a transition. | ||
| 5254 | |||
| 5255 | Derivation: | ||
| 5256 | |||
| 5257 | AnnotableType (extension) | ||
| 5258 | IdentifiableType (extension) | ||
| 5259 | NameableType (restriction) | ||
| 5260 | ProcessStepBaseType (extension) | ||
| 5261 | ProcessStepType | ||
| 5262 | |||
| 5263 | Attributes: | ||
| 5264 | |||
| 5265 | id, urn?, uri? | ||
| 5266 | |||
| 5267 | Content: | ||
| 5268 | |||
| 5269 | Annotations?, Link*, Name+, Description*, Input*, Output*, Computation?, Transition*, ProcessStep | ||
| 5270 | |||
| 5271 | Attribute Documentation: | ||
| 5272 | |||
| 5273 | |**Name**|**Type**|**Documentation**| | ||
| 5274 | |id|IDType|The id is the identifier for the object.| | ||
| 5275 | |urn|ProcessStepUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5276 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5277 | |||
| 5278 | Element Documentation: | ||
| 5279 | |||
| 5280 | |**Name**|**Type**|**Documentation**| | ||
| 5281 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5282 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5283 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5284 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5285 | |Input|InputOutputType|Input references an object which is an input to the process step.| | ||
| 5286 | |Output|InputOutputType|Output references an object which is an output form the process step.| | ||
| 5287 | |Computation|ComputationType|Computation describes the computations involved in the process, in any form desired by the user (these are informational rather than machine-actionable), and so may be supplied in multiple, parallel-language versions.| | ||
| 5288 | |Transition|TransitionType|Transition describes the next process steps. Each transition in a process step should be evaluated, allowing for multiple process step branches from a single process step.| | ||
| 5289 | |ProcessStep|ProcessStepType|ProcessStep defines a process step, which is a specific operation, performed on data in order to validate or to derive new information according to a given set of rules.| | ||
| 5290 | |||
| 5291 | ***TransitionBaseType*:** TransitionBaseType defines the base refinement of the TransitionType. Its purpose is to retrict the urn attribute. | ||
| 5292 | |||
| 5293 | Derivation: | ||
| 5294 | |||
| 5295 | AnnotableType (extension) | ||
| 5296 | IdentifiableType (extension) | ||
| 5297 | TransitionBaseType | ||
| 5298 | |||
| 5299 | Attributes: | ||
| 5300 | |||
| 5301 | id?, urn?, uri? | ||
| 5302 | |||
| 5303 | Content: | ||
| 5304 | |||
| 5305 | Annotations?, Link | ||
| 5306 | |||
| 5307 | Attribute Documentation: | ||
| 5308 | |||
| 5309 | |**Name**|**Type**|**Documentation**| | ||
| 5310 | |id|IDType|The id is the identifier for the object.| | ||
| 5311 | |urn|TransitionUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5312 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5313 | |||
| 5314 | Element Documentation: | ||
| 5315 | |||
| 5316 | |**Name**|**Type**|**Documentation**| | ||
| 5317 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5318 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5319 | |||
| 5320 | **TransitionType:** TransitionType describes the details of a transition, which is an expression in a textual or formalised way of the transformation of data between two specific operations performed on the data. | ||
| 5321 | |||
| 5322 | Derivation: | ||
| 5323 | |||
| 5324 | AnnotableType (extension) | ||
| 5325 | IdentifiableType (extension) | ||
| 5326 | TransitionBaseType (extension) | ||
| 5327 | TransitionType | ||
| 5328 | |||
| 5329 | Attributes: | ||
| 5330 | |||
| 5331 | id?, urn?, uri?, localID? | ||
| 5332 | |||
| 5333 | Content: | ||
| 5334 | |||
| 5335 | Annotations?, Link*, TargetStep, Condition+ | ||
| 5336 | |||
| 5337 | Attribute Documentation: | ||
| 5338 | |||
| 5339 | |**Name**|**Type**|**Documentation**| | ||
| 5340 | |id|IDType|The id is the identifier for the object.| | ||
| 5341 | |urn|TransitionUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5342 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5343 | |localID|IDType|The localID attribute is an optional identification for the transition within the process.| | ||
| 5344 | |||
| 5345 | Element Documentation: | ||
| 5346 | |||
| 5347 | |**Name**|**Type**|**Documentation**| | ||
| 5348 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5349 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5350 | |TargetStep|NestedIDType|TargetStep references a process step within the process that should be transitioned to, should the conditions described be met.| | ||
| 5351 | |Condition|TextType|Condition is a textual description of the conditions to be met in order for the target step to be proceeded to. It is informational only (not machine-actionable), and may be supplied in multiple, parallel-language form.| | ||
| 5352 | |||
| 5353 | **ComputationType:** ComputationType describes a computation in a process. | ||
| 5354 | |||
| 5355 | Derivation: | ||
| 5356 | |||
| 5357 | AnnotableType (extension) | ||
| 5358 | ComputationType | ||
| 5359 | |||
| 5360 | Attributes: | ||
| 5361 | |||
| 5362 | localID?, softwarePackage?, softwareLanguage?, softwareVersion? | ||
| 5363 | |||
| 5364 | Content: | ||
| 5365 | |||
| 5366 | Annotations?, Description+ | ||
| 5367 | |||
| 5368 | Attribute Documentation: | ||
| 5369 | |||
| 5370 | |**Name**|**Type**|**Documentation**| | ||
| 5371 | |localID|IDType|The localID attribute is an optional identification for the computation within the process.| | ||
| 5372 | |softwarePackage|xs:string|The softwarePackage attribute holds the name of the software package that is used to perform the computation.| | ||
| 5373 | |softwareLanguage|xs:string|The softwareLanguage attribute holds the coding language that the software package used to perform the computation is written in.| | ||
| 5374 | |softwareVersion|xs:string|The softwareVersion attribute hold the version of the software package that is used to perform that computation.| | ||
| 5375 | |||
| 5376 | Element Documentation: | ||
| 5377 | |||
| 5378 | |**Name**|**Type**|**Documentation**| | ||
| 5379 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5380 | |Description|TextType|Description describe the computation in any form desired by the user (these are informational rather than machine-actionable), and so may be supplied in multiple, parallel-language versions,| | ||
| 5381 | |||
| 5382 | **InputOutputType:** InputOutputType describes the structure of an input or output to a process step. It provides a reference to the object that is the input or output. | ||
| 5383 | |||
| 5384 | Derivation: | ||
| 5385 | |||
| 5386 | AnnotableType (extension) | ||
| 5387 | InputOutputType | ||
| 5388 | |||
| 5389 | Attributes: | ||
| 5390 | |||
| 5391 | localID? | ||
| 5392 | |||
| 5393 | Content: | ||
| 5394 | |||
| 5395 | Annotations?, ObjectReference | ||
| 5396 | |||
| 5397 | Attribute Documentation: | ||
| 5398 | |||
| 5399 | |**Name**|**Type**|**Documentation**| | ||
| 5400 | |localID|IDType|The localID attribute is an optional identification for the input or output within the process.| | ||
| 5401 | |||
| 5402 | Element Documentation: | ||
| 5403 | |||
| 5404 | |**Name**|**Type**|**Documentation**| | ||
| 5405 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5406 | |ObjectReference|UrnReferenceType|ObjectReference is an abstract substitution head that references the object that is an input or output. It is substituted with a concrete reference to an explicit object type.| | ||
| 5407 | |||
| 5408 | **ReportingTaxonomyType:** ReportingTaxonomyType describes the structure of a reporting taxonomy, which is a scheme which defines the composition structure of a data report where each component can be described by an independent structure or structure usage description. | ||
| 5409 | |||
| 5410 | Derivation: | ||
| 5411 | |||
| 5412 | AnnotableType (extension) | ||
| 5413 | IdentifiableType (extension) | ||
| 5414 | NameableType (extension) | ||
| 5415 | VersionableType (restriction) | ||
| 5416 | MaintainableBaseType (extension) | ||
| 5417 | MaintainableType (restriction) | ||
| 5418 | ItemSchemeType (restriction) | ||
| 5419 | ReportingTaxonomyType | ||
| 5420 | |||
| 5421 | Attributes: | ||
| 5422 | |||
| 5423 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial? | ||
| 5424 | |||
| 5425 | Content: | ||
| 5426 | |||
| 5427 | Annotations?, Link*, Name+, Description*, ReportingCategory | ||
| 5428 | |||
| 5429 | Attribute Documentation: | ||
| 5430 | |||
| 5431 | (% style="width:1245.29px" %) | ||
| 5432 | |**Name**|**Type**|(% style="width:829px" %)**Documentation** | ||
| 5433 | |id|IDType|(% style="width:829px" %)The id is the identifier for the object. | ||
| 5434 | |urn|ReportingTaxonomyUrnType|(% style="width:829px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5435 | |uri|xs:anyURI|(% style="width:829px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 5436 | |version|VersionType|(% style="width:829px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 5437 | |validFrom|xs:dateTime|(% style="width:829px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5438 | |validTo|xs:dateTime|(% style="width:829px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5439 | |agencyID|NestedNCNameIDType|(% style="width:829px" %)The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5440 | |isExternalReference (default: false)|xs:boolean|(% style="width:829px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 5441 | |serviceURL|xs:anyURI|(% style="width:829px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 5442 | |structureURL|xs:anyURI|(% style="width:829px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 5443 | |isPartialLanguage (default: false)|xs:boolean|(% style="width:829px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 5444 | |isPartial (default: false)|xs:boolean|(% style="width:829px" %)The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. | ||
| 5445 | |||
| 5446 | Element Documentation: | ||
| 5447 | |||
| 5448 | (% style="width:1249.29px" %) | ||
| 5449 | |**Name**|**Type**|(% style="width:878px" %)**Documentation** | ||
| 5450 | |Annotations|AnnotationsType|(% style="width:878px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5451 | |Link|LinkType|(% style="width:878px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 5452 | |Name|TextType|(% style="width:878px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5453 | |Description|TextType|(% style="width:878px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5454 | |ReportingCategory|ReportingCategoryType|(% style="width:878px" %)ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. | ||
| 5455 | |||
| 5456 | //**ReportingCategoryBaseType:**// ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType. | ||
| 5457 | |||
| 5458 | Derivation: | ||
| 5459 | |||
| 5460 | AnnotableType (extension) | ||
| 5461 | IdentifiableType (extension) | ||
| 5462 | NameableType (restriction) | ||
| 5463 | ItemBaseType (extension) | ||
| 5464 | ItemType (restriction) | ||
| 5465 | ReportingCategoryBaseType | ||
| 5466 | |||
| 5467 | Attributes: | ||
| 5468 | |||
| 5469 | id, urn?, uri? | ||
| 5470 | |||
| 5471 | Content: | ||
| 5472 | |||
| 5473 | Annotations?, Link*, Name+, Description*, ReportingCategory | ||
| 5474 | |||
| 5475 | Attribute Documentation: | ||
| 5476 | |||
| 5477 | (% style="width:1053.29px" %) | ||
| 5478 | |**Name**|**Type**|**Documentation** | ||
| 5479 | |id|IDType|The id is the identifier for the object. | ||
| 5480 | |urn|ReportingCategoryUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5481 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 5482 | |||
| 5483 | Element Documentation: | ||
| 5484 | |||
| 5485 | (% style="width:1060.29px" %) | ||
| 5486 | |**Name**|**Type**|**Documentation** | ||
| 5487 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5488 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 5489 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5490 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5491 | |ReportingCategory|ReportingCategoryType|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. | ||
| 5492 | |||
| 5493 | **ReportingCategoryType:** ReportingCategoryType describes the structure of a reporting category, which groups structure usages into useful sub-packages. Sub ordinate reporting categories can be nested within the category definition. | ||
| 5494 | |||
| 5495 | Derivation: | ||
| 5496 | |||
| 5497 | AnnotableType (extension) | ||
| 5498 | IdentifiableType (extension) | ||
| 5499 | NameableType (restriction) | ||
| 5500 | ItemBaseType (extension) | ||
| 5501 | ItemType (restriction) | ||
| 5502 | ReportingCategoryBaseType (extension) | ||
| 5503 | ReportingCategoryType | ||
| 5504 | |||
| 5505 | Attributes: | ||
| 5506 | |||
| 5507 | id, urn?, uri? | ||
| 5508 | |||
| 5509 | Content: | ||
| 5510 | |||
| 5511 | Annotations?, Link*, Name+, Description*, ReportingCategory*, (StructuralMetadata*|ProvisioningMetadata*) | ||
| 5512 | |||
| 5513 | Attribute Documentation: | ||
| 5514 | |||
| 5515 | (% style="width:1040.29px" %) | ||
| 5516 | |**Name**|**Type**|**Documentation** | ||
| 5517 | |id|IDType|The id is the identifier for the object. | ||
| 5518 | |urn|ReportingCategoryUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5519 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 5520 | |||
| 5521 | Element Documentation: | ||
| 5522 | |||
| 5523 | (% style="width:1121.29px" %) | ||
| 5524 | |**Name**|**Type**|**Documentation** | ||
| 5525 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5526 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 5527 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5528 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5529 | |ReportingCategory|ReportingCategoryType|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. | ||
| 5530 | |StructuralMetadata|StructureReferenceType|StructuralMetadata provides a reference for data structure definition and metadata structure definition references which are grouped in the reporting category. It is assumed that all structural metadata objects referenced from a category will be of the same type. | ||
| 5531 | |ProvisioningMetadata|StructureUsageReferenceType|ProvisioningMetadata provides a reference for dataflow and metadataflow references which are grouped in the reporting category. It is assumed that all provisioning metadata objects referenced from a category will be of the same type. | ||
| 5532 | |||
| 5533 | //**ItemSchemeMapBaseType:**// ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType. | ||
| 5534 | |||
| 5535 | Derivation: | ||
| 5536 | |||
| 5537 | AnnotableType (extension) | ||
| 5538 | IdentifiableType (extension) | ||
| 5539 | NameableType (extension) | ||
| 5540 | VersionableType (restriction) | ||
| 5541 | MaintainableBaseType (extension) | ||
| 5542 | MaintainableType (restriction) | ||
| 5543 | ItemSchemeMapBaseType | ||
| 5544 | |||
| 5545 | Attributes: | ||
| 5546 | |||
| 5547 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5548 | |||
| 5549 | Content: | ||
| 5550 | |||
| 5551 | Annotations?, Link*, Name+, Description | ||
| 5552 | |||
| 5553 | Attribute Documentation: | ||
| 5554 | |||
| 5555 | |**Name**|**Type**|**Documentation**| | ||
| 5556 | |id|IDType|The id is the identifier for the object.| | ||
| 5557 | |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5558 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5559 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 5560 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 5561 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 5562 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 5563 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 5564 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 5565 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 5566 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 5567 | |||
| 5568 | Element Documentation: | ||
| 5569 | |||
| 5570 | |**Name**|**Type**|**Documentation**| | ||
| 5571 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5572 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5573 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5574 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5575 | |||
| 5576 | //**ItemSchemeMapType:**// ItemSchemeMapType is an abstract base type which forms the basis for mapping items between item schemes of the same type. | ||
| 5577 | |||
| 5578 | Derivation: | ||
| 5579 | |||
| 5580 | AnnotableType (extension) | ||
| 5581 | IdentifiableType (extension) | ||
| 5582 | NameableType (extension) | ||
| 5583 | VersionableType (restriction) | ||
| 5584 | MaintainableBaseType (extension) | ||
| 5585 | MaintainableType (restriction) | ||
| 5586 | ItemSchemeMapBaseType (extension) | ||
| 5587 | ItemSchemeMapType | ||
| 5588 | |||
| 5589 | Attributes: | ||
| 5590 | |||
| 5591 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5592 | |||
| 5593 | Content: | ||
| 5594 | |||
| 5595 | Annotations?, Link*, Name+, Description*, Source, Target, ItemMap | ||
| 5596 | |||
| 5597 | Attribute Documentation: | ||
| 5598 | |||
| 5599 | |**Name**|**Type**|**Documentation**| | ||
| 5600 | |id|IDType|The id is the identifier for the object.| | ||
| 5601 | |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5602 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5603 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 5604 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 5605 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 5606 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 5607 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 5608 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 5609 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 5610 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 5611 | |||
| 5612 | Element Documentation: | ||
| 5613 | |||
| 5614 | |**Name**|**Type**|**Documentation**| | ||
| 5615 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5616 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5617 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5618 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5619 | |Source|MaintainableUrnRefer enceType|Source provides a reference to the item scheme which items are mapped from.| | ||
| 5620 | |Target|MaintainableUrnRefer enceType|Target provides a reference to the item scheme which items are mapped to.| | ||
| 5621 | |ItemMap|SingleValueMappingTy pe| | | ||
| 5622 | |||
| 5623 | **OrganisationSchemeMapType:** OrganisationSchemeMapType defines the structure of a map which identifies relationships between organisations in different organisation schemes. | ||
| 5624 | |||
| 5625 | Derivation: | ||
| 5626 | |||
| 5627 | AnnotableType (extension) | ||
| 5628 | IdentifiableType (extension) | ||
| 5629 | NameableType (extension) | ||
| 5630 | VersionableType (restriction) | ||
| 5631 | MaintainableBaseType (extension) | ||
| 5632 | MaintainableType (restriction) | ||
| 5633 | ItemSchemeMapBaseType (extension) | ||
| 5634 | ItemSchemeMapType (restriction) | ||
| 5635 | OrganisationSchemeMapType | ||
| 5636 | |||
| 5637 | Attributes: | ||
| 5638 | |||
| 5639 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5640 | |||
| 5641 | Content: | ||
| 5642 | |||
| 5643 | Annotations?, Link*, Name+, Description*, Source, Target, ItemMap | ||
| 5644 | |||
| 5645 | Attribute Documentation: | ||
| 5646 | |||
| 5647 | (% style="width:1170.29px" %) | ||
| 5648 | |**Name**|**Type**|**Documentation** | ||
| 5649 | |id|IDType|The id is the identifier for the object. | ||
| 5650 | |urn|OrganisationSchemeMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5651 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 5652 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 5653 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5654 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5655 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5656 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 5657 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 5658 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 5659 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 5660 | |||
| 5661 | Element Documentation: | ||
| 5662 | |||
| 5663 | (% style="width:1169.29px" %) | ||
| 5664 | |**Name**|(% style="width:321px" %)**Type**|(% style="width:736px" %)**Documentation** | ||
| 5665 | |Annotations|(% style="width:321px" %)AnnotationsType|(% style="width:736px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5666 | |Link|(% style="width:321px" %)LinkType|(% style="width:736px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 5667 | |Name|(% style="width:321px" %)TextType|(% style="width:736px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5668 | |Description|(% style="width:321px" %)TextType|(% style="width:736px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5669 | |Source|(% style="width:321px" %)OrganisationSchemeReferenceType|(% style="width:736px" %)Source provides a reference to the item scheme which items are mapped from. | ||
| 5670 | |Target|(% style="width:321px" %)OrganisationSchemeReferenceType|(% style="width:736px" %)Target provides a reference to the item scheme which items are mapped to. | ||
| 5671 | |ItemMap|(% style="width:321px" %)SingleValueMappingTy pe|(% style="width:736px" %) | ||
| 5672 | |||
| 5673 | **CategorySchemeMapType:** CategorySchemeMapType defines the structure of a map which identifies relationships between categories in different category schemes. | ||
| 5674 | |||
| 5675 | Derivation: | ||
| 5676 | |||
| 5677 | AnnotableType (extension) | ||
| 5678 | IdentifiableType (extension) | ||
| 5679 | NameableType (extension) | ||
| 5680 | VersionableType (restriction) | ||
| 5681 | MaintainableBaseType (extension) | ||
| 5682 | MaintainableType (restriction) | ||
| 5683 | ItemSchemeMapBaseType (extension) | ||
| 5684 | ItemSchemeMapType (restriction) | ||
| 5685 | CategorySchemeMapType | ||
| 5686 | |||
| 5687 | Attributes: | ||
| 5688 | |||
| 5689 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5690 | |||
| 5691 | Content: | ||
| 5692 | |||
| 5693 | Annotations?, Link*, Name+, Description*, Source, Target, ItemMap | ||
| 5694 | |||
| 5695 | Attribute Documentation: | ||
| 5696 | |||
| 5697 | (% style="width:1273.29px" %) | ||
| 5698 | |**Name**|**Type**|(% style="width:844px" %)**Documentation** | ||
| 5699 | |id|IDType|(% style="width:844px" %)The id is the identifier for the object. | ||
| 5700 | |urn|CategorySchemeMapUrnType|(% style="width:844px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5701 | |uri|xs:anyURI|(% style="width:844px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 5702 | |version|VersionType|(% style="width:844px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 5703 | |validFrom|xs:dateTime|(% style="width:844px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5704 | |validTo|xs:dateTime|(% style="width:844px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5705 | |agencyID|NestedNCNameIDType|(% style="width:844px" %)The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5706 | |isExternalReference (default: false)|xs:boolean|(% style="width:844px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 5707 | |serviceURL|xs:anyURI|(% style="width:844px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 5708 | |structureURL|xs:anyURI|(% style="width:844px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 5709 | |isPartialLanguage (default: false)|xs:boolean|(% style="width:844px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 5710 | |||
| 5711 | Element Documentation: | ||
| 5712 | |||
| 5713 | (% style="width:1280.29px" %) | ||
| 5714 | |**Name**|(% style="width:323px" %)**Type**|(% style="width:854px" %)**Documentation** | ||
| 5715 | |Annotations|(% style="width:323px" %)AnnotationsType|(% style="width:854px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5716 | |Link|(% style="width:323px" %)LinkType|(% style="width:854px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 5717 | |Name|(% style="width:323px" %)TextType|(% style="width:854px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5718 | |Description|(% style="width:323px" %)TextType|(% style="width:854px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5719 | |Source|(% style="width:323px" %)CategorySchemeReferenceType|(% style="width:854px" %)Source provides a reference to the item scheme which items are mapped from. | ||
| 5720 | |Target|(% style="width:323px" %)CategorySchemeReferenceType|(% style="width:854px" %)Target provides a reference to the item scheme which items are mapped to. | ||
| 5721 | |ItemMap|(% style="width:323px" %)SingleValueMappingType|(% style="width:854px" %) | ||
| 5722 | |||
| 5723 | **ConceptSchemeMapType:** ConceptSchemeMapType defines the structure of a map which identifies relationships between concepts in different concept schemes. | ||
| 5724 | |||
| 5725 | Derivation: | ||
| 5726 | |||
| 5727 | AnnotableType (extension) | ||
| 5728 | IdentifiableType (extension) | ||
| 5729 | NameableType (extension) | ||
| 5730 | VersionableType (restriction) | ||
| 5731 | MaintainableBaseType (extension) | ||
| 5732 | MaintainableType (restriction) | ||
| 5733 | ItemSchemeMapBaseType (extension) | ||
| 5734 | ItemSchemeMapType (restriction) | ||
| 5735 | ConceptSchemeMapType | ||
| 5736 | |||
| 5737 | Attributes: | ||
| 5738 | |||
| 5739 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5740 | |||
| 5741 | Content: | ||
| 5742 | |||
| 5743 | Annotations?, Link*, Name+, Description*, Source, Target, ItemMap | ||
| 5744 | |||
| 5745 | Attribute Documentation: | ||
| 5746 | |||
| 5747 | (% style="width:1242.29px" %) | ||
| 5748 | |**Name**|**Type**|**Documentation** | ||
| 5749 | |id|IDType|The id is the identifier for the object. | ||
| 5750 | |urn|ConceptSchemeMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5751 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 5752 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 5753 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5754 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5755 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5756 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 5757 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 5758 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 5759 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 5760 | |||
| 5761 | Element Documentation: | ||
| 5762 | |||
| 5763 | (% style="width:1125.29px" %) | ||
| 5764 | |**Name**|**Type**|(% style="width:747px" %)**Documentation** | ||
| 5765 | |Annotations|AnnotationsType|(% style="width:747px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5766 | |Link|LinkType|(% style="width:747px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 5767 | |Name|TextType|(% style="width:747px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5768 | |Description|TextType|(% style="width:747px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5769 | |Source|ConceptSchemeReferenceType|(% style="width:747px" %)Source provides a reference to the item scheme which items are mapped from. | ||
| 5770 | |Target|ConceptSchemeReferenceType|(% style="width:747px" %)Target provides a reference to the item scheme which items are mapped to. | ||
| 5771 | |ItemMap|SingleValueMappingType|(% style="width:747px" %) | ||
| 5772 | |||
| 5773 | **ReportingTaxonomyMapType:** ReportingTaxonomyMapType defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies. | ||
| 5774 | |||
| 5775 | Derivation: | ||
| 5776 | |||
| 5777 | AnnotableType (extension) | ||
| 5778 | IdentifiableType (extension) | ||
| 5779 | NameableType (extension) | ||
| 5780 | VersionableType (restriction) | ||
| 5781 | MaintainableBaseType (extension) | ||
| 5782 | MaintainableType (restriction) | ||
| 5783 | ItemSchemeMapBaseType (extension) | ||
| 5784 | ItemSchemeMapType (restriction) | ||
| 5785 | ReportingTaxonomyMapType | ||
| 5786 | |||
| 5787 | Attributes: | ||
| 5788 | |||
| 5789 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5790 | |||
| 5791 | Content: | ||
| 5792 | |||
| 5793 | Annotations?, Link*, Name+, Description*, Source, Target, ItemMap | ||
| 5794 | |||
| 5795 | Attribute Documentation: | ||
| 5796 | |||
| 5797 | (% style="width:1171.29px" %) | ||
| 5798 | |**Name**|**Type**|**Documentation** | ||
| 5799 | |id|IDType|The id is the identifier for the object. | ||
| 5800 | |urn|ReportingTaxonomyMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5801 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 5802 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 5803 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5804 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5805 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5806 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 5807 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 5808 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 5809 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 5810 | |||
| 5811 | Element Documentation: | ||
| 5812 | |||
| 5813 | (% style="width:1177.29px" %) | ||
| 5814 | |**Name**|**Type**|(% style="width:778px" %)**Documentation** | ||
| 5815 | |Annotations|AnnotationsType|(% style="width:778px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5816 | |Link|LinkType|(% style="width:778px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 5817 | |Name|TextType|(% style="width:778px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5818 | |Description|TextType|(% style="width:778px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5819 | |Source|ReportingTaxonomyReferenceType|(% style="width:778px" %)Source provides a reference to the item scheme which items are mapped from. | ||
| 5820 | |Target|ReportingTaxonomyReferenceType|(% style="width:778px" %)Target provides a reference to the item scheme which items are mapped to. | ||
| 5821 | |ItemMap|SingleValueMappingType|(% style="width:778px" %) | ||
| 5822 | |||
| 5823 | ***StructureMapBaseType*:** StructureMapBaseType defines the base refinement of the StructureMapType. Its purpose is to retrict the urn attribute. | ||
| 5824 | |||
| 5825 | Derivation: | ||
| 5826 | |||
| 5827 | AnnotableType (extension) | ||
| 5828 | IdentifiableType (extension) | ||
| 5829 | NameableType (extension) | ||
| 5830 | VersionableType (restriction) | ||
| 5831 | MaintainableBaseType (extension) | ||
| 5832 | MaintainableType (restriction) | ||
| 5833 | StructureMapBaseType | ||
| 5834 | |||
| 5835 | Attributes: | ||
| 5836 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5837 | |||
| 5838 | Content: | ||
| 5839 | Annotations?, Link*, Name+, Description | ||
| 5840 | |||
| 5841 | Attribute Documentation: | ||
| 5842 | |||
| 5843 | |**Name**|**Type**|**Documentation**| | ||
| 5844 | |id|IDType|The id is the identifier for the object.| | ||
| 5845 | |urn|StructureMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5846 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5847 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 5848 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 5849 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 5850 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 5851 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 5852 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 5853 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 5854 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 5855 | |||
| 5856 | Element Documentation: | ||
| 5857 | |||
| 5858 | |**Name**|**Type**|**Documentation**| | ||
| 5859 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5860 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 5861 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5862 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 5863 | |||
| 5864 | **StructureMapType:** StructureMapType defines the structure for mapping components of one structure to components of another structure. A structure may be referenced directly meaning the map applies wherever the structure is used, or it may be a reference via a structure usage meaning the map only applies within the context of that usage. Using the related structures, one can make extrapolations between maps. For example, if key families, A, B, and C, are all grouped in a related structures container, then a map from data structure A to C and a map from data structure B to C could be used to infer a relation between data structure A to C. | ||
| 5865 | |||
| 5866 | Derivation: | ||
| 5867 | |||
| 5868 | AnnotableType (extension) | ||
| 5869 | IdentifiableType (extension) | ||
| 5870 | NameableType (extension) | ||
| 5871 | VersionableType (restriction) | ||
| 5872 | MaintainableBaseType (extension) | ||
| 5873 | MaintainableType (restriction) | ||
| 5874 | StructureMapBaseType (extension) | ||
| 5875 | StructureMapType | ||
| 5876 | |||
| 5877 | Attributes: | ||
| 5878 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 5879 | |||
| 5880 | Content: | ||
| 5881 | Annotations?, Link*, Name+, Description*, Source, Target, EpochMap*, DatePatternMap*, FrequencyFormatMapping*, ComponentMap*, FixedValueMap | ||
| 5882 | |||
| 5883 | Attribute Documentation: | ||
| 5884 | |||
| 5885 | |**Name**|**Type**|**Documentation**| | ||
| 5886 | |id|IDType|The id is the identifier for the object.| | ||
| 5887 | |urn|StructureMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 5888 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 5889 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 5890 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 5891 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 5892 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 5893 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 5894 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 5895 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 5896 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 5897 | |||
| 5898 | Element Documentation: | ||
| 5899 | |||
| 5900 | (% style="width:1140.29px" %) | ||
| 5901 | |**Name**|**Type**|**Documentation** | ||
| 5902 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5903 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 5904 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5905 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5906 | |Source|StructureOrUsageReferenceType|Source provides a reference to a structure (data or metadata) or a structure usage (dataflow or metadataflow) from which components defined by the actual structure are to mapped. | ||
| 5907 | |Target|StructureOrUsageReferenceType|Target provides a reference to a structure (data or metadata) or a structure usage (dataflow or metadataflow) to which components from the source are to mapped. | ||
| 5908 | |EpochMap|EpochMapType|Provides the ability to map source to target date formats. The source date is described as the number of epochs since a point in time, where the duration of each epoch is defined, e.g. number of milliseconds since 1970. | ||
| 5909 | |DatePatternMap|DatePatternMapType|Provides the ability to map source to target date formats. The source date is described as a pattern (for example MM-YYYY). | ||
| 5910 | |FrequencyFormatMappi ng|FrequencyFormatMappingType| | ||
| 5911 | |ComponentMap|ComponentMapType|ComponentMap defines the relationship between the components of the source and target structures, including information on how the value from the source component relates to values in the target component. | ||
| 5912 | |FixedValueMap|FixedValueMapType|FixedValueMap defines a fixed value for a source or target component in the mapping. | ||
| 5913 | |||
| 5914 | **FixedValueMapType:** FixedValueMapType defines the structure for providing a fixed value for a source or target component. | ||
| 5915 | |||
| 5916 | Derivation: | ||
| 5917 | |||
| 5918 | AnnotableType (extension) | ||
| 5919 | FixedValueMapType | ||
| 5920 | |||
| 5921 | Content: | ||
| 5922 | |||
| 5923 | Annotations?, (Source|Target), Value | ||
| 5924 | |||
| 5925 | Element Documentation: | ||
| 5926 | |||
| 5927 | |**Name**|**Type**|**Documentation**| | ||
| 5928 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 5929 | |Source|IDType| | | ||
| 5930 | |Target|IDType| | | ||
| 5931 | |Value|xs:string|The fixed value for the component.| | ||
| 5932 | |||
| 5933 | **ComponentMapType:** ComponentMapType defines the structure for relating a component in a source structure to a component in a target structure. | ||
| 5934 | |||
| 5935 | Derivation: | ||
| 5936 | |||
| 5937 | AnnotableType (extension) | ||
| 5938 | ComponentMapType | ||
| 5939 | |||
| 5940 | Content: | ||
| 5941 | |||
| 5942 | Annotations?, Source+, Target+, RepresentationMap? | ||
| 5943 | |||
| 5944 | Element Documentation: | ||
| 5945 | |||
| 5946 | (% style="width:1153.29px" %) | ||
| 5947 | |**Name**|**Type**|(% style="width:632px" %)**Documentation** | ||
| 5948 | |Annotations|AnnotationsType|(% style="width:632px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5949 | |Source|IDType|(% style="width:632px" %) | ||
| 5950 | |Target|IDType|(% style="width:632px" %) | ||
| 5951 | |RepresentationMap|RepresentationMapReferenceType|(% style="width:632px" %) | ||
| 5952 | |||
| 5953 | **//FrequencyFormatMappingBaseType//:** FrequencyFormatMappingBaseType defines the base refinement of the FrequencyFormatMappingType. Its purpose is to retrict the urn attribute. | ||
| 5954 | |||
| 5955 | Derivation: | ||
| 5956 | |||
| 5957 | AnnotableType (extension) | ||
| 5958 | IdentifiableType (extension) | ||
| 5959 | FrequencyFormatMappingBaseType | ||
| 5960 | |||
| 5961 | Attributes: | ||
| 5962 | id?, urn?, uri? | ||
| 5963 | |||
| 5964 | Content: | ||
| 5965 | Annotations?, Link | ||
| 5966 | |||
| 5967 | Attribute Documentation: | ||
| 5968 | |||
| 5969 | (% style="width:1142.29px" %) | ||
| 5970 | |**Name**|**Type**|(% style="width:682px" %)**Documentation** | ||
| 5971 | |id|IDType|(% style="width:682px" %)The id is the identifier for the object. | ||
| 5972 | |urn|FrequencyFormatMappingUrnType|(% style="width:682px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5973 | |uri|xs:anyURI|(% style="width:682px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 5974 | |||
| 5975 | Element Documentation: | ||
| 5976 | |||
| 5977 | |**Name**|**Type**|**Documentation** | ||
| 5978 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 5979 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 5980 | |||
| 5981 | **FrequencyFormatMappingType:** | ||
| 5982 | |||
| 5983 | Derivation: | ||
| 5984 | |||
| 5985 | AnnotableType (extension) | ||
| 5986 | IdentifiableType (extension) | ||
| 5987 | FrequencyFormatMappingBaseType (extension) | ||
| 5988 | FrequencyFormatMappingType | ||
| 5989 | |||
| 5990 | Attributes: | ||
| 5991 | id?, urn?, uri? | ||
| 5992 | |||
| 5993 | Content: | ||
| 5994 | Annotations?, Link*, FrequencyId, DatePattern | ||
| 5995 | |||
| 5996 | Attribute Documentation: | ||
| 5997 | |||
| 5998 | (% style="width:1281.29px" %) | ||
| 5999 | |**Name**|(% style="width:282px" %)**Type**|(% style="width:911px" %)**Documentation** | ||
| 6000 | |id|(% style="width:282px" %)IDType|(% style="width:911px" %)The id is the identifier for the object. | ||
| 6001 | |urn|(% style="width:282px" %)FrequencyFormatMappingUrnType|(% style="width:911px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6002 | |uri|(% style="width:282px" %)xs:anyURI|(% style="width:911px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6003 | |||
| 6004 | Element Documentation: | ||
| 6005 | |||
| 6006 | |**Name**|**Type**|**Documentation**| | ||
| 6007 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6008 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6009 | |FrequencyId|IDType| | | ||
| 6010 | |DatePattern|xs:string| | | ||
| 6011 | |||
| 6012 | //**DateMapType:**// | ||
| 6013 | |||
| 6014 | Derivation: | ||
| 6015 | |||
| 6016 | AnnotableType (extension) | ||
| 6017 | IdentifiableType (extension) | ||
| 6018 | DateMapType | ||
| 6019 | |||
| 6020 | Attributes: | ||
| 6021 | id?, urn?, uri?, resolvePeriod? | ||
| 6022 | |||
| 6023 | Content: | ||
| 6024 | Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*)|TargetFrequencyID) | ||
| 6025 | |||
| 6026 | Attribute Documentation: | ||
| 6027 | |||
| 6028 | |**Name**|**Type**|**Documentation**| | ||
| 6029 | |id|IDType|The id is the identifier for the object.| | ||
| 6030 | |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 6031 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 6032 | |resolvePeriod|ResolvePeriodType|Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods.| | ||
| 6033 | |||
| 6034 | Element Documentation: | ||
| 6035 | |||
| 6036 | |**Name**|**Type**|**Documentation**| | ||
| 6037 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6038 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6039 | |Source|IDType| | | ||
| 6040 | |Target|IDType| | | ||
| 6041 | |FrequencyDimension|IDType| | | ||
| 6042 | |MappedFrequencies|IDType| | | ||
| 6043 | |TargetFrequencyID|IDType| | | ||
| 6044 | |||
| 6045 | //**EpochMapBaseType:**// EpochMapBaseType defines the base refinement of the EpochMapType. Its purpose is to retrict the urn attribute. | ||
| 6046 | |||
| 6047 | Derivation: | ||
| 6048 | |||
| 6049 | AnnotableType (extension) | ||
| 6050 | IdentifiableType (extension) | ||
| 6051 | DateMapType (restriction) | ||
| 6052 | EpochMapBaseType | ||
| 6053 | |||
| 6054 | Attributes: | ||
| 6055 | id?, urn?, uri?, resolvePeriod? | ||
| 6056 | |||
| 6057 | Content: | ||
| 6058 | Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*)|TargetFrequencyID) | ||
| 6059 | |||
| 6060 | Attribute Documentation: | ||
| 6061 | |||
| 6062 | |**Name**|**Type**|**Documentation**| | ||
| 6063 | |id|IDType|The id is the identifier for the object.| | ||
| 6064 | |urn|EpochMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 6065 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 6066 | |resolvePeriod|ResolvePeriodType|Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods.| | ||
| 6067 | |||
| 6068 | Element Documentation: | ||
| 6069 | |||
| 6070 | |**Name**|**Type**|**Documentation**| | ||
| 6071 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6072 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6073 | |Source|IDType| | | ||
| 6074 | |Target|IDType| | | ||
| 6075 | |FrequencyDimension|IDType| | | ||
| 6076 | |MappedFrequencies|IDType| | | ||
| 6077 | |TargetFrequencyID|IDType| | | ||
| 6078 | |||
| 6079 | **EpochMapType:** | ||
| 6080 | |||
| 6081 | Derivation: | ||
| 6082 | |||
| 6083 | AnnotableType (extension) | ||
| 6084 | IdentifiableType (extension) | ||
| 6085 | DateMapType (restriction) | ||
| 6086 | EpochMapBaseType (extension) | ||
| 6087 | EpochMapType | ||
| 6088 | |||
| 6089 | Attributes: | ||
| 6090 | id?, urn?, uri?, resolvePeriod?, basePeriod, epochPeriod | ||
| 6091 | |||
| 6092 | Content: | ||
| 6093 | Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*)|TargetFrequencyID) | ||
| 6094 | |||
| 6095 | Attribute Documentation: | ||
| 6096 | |||
| 6097 | |**Name**|**Type**|**Documentation**| | ||
| 6098 | |id|IDType|The id is the identifier for the object.| | ||
| 6099 | |urn|EpochMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 6100 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 6101 | |resolvePeriod|ResolvePeriodType|Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods.| | ||
| 6102 | |basePeriod|xs:string| | | ||
| 6103 | |epochPeriod|EpochPeriodType| | | ||
| 6104 | |||
| 6105 | Element Documentation: | ||
| 6106 | |||
| 6107 | |**Name**|**Type**|**Documentation**| | ||
| 6108 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6109 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6110 | |Source|IDType| | | ||
| 6111 | |Target|IDType| | | ||
| 6112 | |FrequencyDimension|IDType| | | ||
| 6113 | |MappedFrequencies|IDType| | | ||
| 6114 | |TargetFrequencyID|IDType| | | ||
| 6115 | |||
| 6116 | //**DatePatternMapBaseType:**// DatePatternMapBaseType defines the base refinement of the DatePatternMapType. Its purpose is to retrict the urn attribute. | ||
| 6117 | |||
| 6118 | Derivation: | ||
| 6119 | |||
| 6120 | AnnotableType (extension) | ||
| 6121 | IdentifiableType (extension) | ||
| 6122 | DateMapType (restriction) | ||
| 6123 | DatePatternMapBaseType | ||
| 6124 | |||
| 6125 | Attributes: | ||
| 6126 | id?, urn?, uri?, resolvePeriod? | ||
| 6127 | |||
| 6128 | Content: | ||
| 6129 | Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*)|TargetFrequencyID) | ||
| 6130 | |||
| 6131 | Attribute Documentation: | ||
| 6132 | |||
| 6133 | (% style="width:1144.29px" %) | ||
| 6134 | |**Name**|**Type**|**Documentation** | ||
| 6135 | |id|IDType|The id is the identifier for the object. | ||
| 6136 | |urn|DatePatternMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6137 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6138 | |resolvePeriod|ResolvePeriodType|Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. | ||
| 6139 | |||
| 6140 | Element Documentation: | ||
| 6141 | |||
| 6142 | |**Name**|**Type**|**Documentation**| | ||
| 6143 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6144 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6145 | |Source|IDType| | | ||
| 6146 | |Target|IDType| | | ||
| 6147 | |FrequencyDimension|IDType| | | ||
| 6148 | |MappedFrequencies|IDType| | | ||
| 6149 | |TargetFrequencyID|IDType| | | ||
| 6150 | |||
| 6151 | **DatePatternMapType:** | ||
| 6152 | |||
| 6153 | Derivation: | ||
| 6154 | |||
| 6155 | AnnotableType (extension) | ||
| 6156 | IdentifiableType (extension) | ||
| 6157 | DateMapType (restriction) | ||
| 6158 | DatePatternMapBaseType (extension) | ||
| 6159 | DatePatternMapType | ||
| 6160 | |||
| 6161 | Attributes: | ||
| 6162 | id?, urn?, uri?, resolvePeriod?, sourcePattern, locale | ||
| 6163 | |||
| 6164 | Content: | ||
| 6165 | Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*)|TargetFrequencyID) | ||
| 6166 | |||
| 6167 | Attribute Documentation: | ||
| 6168 | |||
| 6169 | (% style="width:1196.29px" %) | ||
| 6170 | |**Name**|**Type**|(% style="width:753px" %)**Documentation** | ||
| 6171 | |id|IDType|(% style="width:753px" %)The id is the identifier for the object. | ||
| 6172 | |urn|DatePatternMapUrnType|(% style="width:753px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6173 | |uri|xs:anyURI|(% style="width:753px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6174 | |resolvePeriod|ResolvePeriodType|(% style="width:753px" %)Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. | ||
| 6175 | |sourcePattern|xs:string|(% style="width:753px" %)Describes the source date using conventions for describing years, months, days, etc. | ||
| 6176 | |locale|xs:string|(% style="width:753px" %)The locale on which the input will be parsed according to the pattern. | ||
| 6177 | |||
| 6178 | Element Documentation: | ||
| 6179 | |||
| 6180 | |**Name**|**Type**|**Documentation**| | ||
| 6181 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6182 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6183 | |Source|IDType| | | ||
| 6184 | |Target|IDType| | | ||
| 6185 | |FrequencyDimension|IDType| | | ||
| 6186 | |MappedFrequencies|IDType| | | ||
| 6187 | |TargetFrequencyID|IDType| | | ||
| 6188 | |||
| 6189 | ***RepresentationMapBaseType*:** RepresentationMapBaseType defines the base refinement of the RepresentationMapType. Its purpose is to retrict the urn attribute. | ||
| 6190 | |||
| 6191 | Derivation: | ||
| 6192 | |||
| 6193 | AnnotableType (extension) | ||
| 6194 | IdentifiableType (extension) | ||
| 6195 | NameableType (extension) | ||
| 6196 | VersionableType (restriction) | ||
| 6197 | MaintainableBaseType (extension) | ||
| 6198 | MaintainableType (restriction) | ||
| 6199 | RepresentationMapBaseType | ||
| 6200 | |||
| 6201 | Attributes: | ||
| 6202 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 6203 | |||
| 6204 | Content: | ||
| 6205 | Annotations?, Link*, Name+, Description | ||
| 6206 | |||
| 6207 | Attribute Documentation: | ||
| 6208 | |||
| 6209 | (% style="width:1160.29px" %) | ||
| 6210 | |**Name**|**Type**|**Documentation** | ||
| 6211 | |id|IDType|The id is the identifier for the object. | ||
| 6212 | |urn|RepresentationMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6213 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6214 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 6215 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 6216 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 6217 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 6218 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 6219 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 6220 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 6221 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 6222 | |||
| 6223 | Element Documentation: | ||
| 6224 | |||
| 6225 | |**Name**|**Type**|**Documentation**| | ||
| 6226 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6227 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6228 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6229 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6230 | |||
| 6231 | **RepresentationMapType:** | ||
| 6232 | |||
| 6233 | Derivation: | ||
| 6234 | |||
| 6235 | AnnotableType (extension) | ||
| 6236 | IdentifiableType (extension) | ||
| 6237 | NameableType (extension) | ||
| 6238 | VersionableType (restriction) | ||
| 6239 | MaintainableBaseType (extension) | ||
| 6240 | MaintainableType (restriction) | ||
| 6241 | RepresentationMapBaseType (extension) | ||
| 6242 | RepresentationMapType | ||
| 6243 | |||
| 6244 | Attributes: | ||
| 6245 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL? | ||
| 6246 | |||
| 6247 | Content: | ||
| 6248 | Annotations?, Link*, Name+, Description*, (SourceCodelist|SourceDataType)+, (TargetCodelist|TargetDataType)+, RepresentationMapping | ||
| 6249 | |||
| 6250 | Attribute Documentation: | ||
| 6251 | |||
| 6252 | (% style="width:1159.29px" %) | ||
| 6253 | |**Name**|**Type**|**Documentation** | ||
| 6254 | |id|IDType|The id is the identifier for the object. | ||
| 6255 | |urn|RepresentationMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6256 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6257 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 6258 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 6259 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 6260 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 6261 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 6262 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 6263 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 6264 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 6265 | |||
| 6266 | Element Documentation: | ||
| 6267 | |||
| 6268 | (% style="width:1172.29px" %) | ||
| 6269 | |**Name**|**Type**|(% style="width:748px" %)**Documentation** | ||
| 6270 | |Annotations|AnnotationsType|(% style="width:748px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 6271 | |Link|LinkType|(% style="width:748px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 6272 | |Name|TextType|(% style="width:748px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 6273 | |Description|TextType|(% style="width:748px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 6274 | |SourceCodelist|AnyCodelistReferenceType|(% style="width:748px" %) | ||
| 6275 | |SourceDataType|DataType|(% style="width:748px" %) | ||
| 6276 | |TargetCodelist|AnyCodelistReferenceType|(% style="width:748px" %) | ||
| 6277 | |TargetDataType|DataType|(% style="width:748px" %) | ||
| 6278 | |RepresentationMapping|ValueMappingType|(% style="width:748px" %) | ||
| 6279 | |||
| 6280 | **SingleValueMappingType:** SingleValueMappingType defines a mapping with a single source and optional target. | ||
| 6281 | |||
| 6282 | Derivation: | ||
| 6283 | |||
| 6284 | AnnotableType (extension) | ||
| 6285 | SingleValueMappingType | ||
| 6286 | |||
| 6287 | Attributes: | ||
| 6288 | |||
| 6289 | validFrom?, validTo? | ||
| 6290 | |||
| 6291 | Content: | ||
| 6292 | |||
| 6293 | Annotations?, SourceValue, TargetValue? | ||
| 6294 | |||
| 6295 | Attribute Documentation: | ||
| 6296 | |||
| 6297 | |**Name**|**Type**|**Documentation**| | ||
| 6298 | |validFrom|xs:date| | | ||
| 6299 | |validTo|xs:date| | | ||
| 6300 | |||
| 6301 | Element Documentation: | ||
| 6302 | |||
| 6303 | |**Name**|**Type**|**Documentation**| | ||
| 6304 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6305 | |SourceValue|MappedValueType|There should be a source value for each source represention (e.g. codelist, data type). Source values can be pattern matched by using regular expression or substrings using start/end indexes.| | ||
| 6306 | |TargetValue|xs:string|The target value(s) is always an absolute string. However, if source value is a regular expression, the target value can output the capture group from the source.| | ||
| 6307 | |||
| 6308 | **ValueMappingType:** ValueMappingType defines a mapping of multiple sources to multiple targets. | ||
| 6309 | |||
| 6310 | Derivation: | ||
| 6311 | |||
| 6312 | AnnotableType (extension) | ||
| 6313 | ValueMappingType | ||
| 6314 | |||
| 6315 | Attributes: | ||
| 6316 | |||
| 6317 | validFrom?, validTo? | ||
| 6318 | |||
| 6319 | Content: | ||
| 6320 | |||
| 6321 | Annotations?, SourceValue+, TargetValue | ||
| 6322 | |||
| 6323 | Attribute Documentation: | ||
| 6324 | |||
| 6325 | |**Name**|**Type**|**Documentation**| | ||
| 6326 | |validFrom|xs:date| | | ||
| 6327 | |validTo|xs:date| | | ||
| 6328 | |||
| 6329 | Element Documentation: | ||
| 6330 | |||
| 6331 | |**Name**|**Type**|**Documentation**| | ||
| 6332 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6333 | |SourceValue|MappedValueType|There should be a source value for each source represention (e.g. codelist, data type). Source values can be pattern matched by using regular expression or substrings using start/end indexes.| | ||
| 6334 | |TargetValue|xs:string|The target value(s) is always an absolute string. However, if source value is a regular expression, the target value can output the capture group from the source.| | ||
| 6335 | |||
| 6336 | **MappedValueType:** | ||
| 6337 | |||
| 6338 | Derivation: | ||
| 6339 | |||
| 6340 | xs:anySimpleType (restriction) | ||
| 6341 | xs:string (extension) | ||
| 6342 | MappedValueType | ||
| 6343 | |||
| 6344 | Attributes: | ||
| 6345 | |||
| 6346 | isRegEx?, startIndex?, endIndex? | ||
| 6347 | |||
| 6348 | Content: | ||
| 6349 | |||
| 6350 | Attribute Documentation: | ||
| 6351 | |||
| 6352 | |**Name**|**Type**|**Documentation**| | ||
| 6353 | |isRegEx|xs:boolean| | | ||
| 6354 | |startIndex|xs:int| | | ||
| 6355 | |endIndex|xs:int| | | ||
| 6356 | |||
| 6357 | //**VtlDefinitionSchemeType:**// VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for VTL schemes. | ||
| 6358 | |||
| 6359 | Derivation: | ||
| 6360 | |||
| 6361 | AnnotableType (extension) | ||
| 6362 | IdentifiableType (extension) | ||
| 6363 | NameableType (extension) | ||
| 6364 | VersionableType (restriction) | ||
| 6365 | MaintainableBaseType (extension) | ||
| 6366 | MaintainableType (extension) | ||
| 6367 | ItemSchemeType (extension) | ||
| 6368 | VtlDefinitionSchemeType | ||
| 6369 | |||
| 6370 | Attributes: | ||
| 6371 | |||
| 6372 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 6373 | |||
| 6374 | Content: | ||
| 6375 | |||
| 6376 | Annotations?, Link*, Name+, Description*, Item* | ||
| 6377 | |||
| 6378 | Attribute Documentation: | ||
| 6379 | |||
| 6380 | |**Name**|**Type**|**Documentation**| | ||
| 6381 | |id|IDType|The id is the identifier for the object.| | ||
| 6382 | |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 6383 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 6384 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 6385 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 6386 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 6387 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 6388 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 6389 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 6390 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 6391 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 6392 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.| | ||
| 6393 | |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.| | ||
| 6394 | |||
| 6395 | Element Documentation: | ||
| 6396 | |||
| 6397 | |**Name**|**Type**|**Documentation**| | ||
| 6398 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6399 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6400 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6401 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6402 | |//Item//|//ItemType//|Item is an abstract element that serves as a substitution head for all items in an item scheme, including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType.| | ||
| 6403 | |||
| 6404 | //**TransformationSchemeBaseType:**// TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations. | ||
| 6405 | |||
| 6406 | Derivation: | ||
| 6407 | |||
| 6408 | AnnotableType (extension) | ||
| 6409 | IdentifiableType (extension) | ||
| 6410 | NameableType (extension) | ||
| 6411 | VersionableType (restriction) | ||
| 6412 | MaintainableBaseType (extension) | ||
| 6413 | MaintainableType (extension) | ||
| 6414 | ItemSchemeType (extension) | ||
| 6415 | VtlDefinitionSchemeType (restriction) | ||
| 6416 | TransformationSchemeBaseType | ||
| 6417 | |||
| 6418 | Attributes: | ||
| 6419 | |||
| 6420 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 6421 | |||
| 6422 | Content: | ||
| 6423 | |||
| 6424 | Annotations?, Link*, Name+, Description*, Transformation | ||
| 6425 | |||
| 6426 | Attribute Documentation: | ||
| 6427 | |||
| 6428 | (% style="width:1314.29px" %) | ||
| 6429 | |**Name**|**Type**|(% style="width:875px" %)**Documentation** | ||
| 6430 | |id|IDType|(% style="width:875px" %)The id is the identifier for the object. | ||
| 6431 | |urn|TransformationSchemeUrnType|(% style="width:875px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6432 | |uri|xs:anyURI|(% style="width:875px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6433 | |version|VersionType|(% style="width:875px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 6434 | |validFrom|xs:dateTime|(% style="width:875px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 6435 | |validTo|xs:dateTime|(% style="width:875px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 6436 | |agencyID|NestedNCNameIDType|(% style="width:875px" %)The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 6437 | |isExternalReference (default: false)|xs:boolean|(% style="width:875px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 6438 | |serviceURL|xs:anyURI|(% style="width:875px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 6439 | |structureURL|xs:anyURI|(% style="width:875px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 6440 | |isPartialLanguage (default: false)|xs:boolean|(% style="width:875px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 6441 | |isPartial (default: false)|xs:boolean|(% style="width:875px" %)The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. | ||
| 6442 | |vtlVersion|xs:string|(% style="width:875px" %)Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. | ||
| 6443 | |||
| 6444 | Element Documentation: | ||
| 6445 | |||
| 6446 | |**Name**|**Type**|**Documentation**| | ||
| 6447 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6448 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6449 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6450 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6451 | |Transformation|TransformationType|Transformation describes the details of a single transformation within a transformation scheme.| | ||
| 6452 | |||
| 6453 | **TransformationSchemeType:** TransformationSchemeType describes the structure of a transformation scheme. A transformation scheme contains a set of transformations to be executed together (in the same run). It can contain any number of transformations that produce any number of results. | ||
| 6454 | |||
| 6455 | Derivation: | ||
| 6456 | |||
| 6457 | AnnotableType (extension) | ||
| 6458 | IdentifiableType (extension) | ||
| 6459 | NameableType (extension) | ||
| 6460 | VersionableType (restriction) | ||
| 6461 | MaintainableBaseType (extension) | ||
| 6462 | MaintainableType (extension) | ||
| 6463 | ItemSchemeType (extension) | ||
| 6464 | VtlDefinitionSchemeType (restriction) | ||
| 6465 | TransformationSchemeBaseType (extension) | ||
| 6466 | TransformationSchemeType | ||
| 6467 | |||
| 6468 | Attributes: | ||
| 6469 | |||
| 6470 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 6471 | |||
| 6472 | Content: | ||
| 6473 | |||
| 6474 | Annotations?, Link*, Name+, Description*, Transformation*, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme*, UserDefinedOperatorScheme | ||
| 6475 | |||
| 6476 | Attribute Documentation: | ||
| 6477 | |||
| 6478 | (% style="width:1198.29px" %) | ||
| 6479 | |**Name**|**Type**|**Documentation** | ||
| 6480 | |id|IDType|The id is the identifier for the object. | ||
| 6481 | |urn|TransformationSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6482 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6483 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 6484 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 6485 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 6486 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 6487 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 6488 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 6489 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 6490 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 6491 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. | ||
| 6492 | |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. | ||
| 6493 | |||
| 6494 | Element Documentation: | ||
| 6495 | |||
| 6496 | (% style="width:1326.29px" %) | ||
| 6497 | |**Name**|**Type**|(% style="width:756px" %)**Documentation** | ||
| 6498 | |Annotations|AnnotationsType|(% style="width:756px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 6499 | |Link|LinkType|(% style="width:756px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 6500 | |Name|TextType|(% style="width:756px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 6501 | |Description|TextType|(% style="width:756px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 6502 | |Transformation|TransformationType|(% style="width:756px" %)Transformation describes the details of a single transformation within a transformation scheme. | ||
| 6503 | |VtlMappingScheme|VtlMappingSchemeReferenceType|(% style="width:756px" %)References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the transformations as well as the mapping methods used when converting between SDMX and VTL data structures. All aliases must be defined in the referenced scheme. This also must be used if the basic mapping methods are not used. | ||
| 6504 | |NamePersonalisationScheme|NamePersonalisationSchemeReferenceType|(% style="width:756px" %)References a name personalisation scheme, which defines the overriding of some standard VTL names (to be assigned to some measures and/or attributes of the data structure) with some corresponding personalised names. This must be used if transformations within a transformation scheme personalise standard names. All personalisations must be defined in the referenced scheme. | ||
| 6505 | |CustomTypeScheme|CustomTypeSchemeReferenceType|(% style="width:756px" %)References a custom type scheme which defines custom conversions of VTL scalar types to SDMX data types. This must be used if custom type conversions are used in the transformations defined in a transformation scheme. All custom conversions must be defined in the referenced scheme. | ||
| 6506 | |RulesetScheme|RulesetSchemeReferen ceType|(% style="width:756px" %)References a ruleset scheme that defines one or more previously defined rulesets which can be invoked by VTL operators. If a transformation defined in a transformation scheme refers to a ruleset, the scheme in which the ruleset is defined must be referenced here. | ||
| 6507 | |UserDefinedOperatorS cheme|UserDefinedOperatorSchemeReferenceType|(% style="width:756px" %)References a user defined operator scheme that defines one or more user defined operators used by the transformations defined in a transformation scheme. If a transformation in a transformation scheme refers to a user defined operator, the scheme in which the user defined operator is defined must be referenced here. | ||
| 6508 | |||
| 6509 | //**TransformationBaseType:**// TransformationBaseType defines the base refinement of the TransformationType. Its purpose is to retrict the urn attribute. | ||
| 6510 | |||
| 6511 | Derivation: | ||
| 6512 | |||
| 6513 | AnnotableType (extension) | ||
| 6514 | IdentifiableType (extension) | ||
| 6515 | NameableType (restriction) | ||
| 6516 | ItemBaseType (extension) | ||
| 6517 | ItemType (restriction) | ||
| 6518 | UnnestedItemType (restriction) | ||
| 6519 | TransformationBaseType | ||
| 6520 | |||
| 6521 | Attributes: | ||
| 6522 | |||
| 6523 | id, urn?, uri? | ||
| 6524 | |||
| 6525 | Content: | ||
| 6526 | |||
| 6527 | Annotations?, Link*, Name+, Description | ||
| 6528 | |||
| 6529 | Attribute Documentation: | ||
| 6530 | |||
| 6531 | (% style="width:1149.29px" %) | ||
| 6532 | |**Name**|**Type**|**Documentation** | ||
| 6533 | |id|IDType|The id is the identifier for the object. | ||
| 6534 | |urn|TransformationUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6535 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6536 | |||
| 6537 | Element Documentation: | ||
| 6538 | |||
| 6539 | |**Name**|**Type**|**Documentation**| | ||
| 6540 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6541 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6542 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6543 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6544 | |||
| 6545 | **TransformationType:** TransformationType defines the structure of a transformation. A transformation is an assignment of a VTL expression to a specific result. | ||
| 6546 | |||
| 6547 | Derivation: | ||
| 6548 | |||
| 6549 | AnnotableType (extension) | ||
| 6550 | IdentifiableType (extension) | ||
| 6551 | NameableType (restriction) | ||
| 6552 | ItemBaseType (extension) | ||
| 6553 | ItemType (restriction) | ||
| 6554 | UnnestedItemType (restriction) | ||
| 6555 | TransformationBaseType (extension) | ||
| 6556 | TransformationType | ||
| 6557 | |||
| 6558 | Attributes: | ||
| 6559 | |||
| 6560 | id, urn?, uri?, isPersistent | ||
| 6561 | |||
| 6562 | Content: | ||
| 6563 | |||
| 6564 | Annotations?, Link*, Name+, Description*, Expression, Result | ||
| 6565 | |||
| 6566 | Attribute Documentation: | ||
| 6567 | |||
| 6568 | (% style="width:1160.29px" %) | ||
| 6569 | |**Name**|**Type**|**Documentation** | ||
| 6570 | |id|IDType|The id is the identifier for the object. | ||
| 6571 | |urn|TransformationUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6572 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6573 | |isPersistent|xs:boolean|Indicates if the the result is permanently stored. A persistent result (value of true) can be used by transformation defined in other transformation schemes, but a non-persistent result (value of false) can only be used by transformations within the same transformation scheme. | ||
| 6574 | |||
| 6575 | Element Documentation: | ||
| 6576 | |||
| 6577 | |**Name**|**Type**|**Documentation**| | ||
| 6578 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6579 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6580 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6581 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6582 | |Expression|xs:string|The right-hand side of the VTL statement. This is expression that is executed for this transformation. It include references to operands and other artefacts. The expression may contain references to SDMX artefacts using the reduced URN format; see Section 6 SDMX Standards ("SDMX Technical Notes"), 10.2.3 ("Abbreviation of the URN").| | ||
| 6583 | |Result|xs:string|The left-hand side of the VTL statement. This identifies the result artefact, which may be used in subsequent transformations. If the result is an SDMX artefact, the is expressed using the alias; see Section 6 SDMX Standards ("SDMX Technical Notes"), 10.2.3 ("Abbreviation of the URN").| | ||
| 6584 | |||
| 6585 | **VtlMappingSchemeType:** VtlMappingSchemeType defines a set of mappings between SDMX and VTL. | ||
| 6586 | |||
| 6587 | Derivation: | ||
| 6588 | |||
| 6589 | AnnotableType (extension) | ||
| 6590 | IdentifiableType (extension) | ||
| 6591 | NameableType (extension) | ||
| 6592 | VersionableType (restriction) | ||
| 6593 | MaintainableBaseType (extension) | ||
| 6594 | MaintainableType (extension) | ||
| 6595 | ItemSchemeType (restriction) | ||
| 6596 | VtlMappingSchemeType | ||
| 6597 | |||
| 6598 | Attributes: | ||
| 6599 | |||
| 6600 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial? | ||
| 6601 | |||
| 6602 | Content: | ||
| 6603 | |||
| 6604 | Annotations?, Link*, Name+, Description*, VtlMapping | ||
| 6605 | |||
| 6606 | Attribute Documentation: | ||
| 6607 | |||
| 6608 | (% style="width:1146.29px" %) | ||
| 6609 | |**Name**|**Type**|(% style="width:733px" %)**Documentation** | ||
| 6610 | |id|IDType|(% style="width:733px" %)The id is the identifier for the object. | ||
| 6611 | |urn|VtlMappingSchemeUrnType|(% style="width:733px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6612 | |uri|xs:anyURI|(% style="width:733px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6613 | |version|VersionType|(% style="width:733px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 6614 | |validFrom|xs:dateTime|(% style="width:733px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 6615 | |validTo|xs:dateTime|(% style="width:733px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 6616 | |agencyID|NestedNCNameIDType|(% style="width:733px" %)The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 6617 | |isExternalReference (default: false)|xs:boolean|(% style="width:733px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 6618 | |serviceURL|xs:anyURI|(% style="width:733px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 6619 | |structureURL|xs:anyURI|(% style="width:733px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 6620 | |isPartialLanguage (default: false)|xs:boolean|(% style="width:733px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 6621 | |isPartial (default: false)|xs:boolean|(% style="width:733px" %)The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. | ||
| 6622 | |||
| 6623 | Element Documentation: | ||
| 6624 | |||
| 6625 | |**Name**|**Type**|**Documentation**| | ||
| 6626 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6627 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6628 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6629 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6630 | |VtlMapping|VtlMappingType|VtlMapping details a mapping between SDMX and VTL transformation.| | ||
| 6631 | |||
| 6632 | //**VtlMappingBaseType:**// VtlMappingBaseType defines the base refinement of the VtlMappingType. Its purpose is to retrict the urn attribute. | ||
| 6633 | |||
| 6634 | Derivation: | ||
| 6635 | |||
| 6636 | AnnotableType (extension) | ||
| 6637 | IdentifiableType (extension) | ||
| 6638 | NameableType (restriction) | ||
| 6639 | ItemBaseType (extension) | ||
| 6640 | ItemType (restriction) | ||
| 6641 | UnnestedItemType (restriction) | ||
| 6642 | VtlMappingBaseType | ||
| 6643 | |||
| 6644 | Attributes: | ||
| 6645 | |||
| 6646 | id, urn?, uri? | ||
| 6647 | |||
| 6648 | Content: | ||
| 6649 | |||
| 6650 | Annotations?, Link*, Name+, Description | ||
| 6651 | |||
| 6652 | Attribute Documentation: | ||
| 6653 | |||
| 6654 | |**Name**|**Type**|**Documentation**| | ||
| 6655 | |id|IDType|The id is the identifier for the object.| | ||
| 6656 | |urn|VtlMappingUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 6657 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 6658 | |||
| 6659 | Element Documentation: | ||
| 6660 | |||
| 6661 | |**Name**|**Type**|**Documentation**| | ||
| 6662 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6663 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6664 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6665 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6666 | |||
| 6667 | **VtlMappingType:** VtlMappingType defines the structure of a single mapping between the reference to a SDMX artefact made from VTL transformations, rulesets, user defined operators and the corresponding SDMX structure identifier. These are used to assign an alternative names to SDMX Dataflows, Codelists, Concept Schemes, or Concepts. Although are distinct sub-classes in the Information Model, this structure serves to express them all. The references SDMX artefact serves to distinguish which type of sub-class (VtlDatflowMapping or VtlCodelistMapping, or VtlConceptMapping) is being described. When this is used to assign an alias for a SDMX Dataflow, this can also be used to indicate the methods used to convert the data structure from SDMX to VTL and vice-versa. Finally, this can be used to override the deault Basic mapping methods used for Dataflows by utilizing the GenericDataflow element in place of a reference to a specific Dataflow. | ||
| 6668 | |||
| 6669 | Derivation: | ||
| 6670 | |||
| 6671 | AnnotableType (extension) | ||
| 6672 | IdentifiableType (extension) | ||
| 6673 | NameableType (restriction) | ||
| 6674 | ItemBaseType (extension) | ||
| 6675 | ItemType (restriction) | ||
| 6676 | UnnestedItemType (restriction) | ||
| 6677 | VtlMappingBaseType (extension) | ||
| 6678 | VtlMappingType | ||
| 6679 | |||
| 6680 | Attributes: | ||
| 6681 | |||
| 6682 | id, urn?, uri?, alias | ||
| 6683 | |||
| 6684 | Content: | ||
| 6685 | |||
| 6686 | Annotations?, Link*, Name+, Description*, ( ( (Dataflow|GenericDataflow), ToVtlMapping?, FromVtlMapping?)|Codelist|Concept) | ||
| 6687 | |||
| 6688 | Attribute Documentation: | ||
| 6689 | |||
| 6690 | |**Name**|**Type**|**Documentation**| | ||
| 6691 | |id|IDType|The id is the identifier for the object.| | ||
| 6692 | |urn|VtlMappingUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 6693 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 6694 | |alias|xs:string|The alias used to refer to the reference SDMX artefact in the transformations. This must be unique within the mapping scheme in which it is defined.| | ||
| 6695 | |||
| 6696 | Element Documentation: | ||
| 6697 | |||
| 6698 | (% style="width:1196.29px" %) | ||
| 6699 | |**Name**|**Type**|**Documentation** | ||
| 6700 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 6701 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 6702 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 6703 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 6704 | |Dataflow|DataflowReferenceType|A reference to the SDMX Dataflow that the mapping is defined for. This is used to create a VtlDataflowMapping. In this case, it is possible to specify the mapping details to and from VTL. | ||
| 6705 | |GenericDataflow|EmptyType|Indicates that the ToVtlMapping and FromVtlMapping are the default mapping methods to be applied, overriding the Basic methods if necessary. The mapping methods in this case would be applied to any dataflows that are not explicitly defined in other VtlMappings. | ||
| 6706 | |ToVtlMapping|ToVtlMappingType|Describes the mapping from a SDMX dataflow to a VTL data structure. | ||
| 6707 | |FromVtlMapping|FromVtlMappingType|Describes the mapping to a SDMX dataflow from a VTL data structure. | ||
| 6708 | |Codelist|CodelistReferenceType|A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping. | ||
| 6709 | |Concept|ConceptReferenceType|A reference to the SDMX Concept that the mapping is defined for. This is used to create a VtlConceptMapping. | ||
| 6710 | |||
| 6711 | **ToVtlMappingType:** ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL. | ||
| 6712 | |||
| 6713 | Attributes: | ||
| 6714 | |||
| 6715 | method? | ||
| 6716 | |||
| 6717 | Content: | ||
| 6718 | |||
| 6719 | ToVtlSubSpace? | ||
| 6720 | |||
| 6721 | Attribute Documentation: | ||
| 6722 | |||
| 6723 | (% style="width:1045.29px" %) | ||
| 6724 | |**Name**|**Type**|(% style="width:721px" %)**Documentation** | ||
| 6725 | |method|ToVtlMappingMethodType|(% style="width:721px" %)The mapping method used when mapping from SDMX to VTL. This is typically a StandardToVtlMappingMethodType, but can be any other value to allow for non-standard methods. The implied default is Basic. | ||
| 6726 | |||
| 6727 | Element Documentation: | ||
| 6728 | |||
| 6729 | (% style="width:1054.29px" %) | ||
| 6730 | |**Name**|**Type**|(% style="width:659px" %)**Documentation** | ||
| 6731 | |ToVtlSubSpace|SpaceKeyType|(% style="width:659px" %)Identfies a sub space of the mapped dataflow that the mapping applies to. This is a collection of references to the dimensions that make up the space. | ||
| 6732 | |||
| 6733 | **FromVtlMappingType:** FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX. | ||
| 6734 | |||
| 6735 | Attributes: | ||
| 6736 | |||
| 6737 | method? | ||
| 6738 | |||
| 6739 | Content: | ||
| 6740 | |||
| 6741 | FromVtlSuperSpace? | ||
| 6742 | |||
| 6743 | Attribute Documentation: | ||
| 6744 | |||
| 6745 | (% style="width:1085.29px" %) | ||
| 6746 | |**Name**|**Type**|(% style="width:789px" %)**Documentation** | ||
| 6747 | |method|FromVtlMappingMethodType|(% style="width:789px" %)The mapping method used when mapping from VTL to SDMX. This is typically a StandardFromVtlMappingMethodType, but can be any other value to allow for non-standard methods. The implied default is Basic for single-measure VTL data structures and Unpivot for multi-meausre VTL data structures. | ||
| 6748 | |||
| 6749 | Element Documentation: | ||
| 6750 | |||
| 6751 | |**Name**|**Type**|**Documentation**| | ||
| 6752 | |FromVtlSuperSpace|SpaceKeyType|Identfies a super space of the mapped dataflow that the mapping applies to. This is a collection of references to the dimensions that make up the space.| | ||
| 6753 | |||
| 6754 | **SpaceKeyType:** SpaceKey defines the structure of a super- or sub- space for a SDMX Dataflow. It is a collection of references to the dimensions that make up the space. | ||
| 6755 | |||
| 6756 | Content: | ||
| 6757 | |||
| 6758 | Key+ | ||
| 6759 | |||
| 6760 | Element Documentation: | ||
| 6761 | |||
| 6762 | |**Name**|**Type**|**Documentation**| | ||
| 6763 | |Key|SingleNCNameIDType|A reference to a dimension by its identifier.| | ||
| 6764 | |||
| 6765 | **NamePersonalisationSchemeType:** NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations. | ||
| 6766 | |||
| 6767 | Derivation: | ||
| 6768 | |||
| 6769 | AnnotableType (extension) | ||
| 6770 | IdentifiableType (extension) | ||
| 6771 | NameableType (extension) | ||
| 6772 | VersionableType (restriction) | ||
| 6773 | MaintainableBaseType (extension) | ||
| 6774 | MaintainableType (extension) | ||
| 6775 | ItemSchemeType (extension) | ||
| 6776 | VtlDefinitionSchemeType (restriction) | ||
| 6777 | NamePersonalisationSchemeType | ||
| 6778 | |||
| 6779 | Attributes: | ||
| 6780 | |||
| 6781 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 6782 | |||
| 6783 | Content: | ||
| 6784 | |||
| 6785 | Annotations?, Link*, Name+, Description*, NamePersonalisation | ||
| 6786 | |||
| 6787 | Attribute Documentation: | ||
| 6788 | |||
| 6789 | |**Name**|**Type**|**Documentation**| | ||
| 6790 | |id|IDType|The id is the identifier for the object.| | ||
| 6791 | |urn|NamePersonalisationS chemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 6792 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 6793 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 6794 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 6795 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 6796 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 6797 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 6798 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 6799 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 6800 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 6801 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.| | ||
| 6802 | |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.| | ||
| 6803 | |||
| 6804 | Element Documentation: | ||
| 6805 | |||
| 6806 | (% style="width:1228.29px" %) | ||
| 6807 | |**Name**|**Type**|(% style="width:826px" %)**Documentation** | ||
| 6808 | |Annotations|AnnotationsType|(% style="width:826px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 6809 | |Link|LinkType|(% style="width:826px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 6810 | |Name|TextType|(% style="width:826px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 6811 | |Description|TextType|(% style="width:826px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 6812 | |NamePersonalisation|NamePersonalisationType|(% style="width:826px" %)NamePersonalisation details a name personalisation that is used in a transformation. | ||
| 6813 | |||
| 6814 | //**NamePersonalisationBaseType:**// NamePersonalisationBaseType defines the base refinement of the NamePersonalisationType. Its purpose is to retrict the urn attribute. | ||
| 6815 | |||
| 6816 | Derivation: | ||
| 6817 | |||
| 6818 | AnnotableType (extension) | ||
| 6819 | IdentifiableType (extension) | ||
| 6820 | NameableType (restriction) | ||
| 6821 | ItemBaseType (extension) | ||
| 6822 | ItemType (restriction) | ||
| 6823 | UnnestedItemType (restriction) | ||
| 6824 | NamePersonalisationBaseType | ||
| 6825 | |||
| 6826 | Attributes: | ||
| 6827 | |||
| 6828 | id, urn?, uri? | ||
| 6829 | |||
| 6830 | Content: | ||
| 6831 | |||
| 6832 | Annotations?, Link*, Name+, Description | ||
| 6833 | |||
| 6834 | Attribute Documentation: | ||
| 6835 | |||
| 6836 | (% style="width:1223.29px" %) | ||
| 6837 | |**Name**|**Type**|**Documentation** | ||
| 6838 | |id|IDType|The id is the identifier for the object. | ||
| 6839 | |urn|NamePersonalisationUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6840 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6841 | |||
| 6842 | Element Documentation: | ||
| 6843 | |||
| 6844 | |**Name**|**Type**|**Documentation**| | ||
| 6845 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6846 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6847 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6848 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6849 | |||
| 6850 | **NamePersonalisationType:** NamePersonalisationType defines the structure of a name personalisation. A name personalisation is is used in place of a standard VTL name in some VTL operations. | ||
| 6851 | |||
| 6852 | Derivation: | ||
| 6853 | |||
| 6854 | AnnotableType (extension) | ||
| 6855 | IdentifiableType (extension) | ||
| 6856 | NameableType (restriction) | ||
| 6857 | ItemBaseType (extension) | ||
| 6858 | ItemType (restriction) | ||
| 6859 | UnnestedItemType (restriction) | ||
| 6860 | NamePersonalisationBaseType (extension) | ||
| 6861 | NamePersonalisationType | ||
| 6862 | |||
| 6863 | Attributes: | ||
| 6864 | |||
| 6865 | id, urn?, uri?, vtlArtefact | ||
| 6866 | |||
| 6867 | Content: | ||
| 6868 | |||
| 6869 | Annotations?, Link*, Name+, Description*, VtlDefaultName, PersonalisedName | ||
| 6870 | |||
| 6871 | Attribute Documentation: | ||
| 6872 | |||
| 6873 | (% style="width:1127.29px" %) | ||
| 6874 | |**Name**|(% style="width:250px" %)**Type**|(% style="width:750px" %)**Documentation** | ||
| 6875 | |id|(% style="width:250px" %)IDType|(% style="width:750px" %)The id is the identifier for the object. | ||
| 6876 | |urn|(% style="width:250px" %)NamePersonalisationUrnType|(% style="width:750px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 6877 | |uri|(% style="width:250px" %)xs:anyURI|(% style="width:750px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 6878 | |vtlArtefact|(% style="width:250px" %)xs:string|(% style="width:750px" %)Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable. | ||
| 6879 | |||
| 6880 | Element Documentation: | ||
| 6881 | |||
| 6882 | |**Name**|**Type**|**Documentation**| | ||
| 6883 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6884 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6885 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6886 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6887 | |VtlDefaultName|xs:string|Provides the VTL standard name that is being personalised.| | ||
| 6888 | |PersonalisedName|xs:string|Provides the personalised name that is used in place of the VTL standard name in the transformation expressions.| | ||
| 6889 | |||
| 6890 | ***RulesetSchemeBaseType*:** RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets. | ||
| 6891 | |||
| 6892 | Derivation: | ||
| 6893 | |||
| 6894 | AnnotableType (extension) | ||
| 6895 | IdentifiableType (extension) | ||
| 6896 | NameableType (extension) | ||
| 6897 | VersionableType (restriction) | ||
| 6898 | MaintainableBaseType (extension) | ||
| 6899 | MaintainableType (extension) | ||
| 6900 | ItemSchemeType (extension) | ||
| 6901 | VtlDefinitionSchemeType (restriction) | ||
| 6902 | RulesetSchemeBaseType | ||
| 6903 | |||
| 6904 | Attributes: | ||
| 6905 | |||
| 6906 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 6907 | |||
| 6908 | Content: | ||
| 6909 | |||
| 6910 | Annotations?, Link*, Name+, Description*, Ruleset | ||
| 6911 | |||
| 6912 | Attribute Documentation: | ||
| 6913 | |||
| 6914 | |**Name**|**Type**|**Documentation**| | ||
| 6915 | |id|IDType|The id is the identifier for the object.| | ||
| 6916 | |urn|RulesetSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 6917 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 6918 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 6919 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 6920 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 6921 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 6922 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 6923 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 6924 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 6925 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 6926 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.| | ||
| 6927 | |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.| | ||
| 6928 | |||
| 6929 | Element Documentation: | ||
| 6930 | |||
| 6931 | |**Name**|**Type**|**Documentation**| | ||
| 6932 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 6933 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 6934 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6935 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 6936 | |Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme.| | ||
| 6937 | |||
| 6938 | **RulesetSchemeType:** RulesetSchemeType defines a collection of rulesets that are used in transformations. | ||
| 6939 | |||
| 6940 | Derivation: | ||
| 6941 | |||
| 6942 | AnnotableType (extension) | ||
| 6943 | IdentifiableType (extension) | ||
| 6944 | NameableType (extension) | ||
| 6945 | VersionableType (restriction) | ||
| 6946 | MaintainableBaseType (extension) | ||
| 6947 | MaintainableType (extension) | ||
| 6948 | ItemSchemeType (extension) | ||
| 6949 | VtlDefinitionSchemeType (restriction) | ||
| 6950 | RulesetSchemeBaseType (extension) | ||
| 6951 | RulesetSchemeType | ||
| 6952 | |||
| 6953 | Attributes: | ||
| 6954 | |||
| 6955 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 6956 | |||
| 6957 | Content: | ||
| 6958 | |||
| 6959 | Annotations?, Link*, Name+, Description*, Ruleset*, VtlMappingScheme? | ||
| 6960 | |||
| 6961 | Attribute Documentation: | ||
| 6962 | |||
| 6963 | |**Name**|**Type**|**Documentation**| | ||
| 6964 | |id|IDType|The id is the identifier for the object.| | ||
| 6965 | |urn|RulesetSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 6966 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 6967 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| | ||
| 6968 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| | ||
| 6969 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| | ||
| 6970 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.| | ||
| 6971 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| | ||
| 6972 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| | ||
| 6973 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| | ||
| 6974 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’.| | ||
| 6975 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.| | ||
| 6976 | |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.| | ||
| 6977 | |||
| 6978 | Element Documentation: | ||
| 6979 | |||
| 6980 | (% style="width:1185.29px" %) | ||
| 6981 | |**Name**|**Type**|**Documentation** | ||
| 6982 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 6983 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 6984 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 6985 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 6986 | |Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme. | ||
| 6987 | |VtlMappingScheme|VtlMappingSchemeReferenceType|References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the rulesets. Rulesets defined on value domains reference Codelists or Concept Schemes (the latter in VTL are considered as the Value Domains of the variables corresponding to the SDMX Measure Dimensions). The rulesets defined on variables reference Concepts (for which a definite representation is assumed). Therefore, a ruleset should only refer to Codelists, Concept Schemes, and Concepts. | ||
| 6988 | |||
| 6989 | //**RulesetBaseType:**// RulesetBaseType defines the base refinement of the RulesetType. Its purpose is to retrict the urn attribute. | ||
| 6990 | |||
| 6991 | Derivation: | ||
| 6992 | |||
| 6993 | AnnotableType (extension) | ||
| 6994 | IdentifiableType (extension) | ||
| 6995 | NameableType (restriction) | ||
| 6996 | ItemBaseType (extension) | ||
| 6997 | ItemType (restriction) | ||
| 6998 | UnnestedItemType (restriction) | ||
| 6999 | RulesetBaseType | ||
| 7000 | |||
| 7001 | Attributes: | ||
| 7002 | |||
| 7003 | id, urn?, uri? | ||
| 7004 | |||
| 7005 | Content: | ||
| 7006 | |||
| 7007 | Annotations?, Link*, Name+, Description | ||
| 7008 | |||
| 7009 | Attribute Documentation: | ||
| 7010 | |||
| 7011 | |**Name**|**Type**|**Documentation**| | ||
| 7012 | |id|IDType|The id is the identifier for the object.| | ||
| 7013 | |urn|RulesetUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 7014 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 7015 | |||
| 7016 | Element Documentation: | ||
| 7017 | |||
| 7018 | |**Name**|**Type**|**Documentation**| | ||
| 7019 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 7020 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 7021 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7022 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7023 | |||
| 7024 | **RulesetType:** RulesetType defines the structure of a ruleset. A ruleset is a persistent set of rules which can be invoked by using appropriate VTL operators. | ||
| 7025 | |||
| 7026 | Derivation: | ||
| 7027 | |||
| 7028 | AnnotableType (extension) | ||
| 7029 | IdentifiableType (extension) | ||
| 7030 | NameableType (restriction) | ||
| 7031 | ItemBaseType (extension) | ||
| 7032 | ItemType (restriction) | ||
| 7033 | UnnestedItemType (restriction) | ||
| 7034 | RulesetBaseType (extension) | ||
| 7035 | RulesetType | ||
| 7036 | |||
| 7037 | Attributes: | ||
| 7038 | |||
| 7039 | id, urn?, uri?, rulesetType, rulesetScope | ||
| 7040 | |||
| 7041 | Content: | ||
| 7042 | |||
| 7043 | Annotations?, Link*, Name+, Description*, RulesetDefinition | ||
| 7044 | |||
| 7045 | Attribute Documentation: | ||
| 7046 | |||
| 7047 | |**Name**|**Type**|**Documentation**| | ||
| 7048 | |id|IDType|The id is the identifier for the object.| | ||
| 7049 | |urn|RulesetUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 7050 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 7051 | |rulesetType|xs:string|The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical| | ||
| 7052 | |rulesetScope|xs:string|This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable.| | ||
| 7053 | |||
| 7054 | Element Documentation: | ||
| 7055 | |||
| 7056 | |**Name**|**Type**|**Documentation**| | ||
| 7057 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 7058 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 7059 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7060 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7061 | |RulesetDefinition|xs:string|A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language.| | ||
| 7062 | |||
| 7063 | //**UserDefinedOperatorSchemeBaseType:**// UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators. | ||
| 7064 | |||
| 7065 | Derivation: | ||
| 7066 | |||
| 7067 | AnnotableType (extension) | ||
| 7068 | IdentifiableType (extension) | ||
| 7069 | NameableType (extension) | ||
| 7070 | VersionableType (restriction) | ||
| 7071 | MaintainableBaseType (extension) | ||
| 7072 | MaintainableType (extension) | ||
| 7073 | ItemSchemeType (extension) | ||
| 7074 | VtlDefinitionSchemeType (restriction) | ||
| 7075 | UserDefinedOperatorSchemeBaseType | ||
| 7076 | |||
| 7077 | Attributes: | ||
| 7078 | |||
| 7079 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 7080 | |||
| 7081 | Content: | ||
| 7082 | |||
| 7083 | Annotations?, Link*, Name+, Description*, UserDefinedOperator | ||
| 7084 | |||
| 7085 | Attribute Documentation: | ||
| 7086 | |||
| 7087 | (% style="width:1289.29px" %) | ||
| 7088 | |**Name**|**Type**|**Documentation** | ||
| 7089 | |id|IDType|The id is the identifier for the object. | ||
| 7090 | |urn|UserDefinedOperatorSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 7091 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 7092 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 7093 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 7094 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 7095 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 7096 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 7097 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 7098 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 7099 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 7100 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. | ||
| 7101 | |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. | ||
| 7102 | |||
| 7103 | Element Documentation: | ||
| 7104 | |||
| 7105 | (% style="width:1146.29px" %) | ||
| 7106 | |**Name**|**Type**|(% style="width:744px" %)**Documentation** | ||
| 7107 | |Annotations|AnnotationsType|(% style="width:744px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 7108 | |Link|LinkType|(% style="width:744px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 7109 | |Name|TextType|(% style="width:744px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 7110 | |Description|TextType|(% style="width:744px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 7111 | |UserDefinedOperator|UserDefinedOperatorType|(% style="width:744px" %)UserDefinedOperator details a user defined operators within a user defined operator scheme. | ||
| 7112 | |||
| 7113 | **UserDefinedOperatorSchemeType:** UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations. | ||
| 7114 | |||
| 7115 | Derivation: | ||
| 7116 | |||
| 7117 | AnnotableType (extension) | ||
| 7118 | IdentifiableType (extension) | ||
| 7119 | NameableType (extension) | ||
| 7120 | VersionableType (restriction) | ||
| 7121 | MaintainableBaseType (extension) | ||
| 7122 | MaintainableType (extension) | ||
| 7123 | ItemSchemeType (extension) | ||
| 7124 | VtlDefinitionSchemeType (restriction) | ||
| 7125 | UserDefinedOperatorSchemeBaseType (extension) | ||
| 7126 | UserDefinedOperatorSchemeType | ||
| 7127 | |||
| 7128 | Attributes: | ||
| 7129 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 7130 | |||
| 7131 | Content: | ||
| 7132 | Annotations?, Link*, Name+, Description*, UserDefinedOperator*, VtlMappingScheme?, RulesetScheme | ||
| 7133 | |||
| 7134 | Attribute Documentation: | ||
| 7135 | |||
| 7136 | (% style="width:1233.29px" %) | ||
| 7137 | |**Name**|**Type**|**Documentation** | ||
| 7138 | |id|IDType|The id is the identifier for the object. | ||
| 7139 | |urn|UserDefinedOperatorSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 7140 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 7141 | |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 7142 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 7143 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 7144 | |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 7145 | |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 7146 | |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 7147 | |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 7148 | |isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 7149 | |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. | ||
| 7150 | |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. | ||
| 7151 | |||
| 7152 | Element Documentation: | ||
| 7153 | |||
| 7154 | (% style="width:1153.29px" %) | ||
| 7155 | |**Name**|**Type**|(% style="width:717px" %)**Documentation** | ||
| 7156 | |Annotations|AnnotationsType|(% style="width:717px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. | ||
| 7157 | |Link|LinkType|(% style="width:717px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. | ||
| 7158 | |Name|TextType|(% style="width:717px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 7159 | |Description|TextType|(% style="width:717px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 7160 | |UserDefinedOperator|UserDefinedOperatorType|(% style="width:717px" %)UserDefinedOperator details a user defined operators within a user defined operator scheme. | ||
| 7161 | |VtlMappingScheme|VtlMappingSchemeReferenceType|(% style="width:717px" %)References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the user defined operators. Although the VTL user defined operators are conceived to be defined on generic operands, so that the specific artefacts to be manipulated are passed as parameters at the invocation, it is also possible that they reference specific SDMX artefacts like Dataflows, Codelists and ConceptSchemes. In this case, the mapping schemes referenced here define the mappings to those artefacts. | ||
| 7162 | |RulesetScheme|RulesetSchemeReferenceType|(% style="width:717px" %)References a ruleset scheme defining rulesets utilized in the user defined operators. | ||
| 7163 | |||
| 7164 | //**UserDefinedOperatorBaseType:**// UserDefinedOperatorBaseType defines the base refinement of the UserDefinedOperatorType. Its purpose is to retrict the urn attribute. | ||
| 7165 | |||
| 7166 | Derivation: | ||
| 7167 | |||
| 7168 | AnnotableType (extension) | ||
| 7169 | IdentifiableType (extension) | ||
| 7170 | NameableType (restriction) | ||
| 7171 | ItemBaseType (extension) | ||
| 7172 | ItemType (restriction) | ||
| 7173 | UnnestedItemType (restriction) | ||
| 7174 | UserDefinedOperatorBaseType | ||
| 7175 | |||
| 7176 | Attributes: | ||
| 7177 | id, urn?, uri? | ||
| 7178 | |||
| 7179 | Content: | ||
| 7180 | Annotations?, Link, Name+, Description | ||
| 7181 | |||
| 7182 | Attribute Documentation: | ||
| 7183 | |||
| 7184 | (% style="width:1187.29px" %) | ||
| 7185 | |**Name**|**Type**|**Documentation** | ||
| 7186 | |id|IDType|The id is the identifier for the object. | ||
| 7187 | |urn|UserDefinedOperatorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 7188 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 7189 | |||
| 7190 | Element Documentation: | ||
| 7191 | |||
| 7192 | |**Name**|**Type**|**Documentation**| | ||
| 7193 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 7194 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 7195 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7196 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7197 | |||
| 7198 | **UserDefinedOperatorType:** UserDefinedOperatorType defines the structure of a user defined operator. A user defined operator is a custom VTL operator (not existing in the standard library) that extends the VTL standard library for specific purposes. In addition to its identification and name, and definition of the operator must be provided. | ||
| 7199 | |||
| 7200 | Derivation: | ||
| 7201 | |||
| 7202 | AnnotableType (extension) | ||
| 7203 | IdentifiableType (extension) | ||
| 7204 | NameableType (restriction) | ||
| 7205 | ItemBaseType (extension) | ||
| 7206 | ItemType (restriction) | ||
| 7207 | UnnestedItemType (restriction) | ||
| 7208 | UserDefinedOperatorBaseType (extension) | ||
| 7209 | UserDefinedOperatorType | ||
| 7210 | |||
| 7211 | Attributes: | ||
| 7212 | id, urn?, uri? | ||
| 7213 | |||
| 7214 | Content: | ||
| 7215 | Annotations?, Link, Name+, Description, OperatorDefinition | ||
| 7216 | |||
| 7217 | Attribute Documentation: | ||
| 7218 | |||
| 7219 | (% style="width:1104.29px" %) | ||
| 7220 | |**Name**|(% style="width:242px" %)**Type**|(% style="width:772px" %)**Documentation** | ||
| 7221 | |id|(% style="width:242px" %)IDType|(% style="width:772px" %)The id is the identifier for the object. | ||
| 7222 | |urn|(% style="width:242px" %)UserDefinedOperatorUrnType|(% style="width:772px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 7223 | |uri|(% style="width:242px" %)xs:anyURI|(% style="width:772px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 7224 | |||
| 7225 | Element Documentation: | ||
| 7226 | |||
| 7227 | |**Name**|**Type**|**Documentation**| | ||
| 7228 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 7229 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 7230 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7231 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7232 | |OperatorDefinition|xs:string|A VTL statement for the definition of a new operator: it specifies the operator name, its parameters and their data types, the VTL expression that defines its behaviour.| | ||
| 7233 | |||
| 7234 | **CustomTypeSchemeType:** CustomTypeSchemeType defines a collection of custom types that are used in transformations. | ||
| 7235 | |||
| 7236 | Derivation: | ||
| 7237 | |||
| 7238 | AnnotableType (extension) | ||
| 7239 | IdentifiableType (extension) | ||
| 7240 | NameableType (extension) | ||
| 7241 | VersionableType (restriction) | ||
| 7242 | MaintainableBaseType (extension) | ||
| 7243 | MaintainableType (extension) | ||
| 7244 | ItemSchemeType (extension) | ||
| 7245 | VtlDefinitionSchemeType (restriction) | ||
| 7246 | CustomTypeSchemeType | ||
| 7247 | |||
| 7248 | Attributes: | ||
| 7249 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 7250 | |||
| 7251 | Content: | ||
| 7252 | Annotations?, Link*, Name+, Description*, CustomType | ||
| 7253 | |||
| 7254 | Attribute Documentation: | ||
| 7255 | |||
| 7256 | (% style="width:1182.29px" %) | ||
| 7257 | |**Name**|**Type**|(% style="width:760px" %)**Documentation** | ||
| 7258 | |id|IDType|(% style="width:760px" %)The id is the identifier for the object. | ||
| 7259 | |urn|CustomTypeSchemeUrnType|(% style="width:760px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 7260 | |uri|xs:anyURI|(% style="width:760px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. | ||
| 7261 | |version|VersionType|(% style="width:760px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. | ||
| 7262 | |validFrom|xs:dateTime|(% style="width:760px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 7263 | |validTo|xs:dateTime|(% style="width:760px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 7264 | |agencyID|NestedNCNameIDType|(% style="width:760px" %)The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 7265 | |isExternalReference (default: false)|xs:boolean|(% style="width:760px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. | ||
| 7266 | |serviceURL|xs:anyURI|(% style="width:760px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. | ||
| 7267 | |structureURL|xs:anyURI|(% style="width:760px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. | ||
| 7268 | |isPartialLanguage (default: false)|xs:boolean|(% style="width:760px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. | ||
| 7269 | |isPartial (default: false)|xs:boolean|(% style="width:760px" %)The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. | ||
| 7270 | |vtlVersion|xs:string|(% style="width:760px" %)Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. | ||
| 7271 | |||
| 7272 | Element Documentation: | ||
| 7273 | |||
| 7274 | |**Name**|**Type**|**Documentation**| | ||
| 7275 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 7276 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 7277 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7278 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7279 | |CustomType|CustomTypeType|CustomType details a custom type within a custom type scheme.| | ||
| 7280 | |||
| 7281 | //**CustomTypeBaseType:**// CustomTypeBaseType defines the base refinement of the CustomTypeType. Its purpose is to retrict the urn attribute. | ||
| 7282 | |||
| 7283 | Derivation: | ||
| 7284 | |||
| 7285 | AnnotableType (extension) | ||
| 7286 | IdentifiableType (extension) | ||
| 7287 | NameableType (restriction) | ||
| 7288 | ItemBaseType (extension) | ||
| 7289 | ItemType (restriction) | ||
| 7290 | UnnestedItemType (restriction) | ||
| 7291 | CustomTypeBaseType | ||
| 7292 | |||
| 7293 | Attributes: | ||
| 7294 | id, urn?, uri? | ||
| 7295 | |||
| 7296 | Content: | ||
| 7297 | Annotations?, Link, Name+, Description | ||
| 7298 | |||
| 7299 | Attribute Documentation: | ||
| 7300 | |||
| 7301 | |**Name**|**Type**|**Documentation**| | ||
| 7302 | |id|IDType|The id is the identifier for the object.| | ||
| 7303 | |urn|CustomTypeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 7304 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 7305 | |||
| 7306 | Element Documentation: | ||
| 7307 | |||
| 7308 | |**Name**|**Type**|**Documentation**| | ||
| 7309 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 7310 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 7311 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7312 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7313 | |||
| 7314 | **CustomTypeType:** CustomTypeType defines the structure of a custom type. A custom type specifies a custom conversion for a VTL scalar type to a resulting data type. This conversion overrides the default conversion. | ||
| 7315 | |||
| 7316 | Derivation: | ||
| 7317 | |||
| 7318 | AnnotableType (extension) | ||
| 7319 | IdentifiableType (extension) | ||
| 7320 | NameableType (restriction) | ||
| 7321 | ItemBaseType (extension) | ||
| 7322 | ItemType (restriction) | ||
| 7323 | UnnestedItemType (restriction) | ||
| 7324 | CustomTypeBaseType (extension) | ||
| 7325 | CustomTypeType | ||
| 7326 | |||
| 7327 | Attributes: | ||
| 7328 | id, urn?, uri? | ||
| 7329 | |||
| 7330 | Content: | ||
| 7331 | Annotations?, Link*, Name+, Description*, VtlScalarType, DataType, VtlLiteralFormat?, OutputFormat?, NullValue? | ||
| 7332 | |||
| 7333 | Attribute Documentation: | ||
| 7334 | |||
| 7335 | |**Name**|**Type**|**Documentation**| | ||
| 7336 | |id|IDType|The id is the identifier for the object.| | ||
| 7337 | |urn|CustomTypeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| | ||
| 7338 | |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| | ||
| 7339 | |||
| 7340 | Element Documentation: | ||
| 7341 | |||
| 7342 | |**Name**|**Type**|**Documentation**| | ||
| 7343 | |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| | ||
| 7344 | |Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.| | ||
| 7345 | |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7346 | |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| | ||
| 7347 | |VtlScalarType|xs:string|Identifies the VTL scalar type that is to be converted to an resulting output data type.| | ||
| 7348 | |DataType|CustomTypeDataType|Identifies the resulting output data type the VTL scalar type is to be converted to. If this is an SDMX data type, it must use the proper SimpleDataType enumeration value. For all other data types, a string value can be used to identify the type.| | ||
| 7349 | |VtlLiteralFormat|xs:string|The format in which the literals of the VTL scalar type are expressed in the transformations. This is only needed if the format is different than the output format expressed by means of the VTL type.| | ||
| 7350 | |OutputFormat|xs:string|The format the VTL scalar type has to assume (e.g. YYYY-MM-DD; see VTL specifications), both for the literals in the VTL expressions and for the conversion to the output.| | ||
| 7351 | |NullValue|xs:string|The value to be produced in the output of the conversion when a component has a null value.| | ||
| 7352 | |||
| 7353 | === 2.1.4 Simple Types === | ||
| 7354 | |||
| 7355 | **CodeDataType:** CodeDataType is a restriction of the basic data types that are applicable to codes. Although some of the higher level time period formats are perimitted, it should be noted that any value which contains time (which includes a time zone offset) is not allowable as a code identifier. | ||
| 7356 | |||
| 7357 | Derived by restriction of SimpleDataType. | ||
| 7358 | |||
| 7359 | Enumerations: | ||
| 7360 | |||
| 7361 | (% style="width:1270.29px" %) | ||
| 7362 | |**Value**|(% style="width:1070px" %)**Documentation** | ||
| 7363 | |String|(% style="width:1070px" %)A string datatype corresponding to W3C XML Schema's xs:string datatype. | ||
| 7364 | |Alpha|(% style="width:1070px" %)A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. | ||
| 7365 | |AlphaNumeric|(% style="width:1070px" %)A string datatype which only allows for the simple alphabetic character set of A-Z, a-z plus the simple numeric character set of 0-9. | ||
| 7366 | |Numeric|(% style="width:1070px" %)A string datatype which only allows for the simple numeric character set of 0-9. This format is not treated as an integer, and therefore can having leading zeros. | ||
| 7367 | |BigInteger|(% style="width:1070px" %)An integer datatype corresponding to W3C XML Schema's xs:integer datatype. | ||
| 7368 | |Integer|(% style="width:1070px" %)An integer datatype corresponding to W3C XML Schema's xs:int datatype. | ||
| 7369 | |Long|(% style="width:1070px" %)A numeric datatype corresponding to W3C XML Schema's xs:long datatype. | ||
| 7370 | |Short|(% style="width:1070px" %)A numeric datatype corresponding to W3C XML Schema's xs:short datatype. | ||
| 7371 | |Boolean|(% style="width:1070px" %)A datatype corresponding to W3C XML Schema's xs:boolean datatype. | ||
| 7372 | |URI|(% style="width:1070px" %)A datatype corresponding to W3C XML Schema's xs:anyURI datatype. | ||
| 7373 | |Count|(% style="width:1070px" %)A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1". | ||
| 7374 | |InclusiveValueRange|(% style="width:1070px" %)This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal. | ||
| 7375 | |ExclusiveValueRange|(% style="width:1070px" %)This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal. | ||
| 7376 | |Incremental|(% style="width:1070px" %)This value indicates that the value increments according to the value provided in the interval facet, and has a true value for the isSequence facet. | ||
| 7377 | |ObservationalTimePeriod|(% style="width:1070px" %)Observational time periods are the superset of all time periods in SDMX. It is the union of the standard time periods (i.e. Gregorian time periods, the reporting time periods, and date time) and a time range. | ||
| 7378 | |StandardTimePeriod|(% style="width:1070px" %)Standard time periods is a superset of distinct time period in SDMX. It is the union of the basic time periods (i.e. the Gregorian time periods and date time) and the reporting time periods. | ||
| 7379 | |BasicTimePeriod|(% style="width:1070px" %)BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time. | ||
| 7380 | |GregorianTimePeriod|(% style="width:1070px" %)Gregorian time periods correspond to calendar periods and are represented in ISO-8601 formats. This is the union of the year, year month, and date formats. | ||
| 7381 | |GregorianYear|(% style="width:1070px" %)A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601. | ||
| 7382 | |GregorianYearMonth|(% style="width:1070px" %)A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601. | ||
| 7383 | |GregorianDay|(% style="width:1070px" %)A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601. | ||
| 7384 | |ReportingTimePeriod|(% style="width:1070px" %)Reporting time periods represent periods of a standard length within a reporting year, where to start of the year (defined as a month and day) must be defined elsewhere or it is assumed to be January 1. This is the union of the reporting year, semester, trimester, quarter, month, week, and day. | ||
| 7385 | |ReportingYear|(% style="width:1070px" %)A reporting year represents a period of 1 year (P1Y) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingYearType. | ||
| 7386 | |ReportingSemester|(% style="width:1070px" %)A reporting semester represents a period of 6 months (P6M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingSemesterType. | ||
| 7387 | |ReportingTrimester|(% style="width:1070px" %)A reporting trimester represents a period of 4 months (P4M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingTrimesterType. | ||
| 7388 | |ReportingQuarter|(% style="width:1070px" %)A reporting quarter represents a period of 3 months (P3M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingQuarterType. | ||
| 7389 | |ReportingMonth|(% style="width:1070px" %)A reporting month represents a period of 1 month (P1M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingMonthType. | ||
| 7390 | |ReportingWeek|(% style="width:1070px" %)A reporting week represents a period of 7 days (P7D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingWeekType. | ||
| 7391 | |ReportingDay|(% style="width:1070px" %)A reporting day represents a period of 1 day (P1D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingDayType. | ||
| 7392 | |Month|(% style="width:1070px" %)A time datatype corresponding to W3C XML Schema's xs:gMonth datatype. | ||
| 7393 | |MonthDay|(% style="width:1070px" %)A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype. | ||
| 7394 | |Day|(% style="width:1070px" %)A time datatype corresponding to W3C XML Schema's xs:gDay datatype. | ||
| 7395 | |Duration|(% style="width:1070px" %)A time datatype corresponding to W3C XML Schema's xs:duration datatype. | ||
| 7396 | |||
| 7397 | **WildcardedMemberValueType:** WildcardedMemberValueType allows for an optional wildcard characters ('%') in an identifier. | ||
| 7398 | |||
| 7399 | Derived by restriction of xs:string. | ||
| 7400 | Regular Expression Pattern: [A-Za-z0-9_@$-%]+ | ||
| 7401 | |||
| 7402 | **GeoCodelistTypeType:** GeoCodelistTypeType defines an enumeration of the speicfic types of geographic codelists. | ||
| 7403 | |||
| 7404 | Derived by restriction of xs:string. | ||
| 7405 | |||
| 7406 | Enumerations: | ||
| 7407 | |||
| 7408 | (% style="width:469.294px" %) | ||
| 7409 | |(% style="width:225px" %)**Value**|(% style="width:240px" %)**Documentation** | ||
| 7410 | |(% style="width:225px" %)GeographicCodelist|(% style="width:240px" %) | ||
| 7411 | |(% style="width:225px" %)GeoGridCodelist|(% style="width:240px" %) | ||
| 7412 | |||
| 7413 | **ConstraintRoleType:** ConstraintRoleType defines a list of roles for a content constraint. A constraint can state which data is present or which content is allowed for the constraint attachment. | ||
| 7414 | |||
| 7415 | Derived by restriction of xs:string. | ||
| 7416 | |||
| 7417 | Enumerations: | ||
| 7418 | |||
| 7419 | |**Value**|**Documentation**| | ||
| 7420 | |Allowed|The constraint contains the allowed values for attachable object.| | ||
| 7421 | |Actual|The constraints contains the actual data present for the attachable object.| | ||
| 7422 | |||
| 7423 | **SimpleOperatorType:** SimpleOperatorType provides an enumeration of simple operators to be applied to any value. | ||
| 7424 | |||
| 7425 | Derived by restriction of xs:string. | ||
| 7426 | |||
| 7427 | Enumerations: | ||
| 7428 | |||
| 7429 | (% style="width:705.894px" %) | ||
| 7430 | |(% style="width:250px" %) **Value**|(% style="width:454px" %) **Documentation** | ||
| 7431 | |(% style="width:250px" %) notEqual|(% style="width:454px" %) () - value must not be equal to the value supplied. | ||
| 7432 | |(% style="width:250px" %) equal|(% style="width:454px" %) (=) - value must be exactly equal to the value supplied. | ||
| 7433 | |||
| 7434 | **RangeOperatorType:** RangeOperatorType provides an enumeration of range operators to be applied to an ordered value. | ||
| 7435 | |||
| 7436 | Derived by restriction of xs:string. | ||
| 7437 | |||
| 7438 | Enumerations: | ||
| 7439 | |||
| 7440 | |**Value**|**Documentation**| | ||
| 7441 | |greaterThanOrEqual|(>=) - value must be greater than or equal to the value supplied.| | ||
| 7442 | |lessThanOrEqual|(<=) - value must be less than or equal to the value supplied.| | ||
| 7443 | |greaterThan|(>) - value must be greater than the value supplied.| | ||
| 7444 | |lessThan|(<) - value must be less than the value supplied.| | ||
| 7445 | |||
| 7446 | **TextSearchOperatorType:** TextSearchOperatorType provides an enumeration of text search operators. | ||
| 7447 | |||
| 7448 | Derived by restriction of xs:string. | ||
| 7449 | |||
| 7450 | Enumerations: | ||
| 7451 | |||
| 7452 | |**Value**|**Documentation**| | ||
| 7453 | |contains|The text being searched must contain the supplied text.| | ||
| 7454 | |startsWith|The text being searched must start with the supplied text.| | ||
| 7455 | |endsWith|The text being searched must end with the supplied text.| | ||
| 7456 | |doesNotContain|The text being searched cannot contain the supplied text.| | ||
| 7457 | |doesNotStartWith|The text being searched cannot start with the supplied text.| | ||
| 7458 | |doesNotEndWith|The text being searched cannot end with the supplied text.| | ||
| 7459 | |||
| 7460 | **OrderedOperatorType:** OrderedOperatorType combines the SimpleOperatorType and the RangeOperatorType to provide a full range or operators for any ordered value. | ||
| 7461 | |||
| 7462 | Union of: | ||
| 7463 | SimpleOperatorType, RangeOperatorType. | ||
| 7464 | |||
| 7465 | **TextOperatorType:** | ||
| 7466 | |||
| 7467 | Union of: | ||
| 7468 | SimpleOperatorType, TextSearchOperatorType. | ||
| 7469 | |||
| 7470 | **TimeOperatorType:** TimeOperatorType derives from the OrderedOperatorType to remove the notEqual operator. | ||
| 7471 | |||
| 7472 | Derived by restriction of OrderedOperatorType. | ||
| 7473 | |||
| 7474 | Enumerations: | ||
| 7475 | |||
| 7476 | |**Value**|**Documentation**| | ||
| 7477 | |equal| | | ||
| 7478 | |greaterThanOrEqual| | | ||
| 7479 | |lessThanOrEqual| | | ||
| 7480 | |greaterThan| | | ||
| 7481 | |lessThan| | | ||
| 7482 | |||
| 7483 | **UsageType:** An enumeration of optional|mandatory to indicate the usage of an attribute or measure. | ||
| 7484 | |||
| 7485 | Derived by restriction of xs:string. | ||
| 7486 | |||
| 7487 | Enumerations: | ||
| 7488 | |||
| 7489 | |**Value**|**Documentation**| | ||
| 7490 | |mandatory| | | ||
| 7491 | |optional| | | ||
| 7492 | |||
| 7493 | **SimpleCodeDataType:** SimpleCodeDataType restricts SimpleDataType to specify the allowable data types for a simple code. The possible values are simply Alpha, AlphaNumeric, or Numeric. | ||
| 7494 | |||
| 7495 | Derived by restriction of SimpleDataType. | ||
| 7496 | |||
| 7497 | Enumerations: | ||
| 7498 | |||
| 7499 | |**Value**|**Documentation**| | ||
| 7500 | |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.| | ||
| 7501 | |AlphaNumeric|A string datatype which only allows for the simple alphabetic character set of A-Z, a-z plus the simple numeric character set of 0-9.| | ||
| 7502 | |Numeric|A string datatype which only allows for the simple numeric character set of 0-9. This format is not treated as an integer, and therefore can having leading zeros.| | ||
| 7503 | |||
| 7504 | **EpochPeriodType:** EpochPeriodType defines an enumeration of epoch period types. | ||
| 7505 | |||
| 7506 | Derived by restriction of xs:string. | ||
| 7507 | |||
| 7508 | Enumerations: | ||
| 7509 | |||
| 7510 | |**Value**|**Documentation**| | ||
| 7511 | |nanosecond| | | ||
| 7512 | |millisecond| | | ||
| 7513 | |microsecond| | | ||
| 7514 | |second| | | ||
| 7515 | |day| | | ||
| 7516 | |||
| 7517 | **ResolvePeriodType:** ResolvePeriodType defines an enumeration of how date periods should be resolved. | ||
| 7518 | |||
| 7519 | Derived by restriction of xs:string. | ||
| 7520 | |||
| 7521 | Enumerations: | ||
| 7522 | |||
| 7523 | |**Value**|**Documentation**| | ||
| 7524 | |startOfPeriod| | | ||
| 7525 | |endOfPeriod| | | ||
| 7526 | |midPeriod| | | ||
| 7527 | |||
| 7528 | **StandardToVtlMappingMethodType:** A simple type enumerating the standard mapping methods when converting from data structures from SDMX to VLT. | ||
| 7529 | |||
| 7530 | Derived by restriction of xs:string. | ||
| 7531 | |||
| 7532 | Enumerations: | ||
| 7533 | |||
| 7534 | |**Value**|**Documentation**| | ||
| 7535 | |Basic|The default mapping method. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.1 ("Basic Mapping").| | ||
| 7536 | |Basic-A2M|The basic mapping method, using attributes to measures. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.3 ("From SDMX DataAttributes to VTL Measures").| | ||
| 7537 | |Pivot-A2M|The pivot mapping method, using attributes to measures. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.3 ("From SDMX DataAttributes to VTL Measures").| | ||
| 7538 | |||
| 7539 | **ToVtlMappingMethodType:** A simple type that allows for a standard to VTL mapping method enumeration value or a string value for other mapping methods. | ||
| 7540 | |||
| 7541 | Union of: | ||
| 7542 | StandardToVtlMappingMethodType, xs:string. | ||
| 7543 | |||
| 7544 | **StandardFromVtlMappingMethodType:** A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX. | ||
| 7545 | |||
| 7546 | Derived by restriction of xs:string. | ||
| 7547 | |||
| 7548 | Enumerations: | ||
| 7549 | |||
| 7550 | |**Value**|**Documentation** | ||
| 7551 | |Basic|The default mapping method, applicable only when the VLT data structure has just one measure component. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.4.1 ("Basic Mapping"). | ||
| 7552 | |M2A|Mapping of multi-measure VTL where on measure is mapped to the SDMX primary measure and the remaining measures are mapped as data attributes. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.4.3 ("From VTL Measures to SDMX DataAttributes"). | ||
| 7553 | |||
| 7554 | **FromVtlMappingMethodType:** A simple type that allows for standard from VTL mapping method enumeration value or a string value for other mapping methods. | ||
| 7555 | |||
| 7556 | Union of: | ||
| 7557 | StandardFromVtlMappingMethodType, xs:string. | ||
| 7558 | |||
| 7559 | **CustomTypeDataType:** A simple type that allows for a SDMX simple data type enumeration value or a string value for other data types. | ||
| 7560 | |||
| 7561 | Union of: | ||
| 7562 | SimpleDataType, xs:string. |