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 | **Corrigendum** | ||
| 6 | |||
| 7 | The following problems with the specification dated April 2011 have been rectified as described below. | ||
| 8 | |||
| 9 | ~1. Problem | ||
| 10 | |||
| 11 | Various parts of the the documentation refer to stand-alone (% style="color:#e74c3c" %)concepts(%%), which were part of earlier draft releases but ultimately excluded from the final release of the standard. | ||
| 12 | |||
| 13 | **Rectification** | ||
| 14 | |||
| 15 | The documentation has been updated to remove this reference. This documentation includes: | ||
| 16 | |||
| 17 | * (% style="color:#e74c3c" %)Concepts(%%) entry for Element Documentation of StructuresType (table beginning line 226). | ||
| 18 | * ConceptsType (line 270). | ||
| 19 | |||
| 20 | ~1. Problem | ||
| 21 | |||
| 22 | The ComponentMap element in the complex type StructureMapType has a maximum occurrence of 1. Therefore, it is not possible to completely (% style="color:#e74c3c" %)map(%%) all [[components>>doc:sdmx:Glossary.Component.WebHome]] of a structure. | ||
| 23 | |||
| 24 | **Rectification** | ||
| 25 | |||
| 26 | The documentation of the StructureMapType has been updated to reflect that maximum occurrence of "unbounded" (line 2508). | ||
| 27 | |||
| 28 | = 1 Introduction = | ||
| 29 | |||
| 30 | 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. | ||
| 31 | |||
| 32 | 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 frmed 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. | ||
| 33 | |||
| 34 | = 2 Schema Documentation = | ||
| 35 | |||
| 36 | == 2.1 Structure Namespace == | ||
| 37 | |||
| 38 | **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure** | ||
| 39 | |||
| 40 | === 2.1.1 Summary === | ||
| 41 | |||
| 42 | Referenced Namespaces: | ||
| 43 | |||
| 44 | (% style="width:772.835px" %) | ||
| 45 | |(% style="width:507px" %)**Namespace**|(% style="width:263px" %)**Prefix** | ||
| 46 | |(% style="width:507px" %) |(% style="width:263px" %) | ||
| 47 | |(% style="width:507px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:263px" %)com | ||
| 48 | |(% style="width:507px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:263px" %)xs | ||
| 49 | |||
| 50 | Contents: | ||
| 51 | 47 Global Elements | ||
| 52 | 199 Complex Types | ||
| 53 | 10 Simple Types | ||
| 54 | |||
| 55 | === 2.1.2 Global Elements === | ||
| 56 | |||
| 57 | **Structures (StructuresType): **Structures contains constructs for all [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 58 | |||
| 59 | //**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. | ||
| 60 | |||
| 61 | Substitutions: [[Category>>doc:sdmx:Glossary.Category.WebHome]], [[Code>>doc:sdmx:Glossary.Code.WebHome]], (% style="color:#e74c3c" %)Concept(%%), //Organisation//, Agency, DataConsumer, DataProvider, OrganisationUnit, ReportingCategory, Transformation, VtlMapping, NamePersonalisation, Ruleset, UserDefinedOperator, CustomType | ||
| 62 | |||
| 63 | //**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. | ||
| 64 | |||
| 65 | Substitutions: DataStructureComponents, MetadataStructureComponents | ||
| 66 | |||
| 67 | //**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. | ||
| 68 | |||
| 69 | Substitutions: AttributeList, DimensionList, Group, MeasureList, MetadataTarget, ReportStructure | ||
| 70 | |||
| 71 | //**[[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. | ||
| 72 | |||
| 73 | Substitutions: [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]], ReportingYearStartDay, [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], TimeDimension, MeasureDimension, GroupDimension, PrimaryMeasure, KeyDescriptorValuesTarget, DataSetTarget, ConstraintContentTarget, ReportPeriodTarget, IdentifiableObjectTarget, MetadataAttribute | ||
| 74 | |||
| 75 | **[[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]]. | ||
| 76 | |||
| 77 | Substitution For: //Item// | ||
| 78 | |||
| 79 | **[[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. | ||
| 80 | |||
| 81 | Substitution For: //Item// | ||
| 82 | |||
| 83 | (% 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]]. | ||
| 84 | |||
| 85 | Substitution For: //Item// | ||
| 86 | |||
| 87 | **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 three reserved identifiers in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]; OBS_VALUE, TIME_PERIOD, and REPORTING_PERIOD_START_DAY. These identifiers may not be used outside of their respective defintions (PrimaryMeasure, 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. | ||
| 88 | |||
| 89 | Substitution For: //Grouping// | ||
| 90 | |||
| 91 | **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]]. | ||
| 92 | |||
| 93 | Substitution For: //ComponentList// | ||
| 94 | |||
| 95 | **[[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. | ||
| 96 | |||
| 97 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 98 | |||
| 99 | **ReportingYearStartDay (ReportingYearStartDayType): **ReportingYearStartDay is a specialized data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which provides important context to the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. If the value of the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is one of the standard reporting periods (see common:ReportingTimePeriodType) then this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to state the month and day that the reporting year begins. This provides a reference point from which the actual calendar dates covered by these periods can be determined. If this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does not occur in a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], then the reporting year start day will be assumed to be January 1. | ||
| 100 | |||
| 101 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 102 | |||
| 103 | **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. | ||
| 104 | |||
| 105 | Substitution For: //ComponentList// | ||
| 106 | |||
| 107 | **[[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. | ||
| 108 | |||
| 109 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 110 | |||
| 111 | **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. | ||
| 112 | |||
| 113 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 114 | |||
| 115 | **MeasureDimension (MeasureDimensionType): **MeasureDimension is a special type of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which defines multiple [[measures>>doc:sdmx:Glossary.Measure.WebHome]] in a key family. This is represented as any other [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in a unless it is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. It takes it [[representation>>doc:sdmx:Glossary.Representation.WebHome]] from a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]], and this scheme defines the [[measures>>doc:sdmx:Glossary.Measure.WebHome]] and their [[representations>>doc:sdmx:Glossary.Representation.WebHome]]. When data is formatted with this as the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], these [[measures>>doc:sdmx:Glossary.Measure.WebHome]] can be made explicit or the value of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be treated as any other [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. If the [[measures>>doc:sdmx:Glossary.Measure.WebHome]] are explicit, the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the observation will be specific to the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for each (% style="color:#e74c3c" %)concept(%%) in the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]. Note that it is necessary that these [[representations>>doc:sdmx:Glossary.Representation.WebHome]] are compliant (the same or derived from) with that of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. | ||
| 116 | |||
| 117 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 118 | |||
| 119 | **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]]. | ||
| 120 | |||
| 121 | Substitution For: //ComponentList// | ||
| 122 | |||
| 123 | **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(%%). | ||
| 124 | |||
| 125 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 126 | |||
| 127 | **MeasureList (MeasureListType): **MeasureList describes the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] descriptor for a key family. It contains a single metadata (% style="color:#e74c3c" %)concepts(%%) that define the primary [[measures>>doc:sdmx:Glossary.Measure.WebHome]] of a data structure. | ||
| 128 | |||
| 129 | Substitution For: //ComponentList// | ||
| 130 | |||
| 131 | **PrimaryMeasure (PrimaryMeasureType): **PrimaryMeasure defines the structure of the primary [[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]]. Although this may take its semantic from any (% style="color:#e74c3c" %)concept(%%), this is provided a fixed identifier (OBS_VALUE) so that it may be easily distinguished in data messages. | ||
| 132 | |||
| 133 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 134 | |||
| 135 | **MetadataStructureComponents (MetadataStructureComponentsType): **MetadataStructureComponents defines the grouping of the sets of the [[components>>doc:sdmx:Glossary.Component.WebHome]] that make up the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. All [[components>>doc:sdmx:Glossary.Component.WebHome]] and [[component>>doc:sdmx:Glossary.Component.WebHome]] list (target identifiers, identifier [[components>>doc:sdmx:Glossary.Component.WebHome]], report structures, and metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) in the structure definition must have a unique identification. | ||
| 136 | |||
| 137 | Substitution For: //Grouping// | ||
| 138 | |||
| 139 | **MetadataTarget (MetadataTargetType): **MetadataTarget is a collection of target objects which when taken together describe a structure which defines the key of an object type to which metadata may be attached and serve to disambiguate [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] set reports. | ||
| 140 | |||
| 141 | Substitution For: //ComponentList// | ||
| 142 | |||
| 143 | **KeyDescriptorValuesTarget (KeyDescriptorValuesTargetType): **KeyDescriptorValuesTarget is target object which references a data key for the purpose of attach [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] to portions of data. A data key is a set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] references and values for those [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This [[component>>doc:sdmx:Glossary.Component.WebHome]] on its own is not of much use, as the data key only has local references to the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]. Therefore it is typical that this is used in combination with some sort of reference to the data (either a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] reference or a reference to the underlying structure, structure usage, or [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] of the data. | ||
| 144 | |||
| 145 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 146 | |||
| 147 | **DataSetTarget (DataSetTargetType): **DataSetTarget is target object which references a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] for the purpose of attaching [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] data. A [[data set>>doc:sdmx:Glossary.Data set.WebHome]] reference is a full reference to a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] and an identifier for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 148 | |||
| 149 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 150 | |||
| 151 | **ConstraintContentTarget (ConstraintContentTargetType): **ConstraintContentTarget is target object which references an attachment (% style="color:#e74c3c" %)constraint(%%) for the purpose of attaching [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] data to data key sets or cube regions defined by the (% style="color:#e74c3c" %)constraint(%%). | ||
| 152 | |||
| 153 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 154 | |||
| 155 | **ReportPeriodTarget (ReportPeriodTargetType): **ReportPeriodTarget is target object which specifies a reporting period to which a metadata report applies. | ||
| 156 | |||
| 157 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 158 | |||
| 159 | **IdentifiableObjectTarget (IdentifiableObjectTargetType): **IdentifiableObjectTarget is target object which references an Identifiable object as defined in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. The reference must be complete (i.e. a URN or a complete set of reference fields). For an item object, it is possible to define a local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] from which the item must be referenced. | ||
| 160 | |||
| 161 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 162 | |||
| 163 | **ReportStructure (ReportStructureType): **ReportStructure defines a report structure, which comprises a 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 report 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. | ||
| 164 | |||
| 165 | Substitution For: //ComponentList// | ||
| 166 | |||
| 167 | **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>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. | ||
| 168 | |||
| 169 | Substitution For: //[[Component>>doc:sdmx:Glossary.Component.WebHome]]// | ||
| 170 | |||
| 171 | //**Organisation**//** (//OrganisationType//): **Organisation is an abstract substitution head for a generic organisation. | ||
| 172 | |||
| 173 | Substitution For: //Item// | ||
| 174 | |||
| 175 | Substitutions: Agency, DataConsumer, DataProvider, OrganisationUnit | ||
| 176 | |||
| 177 | **Agency (AgencyType): **Agency is an organisation which maintains [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] such as statistical classifications, glossaries, key family structural definitions, and [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].. | ||
| 178 | |||
| 179 | Substitution For: //Organisation// | ||
| 180 | |||
| 181 | **DataConsumer (DataConsumerType): **DataConsumer describes an organisation using data as input for further processing. | ||
| 182 | |||
| 183 | Substitution For: //Organisation// | ||
| 184 | |||
| 185 | **DataProvider (DataProviderType): **DataProvider describes an organisation that produces data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]. | ||
| 186 | |||
| 187 | Substitution For: //Organisation// | ||
| 188 | |||
| 189 | **OrganisationUnit (OrganisationUnitType): **OrganisationUnit describes a generic organisation, which serves not predefined role in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. | ||
| 190 | |||
| 191 | Substitution For: //Organisation// | ||
| 192 | |||
| 193 | **ReportingCategory (ReportingCategoryType): **ReportingCateogry defines a reporting [[category>>doc:sdmx:Glossary.Category.WebHome]], which is used to group structure usages into useful sub-packages. | ||
| 194 | |||
| 195 | Substitution For: //Item// | ||
| 196 | |||
| 197 | //**ItemAssociation**//** (//ItemAssociationType//): **ItemAssociation is an abstract description of the relation between two items for the purpose of mapping. | ||
| 198 | |||
| 199 | Substitutions: OrganisationMap, CategoryMap, CodeMap, ConceptMap, ReportingCategoryMap | ||
| 200 | |||
| 201 | **OrganisationMap (OrganisationMapType): **OrganisationMap relates a source organisation to a target organisation. | ||
| 202 | |||
| 203 | Substitution For: //ItemAssociation// | ||
| 204 | |||
| 205 | **CategoryMap (CategoryMapType): **CategoryMap defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between [[categories>>doc:sdmx:Glossary.Category.WebHome]] in different [[category>>doc:sdmx:Glossary.Category.WebHome]] schemes. | ||
| 206 | |||
| 207 | Substitution For: //ItemAssociation// | ||
| 208 | |||
| 209 | **CodeMap (CodeMapType): **CodeMap defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between [[codes>>doc:sdmx:Glossary.Code.WebHome]] in different [[codelists>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 210 | |||
| 211 | Substitution For: //ItemAssociation// | ||
| 212 | |||
| 213 | **ConceptMap (ConceptMapType): **ConceptMap defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between (% style="color:#e74c3c" %)concepts(%%) in different (% style="color:#e74c3c" %)concept(%%) schemes. | ||
| 214 | |||
| 215 | Substitution For: //ItemAssociation// | ||
| 216 | |||
| 217 | **ReportingCategoryMap (ReportingCategoryMapType): **ReportingCategoryMap defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between reporting [[categories>>doc:sdmx:Glossary.Category.WebHome]] in different reporting taxonomies. | ||
| 218 | |||
| 219 | Substitution For: //ItemAssociation// | ||
| 220 | |||
| 221 | **Transformation (TransformationType): **Transformation describes the details of a single transformation within a transformation scheme. | ||
| 222 | |||
| 223 | Substitution For: //Item// | ||
| 224 | |||
| 225 | **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. | ||
| 226 | |||
| 227 | Substitution For: //Item// | ||
| 228 | |||
| 229 | **NamePersonalisation (NamePersonalisationType): **NamePersonalisation details a name personalisation that is used in a transformation. | ||
| 230 | |||
| 231 | Substitution For: //Item// | ||
| 232 | |||
| 233 | **Ruleset (RulesetType): **Ruleset details a ruleset within a ruleset scheme. | ||
| 234 | |||
| 235 | Substitution For: //Item// | ||
| 236 | |||
| 237 | **UserDefinedOperator (UserDefinedOperatorType): **UserDefinedOperator details a user defined operators within a user defined operator scheme. | ||
| 238 | |||
| 239 | Substitution For: //Item// | ||
| 240 | |||
| 241 | **CustomType (CustomTypeType): **CustomType details a custom type within a custom type scheme. | ||
| 242 | |||
| 243 | Substitution For: //Item// | ||
| 244 | |||
| 245 | === 2.1.3 Complex Types === | ||
| 246 | |||
| 247 | **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. | ||
| 248 | |||
| 249 | Content: | ||
| 250 | |||
| 251 | OrganisationSchemes?, [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]]?, [[Metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]]?, CategorySchemes?, Categorisations?, [[Codelists>>doc:sdmx:Glossary.Code list.WebHome]]?, HierarchicalCodelists?, (% style="color: rgb(231, 76, 60); color: rgb(231, 76, 60)" %)Concepts(%%)?, MetadataStructures?, DataStructures?, StructureSets?, ReportingTaxonomies?, Processes?, (% style="color: rgb(231, 76, 60); color: rgb(231, 76, 60)" %)Constraints(%%)?, ProvisionAgreements?, CustomTypes?, VtlMappings?, NamePersonalisations?, Rulesets?, Transformations?, UserDefinedOperators? | ||
| 252 | |||
| 253 | Element Documentation: | ||
| 254 | |||
| 255 | |**Name**|**Type**|**Documentation** | ||
| 256 | |OrganisationSchemes|OrganisationSchemesType|OrganisationSchemes contains a collection of organisation scheme descriptions. The organisation schemes may be detailed in full, or referenced from an external structure document or registry service. | ||
| 257 | |[[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. | ||
| 258 | |[[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. | ||
| 259 | |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. | ||
| 260 | |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. | ||
| 261 | |[[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. | ||
| 262 | |HierarchicalCodelists|HierarchicalCodelistsType|HierarchicalCodelists 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. | ||
| 263 | |(%%)(% style="color:#e74c3c" %)Concepts|ConceptsType|(%%)(% style="color:#e74c3c" %)Concepts(%%) contains a collection of (% style="color:#e74c3c" %)concept(%%) descriptions. The (% style="color:#e74c3c" %)concepts(%%) 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. | ||
| 264 | |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. | ||
| 265 | |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. | ||
| 266 | |StructureSets|StructureSetsType|StructureSets contains a collection of [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]] descriptions. The [[structure sets>>doc:sdmx:Glossary.Structure set.WebHome]] may be detailed in full, or referenced from an external structure document or registry service. | ||
| 267 | |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. | ||
| 268 | |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. | ||
| 269 | |(%%)(% style="color:#e74c3c" %)Constraints|ConstraintsType|(%%)(% style="color:#e74c3c" %)Constraints(%%) contains a collection of (% style="color:#e74c3c" %)constraint(%%) descriptions. This container may contain both attachment and content (% style="color:#e74c3c" %)constraints(%%). The (% style="color:#e74c3c" %)constraints(%%) may be detailed in full, or referenced from an external structure document or registry service. | ||
| 270 | |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. | ||
| 271 | |CustomTypes|CustomTypesType|CustomTypes contains a collection of custom type schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. | ||
| 272 | |VtlMappings|VtlMappingsType|VtlMappings 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. | ||
| 273 | |NamePersonalisations|NamePersonalisations Type|NamePersonalisations contains a collection of name personalisation schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. | ||
| 274 | |Rulesets|RulesetsType|Rulsets contains a collection of ruleset schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. | ||
| 275 | |Transformations|TransformationsType|Transformations contains a collection of transformation schemes. The transformation schemes may be detailed in full, or referenced from an external structure document or registry service. | ||
| 276 | |UserDefinedOperators|UserDefinedOperatorsType|UserDefinedOperators 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. | ||
| 277 | |||
| 278 | **OrganisationSchemesType: **OrganisationSchemesType describes the structure of the organisation schemes container. It contains one or more organisation scheme, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 279 | |||
| 280 | Content: | ||
| 281 | (AgencyScheme | DataConsumerScheme | DataProviderScheme | OrganisationUnitScheme)+ | ||
| 282 | |||
| 283 | Element Documentation: | ||
| 284 | |||
| 285 | |**Name**|**Type**|**Documentation** | ||
| 286 | |AgencyScheme|AgencySchemeType|AgencyScheme provides the details of an [[agency scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]], in which agencies are described. | ||
| 287 | |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. | ||
| 288 | |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. | ||
| 289 | |OrganisationUnitSche me|OrganisationUnitSchemeType|OrganisationUnitScheme provides the details of an [[organisation unit scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]], in which organisation units are described. | ||
| 290 | |||
| 291 | **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. | ||
| 292 | |||
| 293 | Content: | ||
| 294 | [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]+ | ||
| 295 | |||
| 296 | Element Documentation: | ||
| 297 | |||
| 298 | |**Name**|**Type**|**Documentation** | ||
| 299 | |[[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. | ||
| 300 | |||
| 301 | **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. | ||
| 302 | |||
| 303 | Content: | ||
| 304 | [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]+ | ||
| 305 | |||
| 306 | Element Documentation: | ||
| 307 | |||
| 308 | |**Name**|**Type**|**Documentation** | ||
| 309 | |[[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 | ||
| 310 | |||
| 311 | **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. | ||
| 312 | |||
| 313 | Content: | ||
| 314 | CategoryScheme+ | ||
| 315 | |||
| 316 | Element Documentation: | ||
| 317 | |||
| 318 | |**Name**|**Type**|**Documentation** | ||
| 319 | |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]]. | ||
| 320 | |||
| 321 | **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. | ||
| 322 | |||
| 323 | Content: | ||
| 324 | Categorisation+ | ||
| 325 | |||
| 326 | Element Documentation: | ||
| 327 | |||
| 328 | |**Name**|**Type**|**Documentation** | ||
| 329 | |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. | ||
| 330 | |||
| 331 | **CodelistsType: **CodelistsType describes the structure of the [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] container. It contains one or more [[code list>>doc:sdmx:Glossary.Code list.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 332 | |||
| 333 | Content: | ||
| 334 | [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]+ | ||
| 335 | |||
| 336 | Element Documentation: | ||
| 337 | |||
| 338 | |**Name**|**Type**|**Documentation** | ||
| 339 | |[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]|CodelistType|[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] provides the details of a [[code list>>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. | ||
| 340 | |||
| 341 | **HierarchicalCodelistsType: **HierarchicalCodelistsType describes the structure of the [[hierarchical code lists>>doc:sdmx:Glossary.Hierarchical code list.WebHome]] container. It contains one or more [[hierarchical code list>>doc:sdmx:Glossary.Hierarchical code list.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 342 | |||
| 343 | Content: | ||
| 344 | HierarchicalCodelist+ | ||
| 345 | |||
| 346 | Element Documentation: | ||
| 347 | |||
| 348 | |**Name**|**Type**|**Documentation** | ||
| 349 | |HierarchicalCodelist|HierarchicalCodelistType|HierarchicalCodelist provides the details of a [[hierarchical code list>>doc:sdmx:Glossary.Hierarchical code list.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, as defined by one or more [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of the list. | ||
| 350 | |||
| 351 | **ConceptsType: **ConceptsType describes the structure of the (% style="color:#e74c3c" %)concepts(%%) 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. | ||
| 352 | |||
| 353 | Content: | ||
| 354 | ConceptScheme* | ||
| 355 | |||
| 356 | Element Documentation: | ||
| 357 | |||
| 358 | |**Name**|**Type**|**Documentation** | ||
| 359 | |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. | ||
| 360 | |||
| 361 | **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. | ||
| 362 | |||
| 363 | Content: | ||
| 364 | MetadataStructure+ | ||
| 365 | |||
| 366 | Element Documentation: | ||
| 367 | |||
| 368 | |**Name**|**Type**|**Documentation** | ||
| 369 | |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 a [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] report is derived from this presentational structure. | ||
| 370 | |||
| 371 | **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. | ||
| 372 | |||
| 373 | Content: | ||
| 374 | DataStructure+ | ||
| 375 | |||
| 376 | Element Documentation: | ||
| 377 | |||
| 378 | |**Name**|**Type**|**Documentation** | ||
| 379 | |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. | ||
| 380 | |||
| 381 | **StructureSetsType: **StructureSetsType describes the structure of the [[structure sets>>doc:sdmx:Glossary.Structure set.WebHome]] container. It contains one or more [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]], which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 382 | |||
| 383 | Content: | ||
| 384 | StructureSet+ | ||
| 385 | |||
| 386 | Element Documentation: | ||
| 387 | |||
| 388 | |**Name**|**Type**|**Documentation** | ||
| 389 | |StructureSet|StructureSetType|StructureSet provides the details or a [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]], which allows [[components>>doc:sdmx:Glossary.Component.WebHome]] in one structure, structure usage, or [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] to be (% style="color:#e74c3c" %)mapped(%%) to [[components>>doc:sdmx:Glossary.Component.WebHome]] in another structural [[component>>doc:sdmx:Glossary.Component.WebHome]] of the same type. | ||
| 390 | |||
| 391 | **ReportingTaxonomiesType: **ReportingTaxonomiesType describes the structure of the reporting taxonomies container. It contains one or more reporting taxonomy, which can be explicitly detailed or referenced from an external structure document or registry service. | ||
| 392 | |||
| 393 | Content: | ||
| 394 | ReportingTaxonomy+ | ||
| 395 | |||
| 396 | Element Documentation: | ||
| 397 | |||
| 398 | |**Name**|**Type**|**Documentation** | ||
| 399 | |ReportingTaxonomy|ReportingTaxonomyType|ReportingTaxonomy provides the details of a reporting taxonomy, 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. | ||
| 400 | |||
| 401 | **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. | ||
| 402 | |||
| 403 | Content: | ||
| 404 | Process+ | ||
| 405 | |||
| 406 | Element Documentation: | ||
| 407 | |||
| 408 | |**Name**|**Type**|**Documentation** | ||
| 409 | |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. | ||
| 410 | |||
| 411 | **ConstraintsType: **ConstraintsType describes the structure of the (% style="color:#e74c3c" %)constraints(%%) container. It contains one or more (% 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(%%). | ||
| 412 | |||
| 413 | Content | ||
| 414 | (AttachmentConstraint | ContentConstraint)+ | ||
| 415 | |||
| 416 | Element Documentation: | ||
| 417 | |||
| 418 | |**Name**|**Type**|**Documentation** | ||
| 419 | |AttachmentConstraint|AttachmentConstraintType|AttachmentConstraint describes sub sets of the content of a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] in terms of the content regions or in terms of the set of key combinations to which [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] (as defined by structure definitions) may be attached. | ||
| 420 | |ContentConstraint|ContentConstraintType|ContentConstraint specifies a sub set of the definition of the allowable or available content of a data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] in terms of the content or in terms of the set of key combinations. | ||
| 421 | |||
| 422 | **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. | ||
| 423 | |||
| 424 | Content: | ||
| 425 | ProvisionAgreement+ | ||
| 426 | |||
| 427 | Element Documentation: | ||
| 428 | |||
| 429 | |**Name**|**Type**|**Documentation** | ||
| 430 | |ProvisionAgreement|ProvisionAgreementTy pe|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 or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] against a flow. | ||
| 431 | |||
| 432 | **CustomTypesType: **CustomTypesType 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. | ||
| 433 | |||
| 434 | Content: | ||
| 435 | CustomTypeScheme+ | ||
| 436 | |||
| 437 | Element Documentation: | ||
| 438 | |||
| 439 | |**Name**|**Type**|**Documentation** | ||
| 440 | |CustomTypeScheme|CustomTypeSchemeType|CustomTypeScheme provides the details of a custom type scheme, in which user defined operators are described. | ||
| 441 | |||
| 442 | **VtlMappingsType: **VtlMappingsType 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. | ||
| 443 | |||
| 444 | Content: | ||
| 445 | VtlMappingScheme+ | ||
| 446 | |||
| 447 | Element Documentation: | ||
| 448 | |||
| 449 | |**Name**|**Type**|**Documentation** | ||
| 450 | |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. | ||
| 451 | |||
| 452 | **NamePersonalisationsType: **NamePersonalisationsType 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. | ||
| 453 | |||
| 454 | Content: | ||
| 455 | NamePersonalisationScheme+ | ||
| 456 | |||
| 457 | Element Documentation: | ||
| 458 | |||
| 459 | |**Name**|**Type**|**Documentation** | ||
| 460 | |NamePersonalisationS cheme|NamePersonalisationSchemeType|NamePersonalisationScheme provides the details of a name personalisation scheme, in which name personalisations are described. | ||
| 461 | |||
| 462 | **RulesetsType: **RulesetsType 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. | ||
| 463 | |||
| 464 | Content: | ||
| 465 | RulesetScheme+ | ||
| 466 | |||
| 467 | Element Documentation: | ||
| 468 | |||
| 469 | |**Name**|**Type**|**Documentation** | ||
| 470 | |RulesetScheme|RulesetSchemeType|RulesetScheme provides the details of a ruleset scheme, in which rulesets are described. | ||
| 471 | |||
| 472 | **TransformationsType: **TransformationsType 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. | ||
| 473 | |||
| 474 | Content: | ||
| 475 | TransformationScheme+ | ||
| 476 | |||
| 477 | Element Documentation | ||
| 478 | |||
| 479 | |**Name**|**Type**|**Documentation** | ||
| 480 | |TransformationScheme|TransformationSchemeType|TransformationScheme provides the details of a transformation scheme, in which transformations are described. | ||
| 481 | |||
| 482 | **UserDefinedOperatorsType: **UserDefinedOperatorsType 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. | ||
| 483 | |||
| 484 | Content: | ||
| 485 | UserDefinedOperatorScheme+ | ||
| 486 | |||
| 487 | Element Documentation: | ||
| 488 | |||
| 489 | |**Name**|**Type**|**Documentation** | ||
| 490 | |UserDefinedOperatorS cheme|UserDefinedOperatorS chemeType|UserDefinedOperatorScheme provides the details of a user defined operator scheme, in which user defined operators are described. | ||
| 491 | |||
| 492 | //**IdentifiableType**//**: **IdentifiableType is an abstract base type for all identifiable objects. | ||
| 493 | |||
| 494 | Derivation: | ||
| 495 | |||
| 496 | * //com:AnnotableType// (extension) | ||
| 497 | ** //dentifiableType// | ||
| 498 | |||
| 499 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 500 | id?, urn?, uri? | ||
| 501 | |||
| 502 | Conten: | ||
| 503 | com:Annotations? | ||
| 504 | |||
| 505 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 506 | |||
| 507 | |**Name**|**Type**|**Documentation** | ||
| 508 | |d|com:IDType|The id is the identifier for the object. | ||
| 509 | |urn|xs:anyURI|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). | ||
| 510 | |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. | ||
| 511 | |||
| 512 | Element Documentation: | ||
| 513 | |||
| 514 | |**Name**|**Type**|**Documentation** | ||
| 515 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 516 | |||
| 517 | //**NameableType**//**: **NameableType is an abstract base type for all nameable objects. | ||
| 518 | |||
| 519 | Derivation: | ||
| 520 | |||
| 521 | * //com:AnnotableType// (extension) | ||
| 522 | ** //IdentifiableType// (extension) | ||
| 523 | *** //NameableType// | ||
| 524 | |||
| 525 | Attributes: | ||
| 526 | id?, urn?, uri? | ||
| 527 | |||
| 528 | Content: | ||
| 529 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 530 | |||
| 531 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 532 | |||
| 533 | |**Name**|**Type**|**Documentation** | ||
| 534 | |id|com:IDType|The id is the identifier for the object. | ||
| 535 | |urn|xs:anyURI|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). | ||
| 536 | |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. | ||
| 537 | |||
| 538 | Element Documentation: | ||
| 539 | |||
| 540 | |**Name**|**Type**|**Documentation** | ||
| 541 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 542 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 543 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 544 | |||
| 545 | //**VersionableType**//**: **VersionableType is an abstract base type for all versionable objects. | ||
| 546 | |||
| 547 | Derivation: | ||
| 548 | |||
| 549 | * //com:AnnotableType// (extension) | ||
| 550 | ** //IdentifiableType// (extension) | ||
| 551 | *** //NameableType// (extension) | ||
| 552 | **** //VersionableType// | ||
| 553 | |||
| 554 | Attributes: | ||
| 555 | id?, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo? | ||
| 556 | |||
| 557 | Content: | ||
| 558 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 559 | |||
| 560 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 561 | |||
| 562 | |**Name**|**Type**|**Documentation** | ||
| 563 | |id|com:IDType|The id is the identifier for the object. | ||
| 564 | |urn|xs:anyURI|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). | ||
| 565 | |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. | ||
| 566 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 567 | |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(%%). | ||
| 568 | |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(%%). | ||
| 569 | |||
| 570 | Element Documentation: | ||
| 571 | |||
| 572 | |**Name**|**Type**|**Documentation** | ||
| 573 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 574 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 575 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 576 | |||
| 577 | //**MaintainableBaseType**//**: **MaintainableBaseType is an abstract type that only serves the purpose of forming the base for the actual MaintainableType. The purpose of this type is to restrict the VersionableType to require the id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 578 | |||
| 579 | Derivation: | ||
| 580 | |||
| 581 | * //com:AnnotableType// (extension) | ||
| 582 | ** //IdentifiableType// (extension) | ||
| 583 | *** //NameableType// (extension) | ||
| 584 | **** //VersionableType// (restriction) | ||
| 585 | ***** //MaintainableBaseType// | ||
| 586 | |||
| 587 | Attributes: | ||
| 588 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo? | ||
| 589 | |||
| 590 | Content: | ||
| 591 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 592 | |||
| 593 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 594 | |||
| 595 | |**Name**|**Type**|**Documentation** | ||
| 596 | |id|com:IDType|The id is the identifier for the object. | ||
| 597 | |urn|xs:anyURI|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). | ||
| 598 | |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. | ||
| 599 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 600 | |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(%%). | ||
| 601 | |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(%%). | ||
| 602 | |||
| 603 | Element Documentation: | ||
| 604 | |||
| 605 | |**Name**|**Type**|**Documentation** | ||
| 606 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 607 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 608 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 609 | |||
| 610 | //**MaintainableType**//**: **MaintainableType is an abstract base type for all maintainable objects. | ||
| 611 | |||
| 612 | Derivation: | ||
| 613 | |||
| 614 | * //com:AnnotableType// (extension) | ||
| 615 | ** //IdentifiableType// (extension) | ||
| 616 | *** //NameableType// (extension) | ||
| 617 | **** //VersionableType// (restriction) | ||
| 618 | ***** //MaintainableBaseType// (extension) | ||
| 619 | ****** //MaintainableType// | ||
| 620 | |||
| 621 | Attributes: | ||
| 622 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 623 | |||
| 624 | Content: | ||
| 625 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 626 | |||
| 627 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 628 | |||
| 629 | |**Name**|**Type**|**Documentation** | ||
| 630 | |id|com:IDType|The id is the identifier for the object. | ||
| 631 | |urn|xs:anyURI|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). | ||
| 632 | |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. | ||
| 633 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 634 | |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(%%). | ||
| 635 | |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(%%). | ||
| 636 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 637 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 638 | |[[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. | ||
| 639 | |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. | ||
| 640 | |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. | ||
| 641 | |||
| 642 | Element Documentation: | ||
| 643 | |||
| 644 | |**Name**|**Type**|**Documentation** | ||
| 645 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 646 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 647 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 648 | |||
| 649 | //**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. | ||
| 650 | |||
| 651 | Derivation: | ||
| 652 | //com:AnnotableType// (extension) | ||
| 653 | // IdentifiableType// (extension) | ||
| 654 | // NameableType// (extension) | ||
| 655 | //VersionableType// (restriction) | ||
| 656 | //MaintainableBaseType// (extension) | ||
| 657 | //MaintainableType// (extension) | ||
| 658 | //ItemSchemeType// | ||
| 659 | |||
| 660 | Attributes: | ||
| 661 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 662 | |||
| 663 | Content: | ||
| 664 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, //Item*// | ||
| 665 | |||
| 666 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 667 | |||
| 668 | |**Name**|**Type**|**Documentation** | ||
| 669 | |id|com:IDType|The id is the identifier for the object. | ||
| 670 | |urn|xs:anyURI|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). | ||
| 671 | |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. | ||
| 672 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 673 | |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(%%). | ||
| 674 | |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(%%). | ||
| 675 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 676 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 677 | |[[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. | ||
| 678 | |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. | ||
| 679 | |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. | ||
| 680 | |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 key family in the context of a constraint. | ||
| 681 | |||
| 682 | Element Documentation: | ||
| 683 | |||
| 684 | |**Name**|**Type**|**Documentation** | ||
| 685 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 686 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 687 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 688 | |//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. | ||
| 689 | |||
| 690 | //**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. | ||
| 691 | |||
| 692 | Derivation: | ||
| 693 | //com:AnnotableType// (extension) | ||
| 694 | //IdentifiableType// (extension) | ||
| 695 | //NameableType// (restriction) | ||
| 696 | //ItemBaseType// | ||
| 697 | |||
| 698 | Attributes: | ||
| 699 | id, urn?, uri? | ||
| 700 | |||
| 701 | Content: | ||
| 702 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 703 | |||
| 704 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 705 | |||
| 706 | |**Name**|**Type**|**Documentation** | ||
| 707 | |id|com:IDType|The id is the identifier for the object. | ||
| 708 | |urn|xs:anyURI|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). | ||
| 709 | |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. | ||
| 710 | |||
| 711 | Element Documentation: | ||
| 712 | |||
| 713 | |**Name**|**Type**|**Documentation** | ||
| 714 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 715 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 716 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 717 | |||
| 718 | //**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. | ||
| 719 | |||
| 720 | Derivation: | ||
| 721 | //com:AnnotableType// (extension) | ||
| 722 | //IdentifiableType// (extension) | ||
| 723 | //NameableType// (restriction) | ||
| 724 | //ItemBaseType// (extension) | ||
| 725 | //ItemType// | ||
| 726 | |||
| 727 | Attributes: | ||
| 728 | id, urn?, uri? | ||
| 729 | |||
| 730 | Content: | ||
| 731 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, (Parent | //Item+//)? | ||
| 732 | |||
| 733 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 734 | |||
| 735 | |**Name**|**Type**|**Documentation** | ||
| 736 | |id|com:IDType|The id is the identifier for the object. | ||
| 737 | |urn|xs:anyURI|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). | ||
| 738 | |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. | ||
| 739 | |||
| 740 | Element Documentation: | ||
| 741 | |||
| 742 | |**Name**|**Type**|**Documentation** | ||
| 743 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 744 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 745 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 746 | |Parent|//com: LocalItemReferenceType//| | ||
| 747 | |//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. | ||
| 748 | |||
| 749 | //**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 nexted items. | ||
| 750 | |||
| 751 | Derivation: | ||
| 752 | //com:AnnotableType// (extension) | ||
| 753 | //IdentifiableType// (extension) | ||
| 754 | //NmeableType// (restriction) | ||
| 755 | //ItemBaseType// (extension) | ||
| 756 | //ItemType// (restriction) | ||
| 757 | //UnnestedItemType// | ||
| 758 | |||
| 759 | Attributes: | ||
| 760 | id, urn?, uri? | ||
| 761 | |||
| 762 | Content: | ||
| 763 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 764 | |||
| 765 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 766 | |||
| 767 | |**Name**|**Type**|**Documentation** | ||
| 768 | |id|com:IDType|The id is the identifier for the object. | ||
| 769 | |urn|xs:anyURI|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). | ||
| 770 | |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. | ||
| 771 | |||
| 772 | Element Documentation: | ||
| 773 | |||
| 774 | |**Name**|**Type**|**Documentation** | ||
| 775 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 776 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 777 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 778 | |||
| 779 | //**StructureType**//**: **StructureType is an abstract base type for all structure objects. Concrete instances of this should restrict to a concrete grouping. | ||
| 780 | |||
| 781 | Derivation: | ||
| 782 | //com:AnnotableType// (extension) | ||
| 783 | //IdentifiableType// (extension) | ||
| 784 | //NameableType// (extension) | ||
| 785 | //VersionableType// (restriction) | ||
| 786 | //MaintainableBaseType// (extension) | ||
| 787 | //MaintainableType// (extension) | ||
| 788 | //StructureType// | ||
| 789 | |||
| 790 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 791 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 792 | |||
| 793 | Content: | ||
| 794 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, //Grouping?// | ||
| 795 | |||
| 796 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 797 | |||
| 798 | |**Name**|**Type**|**Documentation** | ||
| 799 | |id|com:IDType|The id is the identifier for the object. | ||
| 800 | |urn|xs:anyURI|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). | ||
| 801 | |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. | ||
| 802 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 803 | |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(%%). | ||
| 804 | |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(%%). | ||
| 805 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 806 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 807 | |[[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. | ||
| 808 | |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. | ||
| 809 | |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. | ||
| 810 | |||
| 811 | Element Documentation: | ||
| 812 | |||
| 813 | |**Name**|**Type**|**Documentation** | ||
| 814 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 815 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 816 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 817 | |//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. | ||
| 818 | |||
| 819 | //**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. | ||
| 820 | |||
| 821 | Content: | ||
| 822 | //ComponentList*// | ||
| 823 | |||
| 824 | Element Documentation: | ||
| 825 | |||
| 826 | |**Name**|**Type**|**Documentation** | ||
| 827 | |//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. | ||
| 828 | |||
| 829 | //**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]]. | ||
| 830 | |||
| 831 | Derivation: | ||
| 832 | //com:AnnotableType// (extension) | ||
| 833 | //IdentifiableType// (extension) | ||
| 834 | //ComponentListType// | ||
| 835 | |||
| 836 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 837 | id?, urn?, uri? | ||
| 838 | |||
| 839 | Content: | ||
| 840 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, //[[Component>>doc:sdmx:Glossary.Component.WebHome]]*// | ||
| 841 | |||
| 842 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 843 | |||
| 844 | |**Name**|**Type**|**Documentation** | ||
| 845 | |id|com:IDType|The id is the identifier for the object. | ||
| 846 | |urn|xs:anyURI|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). | ||
| 847 | |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. | ||
| 848 | |||
| 849 | Element Documentation: | ||
| 850 | |||
| 851 | |**Name**|**Type**|**Documentation** | ||
| 852 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 853 | |//[[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. | ||
| 854 | |||
| 855 | //**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. | ||
| 856 | |||
| 857 | Derivation: | ||
| 858 | //com:AnnotableType// (extension) | ||
| 859 | //IdentifiableType// (restriction) | ||
| 860 | //ComponentBaseType// | ||
| 861 | |||
| 862 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 863 | id?, urn?, uri? | ||
| 864 | |||
| 865 | Content: | ||
| 866 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]? | ||
| 867 | |||
| 868 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 869 | |||
| 870 | |**Name**|**Type**|**Documentation** | ||
| 871 | |id|com: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). | ||
| 872 | |urn|xs:anyURI|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). | ||
| 873 | |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. | ||
| 874 | |||
| 875 | Element Documentation: | ||
| 876 | |||
| 877 | |**Name**|**Type**|**Documentation** | ||
| 878 | |com:Annotations|com: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. | ||
| 879 | |||
| 880 | //**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]]. | ||
| 881 | |||
| 882 | Derivation: | ||
| 883 | //com:AnnotableType// (extension) | ||
| 884 | //IdentifiableType// (restriction) | ||
| 885 | //ComponentBaseType// (extension) | ||
| 886 | //ComponentType// | ||
| 887 | |||
| 888 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 889 | id?, urn?, uri? | ||
| 890 | |||
| 891 | Content: | ||
| 892 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity?, LocalRepresentation? | ||
| 893 | |||
| 894 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 895 | |||
| 896 | |**Name**|**Type**|**Documentation** | ||
| 897 | |id|com: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). | ||
| 898 | |urn|xs:anyURI|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). | ||
| 899 | |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. | ||
| 900 | |||
| 901 | Element Documentation: | ||
| 902 | |||
| 903 | |**Name**|**Type**|**Documentation** | ||
| 904 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 905 | |ConceptIdentity|com: 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]]. | ||
| 906 | |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. | ||
| 907 | |||
| 908 | //**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. | ||
| 909 | |||
| 910 | Derivation: | ||
| 911 | //com:AnnotableType// (extension) | ||
| 912 | //IdentifiableType// (extension) | ||
| 913 | //NameableType// (extension) | ||
| 914 | //VersionableType// (restriction) | ||
| 915 | //MaintainableBaseType// (extension) | ||
| 916 | //MaintainableType// (extension) | ||
| 917 | //StructureUsageType// | ||
| 918 | |||
| 919 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 920 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 921 | |||
| 922 | Content: | ||
| 923 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Structure? | ||
| 924 | |||
| 925 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 926 | |||
| 927 | |**Name**|**Type**|**Documentation** | ||
| 928 | |id|com:IDType|The id is the identifier for the object. | ||
| 929 | |urn|xs:anyURI|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). | ||
| 930 | |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. | ||
| 931 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 932 | |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(%%). | ||
| 933 | |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(%%). | ||
| 934 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 935 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 936 | |[[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. | ||
| 937 | |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. | ||
| 938 | |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. | ||
| 939 | |||
| 940 | Element Documentation: | ||
| 941 | |||
| 942 | |**Name**|**Type**|**Documentation** | ||
| 943 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 944 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 945 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 946 | |Structure|//com: StructureReferenceBa seType//|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). | ||
| 947 | |||
| 948 | //**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. | ||
| 949 | |||
| 950 | Content: | ||
| 951 | (TextFormat | (Enumeration, EnumerationFormat?)) | ||
| 952 | |||
| 953 | Element Documentation: | ||
| 954 | |||
| 955 | |**Name**|**Type**|**Documentation** | ||
| 956 | |TextFormat|TextFormatType|TextFormat describes an uncoded textual format. | ||
| 957 | |Enumeration|//com: ItemSchemeReferenceB aseType//|Enumeration references an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that enumerates the allowable values for this [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 958 | |EnumerationFormat|CodededTextFormatTyp e|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. | ||
| 959 | |||
| 960 | **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]]". | ||
| 961 | |||
| 962 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 963 | textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, [[decimals>>doc:sdmx:Glossary.Decimals.WebHome]]?, pattern?, isMultiLingual? | ||
| 964 | |||
| 965 | Content: | ||
| 966 | {Empty} | ||
| 967 | |||
| 968 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 969 | |||
| 970 | |**Name**|**Type**|**Documentation** | ||
| 971 | |textType (default: String)|com: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]]. | ||
| 972 | |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. | ||
| 973 | |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. | ||
| 974 | |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. | ||
| 975 | |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. | ||
| 976 | |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. | ||
| 977 | |startTime|com: StandardTimePeriodTy pe|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. | ||
| 978 | |endTime|com: StandardTimePeriodTy pe|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. | ||
| 979 | |minLength|xs:positiveInteger|The minLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the minimum and length of the value in characters. | ||
| 980 | |maxLength|xs:positiveInteger|The maxLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the maximum length of the value in characters. | ||
| 981 | |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. | ||
| 982 | |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. | ||
| 983 | |[[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. | ||
| 984 | |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. | ||
| 985 | |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. | ||
| 986 | |||
| 987 | **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. | ||
| 988 | |||
| 989 | Derivation: | ||
| 990 | TextFormatType (restriction) | ||
| 991 | BasicComponentTextFormatType | ||
| 992 | |||
| 993 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 994 | textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, [[decimals>>doc:sdmx:Glossary.Decimals.WebHome]]?, pattern?, isMultiLingual? | ||
| 995 | |||
| 996 | Content: | ||
| 997 | {Empty} | ||
| 998 | |||
| 999 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1000 | |||
| 1001 | |**Name**|**Type**|**Documentation** | ||
| 1002 | |textType (default: String)|com: 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]]. | ||
| 1003 | |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. | ||
| 1004 | |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. | ||
| 1005 | |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. | ||
| 1006 | |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. | ||
| 1007 | |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. | ||
| 1008 | |startTime|com: 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. | ||
| 1009 | |endTime|com: 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. | ||
| 1010 | |minLength|xs:positiveInteger|The minLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the minimum and length of the value in characters. | ||
| 1011 | |maxLength|xs:positiveInteger|The maxLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the maximum length of the value in characters. | ||
| 1012 | |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. | ||
| 1013 | |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. | ||
| 1014 | |[[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. | ||
| 1015 | |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. | ||
| 1016 | |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. | ||
| 1017 | |||
| 1018 | **SimpleComponentTextFormatType: **SimpleComponentTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the BasicComponentTextFormatType that does not allow for multi-lingual values. | ||
| 1019 | |||
| 1020 | Derivation: | ||
| 1021 | TextFormatType (restriction) | ||
| 1022 | BasicComponentTextFormatType (restriction) | ||
| 1023 | SimpleComponentTextFormatType | ||
| 1024 | |||
| 1025 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1026 | textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, [[decimals>>doc:sdmx:Glossary.Decimals.WebHome]]?, pattern? | ||
| 1027 | |||
| 1028 | Content: | ||
| 1029 | {Empty} | ||
| 1030 | |||
| 1031 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1032 | |||
| 1033 | |**Name**|**Type**|**Documentation** | ||
| 1034 | |textType (default: String)|com: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]]. | ||
| 1035 | |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. | ||
| 1036 | |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. | ||
| 1037 | |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. | ||
| 1038 | |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. | ||
| 1039 | |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. | ||
| 1040 | |startTime|com: StandardTimePeriodTy pe|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. | ||
| 1041 | |endTime|com: StandardTimePeriodTy pe|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. | ||
| 1042 | |minLength|xs:positiveInteger|The minLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the minimum and length of the value in characters. | ||
| 1043 | |maxLength|xs:positiveInteger|The maxLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the maximum length of the value in characters. | ||
| 1044 | |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. | ||
| 1045 | |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. | ||
| 1046 | |[[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. | ||
| 1047 | |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. | ||
| 1048 | |||
| 1049 | **CodededTextFormatType: **CodededTextFormatType 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. | ||
| 1050 | |||
| 1051 | Derivation: | ||
| 1052 | TextFormatType (restriction) | ||
| 1053 | BasicComponentTextFormatType (restriction) | ||
| 1054 | SimpleComponentTextFormatType (restriction) | ||
| 1055 | CodededTextFormatType | ||
| 1056 | |||
| 1057 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1058 | textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, pattern? | ||
| 1059 | |||
| 1060 | Content: | ||
| 1061 | {Empty} | ||
| 1062 | |||
| 1063 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1064 | |||
| 1065 | |**Name**|**Type**|**Documentation** | ||
| 1066 | |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]]. | ||
| 1067 | |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. | ||
| 1068 | |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. | ||
| 1069 | |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. | ||
| 1070 | |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. | ||
| 1071 | |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. | ||
| 1072 | |startTime|com: StandardTimePeriodTy pe|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. | ||
| 1073 | |endTime|com: StandardTimePeriodTy pe|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. | ||
| 1074 | |minLength|xs:positiveInteger|The minLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the minimum and length of the value in characters. | ||
| 1075 | |maxLength|xs:positiveInteger|The maxLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the maximum length of the value in characters. | ||
| 1076 | |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. | ||
| 1077 | |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. | ||
| 1078 | |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. | ||
| 1079 | |||
| 1080 | **NonFacetedTextFormatType: **NonFacetedTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the SimpleComponentTextFormatType that does not allow for any [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. | ||
| 1081 | |||
| 1082 | Derivation: | ||
| 1083 | TextFormatType (restriction) | ||
| 1084 | BasicComponentTextFormatType (restriction) | ||
| 1085 | SimpleComponentTextFormatType (restriction) | ||
| 1086 | NonFacetedTextFormatType | ||
| 1087 | |||
| 1088 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1089 | textType? | ||
| 1090 | |||
| 1091 | Content: | ||
| 1092 | {Empty} | ||
| 1093 | |||
| 1094 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1095 | |||
| 1096 | |**Name**|**Type**|**Documentation** | ||
| 1097 | |textType|com: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]]. | ||
| 1098 | |||
| 1099 | **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. | ||
| 1100 | |||
| 1101 | Derivation: | ||
| 1102 | TextFormatType (restriction) | ||
| 1103 | BasicComponentTextFormatType (restriction) | ||
| 1104 | SimpleComponentTextFormatType (restriction) | ||
| 1105 | TimeTextFormatType | ||
| 1106 | |||
| 1107 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1108 | textType?, startTime?, endTime? | ||
| 1109 | |||
| 1110 | Content: | ||
| 1111 | {Empty} | ||
| 1112 | |||
| 1113 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1114 | |||
| 1115 | |**Name**|**Type**|**Documentation** | ||
| 1116 | |textType (default: ObservationalTimePeriod)|com: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]]. | ||
| 1117 | |startTime|com: StandardTimePeriodTy pe|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. | ||
| 1118 | |endTime|com: StandardTimePeriodTy pe|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. | ||
| 1119 | |||
| 1120 | **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]]. | ||
| 1121 | |||
| 1122 | Derivation: | ||
| 1123 | //com:AnnotableType// (extension) | ||
| 1124 | //IdentifiableType// (extension) | ||
| 1125 | //NameableType// (extension) | ||
| 1126 | //VersionableType// (restriction) | ||
| 1127 | //MaintainableBaseType// (extension) | ||
| 1128 | //MaintainableType// (extension) | ||
| 1129 | CategorisationType | ||
| 1130 | |||
| 1131 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1132 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 1133 | |||
| 1134 | Content: | ||
| 1135 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, (Source, Target)? | ||
| 1136 | |||
| 1137 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1138 | |||
| 1139 | |**Name**|**Type**|**Documentation** | ||
| 1140 | |id|com:IDType|The id is the identifier for the object. | ||
| 1141 | |urn|xs:anyURI|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). | ||
| 1142 | |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. | ||
| 1143 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 1144 | |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(%%). | ||
| 1145 | |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(%%). | ||
| 1146 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1147 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 1148 | |[[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. | ||
| 1149 | |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. | ||
| 1150 | |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. | ||
| 1151 | |||
| 1152 | Element Documentation: | ||
| 1153 | |||
| 1154 | |**Name**|**Type**|**Documentation** | ||
| 1155 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1156 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1157 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1158 | |Source|com: ObjectReferenceType|Source is a reference to an object to be categorized. | ||
| 1159 | |Target|com: CategoryReferenceType|Target is reference to the [[category>>doc:sdmx:Glossary.Category.WebHome]] that the referenced object is to be (% style="color:#e74c3c" %)mapped(%%) to. | ||
| 1160 | |||
| 1161 | **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]]. | ||
| 1162 | |||
| 1163 | Derivation: | ||
| 1164 | //com:AnnotableType// (extension) | ||
| 1165 | //IdentifiableType// (extension) | ||
| 1166 | //NameableType// (extension) | ||
| 1167 | //VersionableType// (restriction) | ||
| 1168 | //MaintainableBaseType// (extension) | ||
| 1169 | //MaintainableType// (extension) | ||
| 1170 | //ItemSchemeType// (restriction) | ||
| 1171 | CategorySchemeType | ||
| 1172 | |||
| 1173 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1174 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 1175 | |||
| 1176 | Content: | ||
| 1177 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, [[Category>>doc:sdmx:Glossary.Category.WebHome]]* | ||
| 1178 | |||
| 1179 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1180 | |||
| 1181 | |**Name**|**Type**|**Documentation** | ||
| 1182 | |id|com: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). | ||
| 1183 | |urn|xs:anyURI|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). | ||
| 1184 | |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. | ||
| 1185 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 1186 | |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(%%). | ||
| 1187 | |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(%%). | ||
| 1188 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1189 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 1190 | |[[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. | ||
| 1191 | |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. | ||
| 1192 | |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. | ||
| 1193 | |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 key family in the context of a constraint. | ||
| 1194 | |||
| 1195 | Element Documentation: | ||
| 1196 | |||
| 1197 | |**Name**|**Type**|**Documentation** | ||
| 1198 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1199 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1200 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1201 | |[[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. | ||
| 1202 | |||
| 1203 | **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:#e74c3c" %)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]]. | ||
| 1204 | |||
| 1205 | Derivation: | ||
| 1206 | //com:AnnotableType// (extension) | ||
| 1207 | //IdentifiableType// (extension) | ||
| 1208 | //NameableType// (restriction) | ||
| 1209 | //ItemBaseType// (extension) | ||
| 1210 | //ItemType// (restriction) | ||
| 1211 | CategoryType | ||
| 1212 | |||
| 1213 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1214 | ёёid, urn?, uri? | ||
| 1215 | |||
| 1216 | Content: | ||
| 1217 | |||
| 1218 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, [[Category>>doc:sdmx:Glossary.Category.WebHome]]* | ||
| 1219 | |||
| 1220 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1221 | |||
| 1222 | |**Name**|**Type**|**Documentation** | ||
| 1223 | |id|com:IDType|The id is the identifier for the object. | ||
| 1224 | |urn|xs:anyURI|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). | ||
| 1225 | |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. | ||
| 1226 | |||
| 1227 | Element Documentation: | ||
| 1228 | |||
| 1229 | |**Name**|**Type**|**Documentation** | ||
| 1230 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1231 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1232 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1233 | |[[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. | ||
| 1234 | |||
| 1235 | **CodelistType: **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. | ||
| 1236 | |||
| 1237 | Derivation: | ||
| 1238 | |||
| 1239 | //com:AnnotableType// (extension) | ||
| 1240 | //IdentifiableType// (extension) | ||
| 1241 | //NameableType// (extension) | ||
| 1242 | //VersionableType// (restriction) | ||
| 1243 | //MaintainableBaseType// (extension) | ||
| 1244 | //MaintainableType// (extension) | ||
| 1245 | //ItemSchemeType// (restriction) | ||
| 1246 | CodelistType | ||
| 1247 | |||
| 1248 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1249 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 1250 | |||
| 1251 | Content: | ||
| 1252 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, [[Code>>doc:sdmx:Glossary.Code.WebHome]]* | ||
| 1253 | |||
| 1254 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1255 | |||
| 1256 | |**Name**|**Type**|**Documentation** | ||
| 1257 | |id|com: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). | ||
| 1258 | |urn|xs:anyURI|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). | ||
| 1259 | |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. | ||
| 1260 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 1261 | |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(%%). | ||
| 1262 | |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(%%). | ||
| 1263 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1264 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 1265 | |[[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. | ||
| 1266 | |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. | ||
| 1267 | |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. | ||
| 1268 | |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 key family in the context of a constraint. | ||
| 1269 | |||
| 1270 | Element Documentation: | ||
| 1271 | |||
| 1272 | |**Name**|**Type**|**Documentation** | ||
| 1273 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1274 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1275 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1276 | |[[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]]. | ||
| 1277 | |||
| 1278 | **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]]. | ||
| 1279 | |||
| 1280 | Derivation: | ||
| 1281 | //com:AnnotableType// (extension) | ||
| 1282 | //IdentifiableType// (extension) | ||
| 1283 | //NameableType// (restriction) | ||
| 1284 | //ItemBaseType// (extension) | ||
| 1285 | //ItemType// (restriction) | ||
| 1286 | CodeType | ||
| 1287 | |||
| 1288 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1289 | id, urn?, uri? | ||
| 1290 | |||
| 1291 | Content: | ||
| 1292 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Parent? | ||
| 1293 | |||
| 1294 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1295 | |||
| 1296 | |**Name**|**Type**|**Documentation** | ||
| 1297 | |id|com:IDType|The id is the identifier for the object. | ||
| 1298 | |urn|xs:anyURI|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). | ||
| 1299 | |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. | ||
| 1300 | |||
| 1301 | Element Documentation: | ||
| 1302 | |||
| 1303 | |**Name**|**Type**|**Documentation** | ||
| 1304 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1305 | |com:Name|com: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. | ||
| 1306 | |com:Description|com: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. | ||
| 1307 | |Parent|com: LocalCodeReferenceTy pe|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]]. | ||
| 1308 | |||
| 1309 | **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>>doc:sdmx:Glossary.Hierarchy.WebHome]]. | ||
| 1310 | |||
| 1311 | Derivation: | ||
| 1312 | //com:AnnotableType// (extension) | ||
| 1313 | //IdentifiableType// (extension) | ||
| 1314 | //NameableType// (extension) | ||
| 1315 | //VersionableType// (restriction) | ||
| 1316 | //MaintainableBaseType// (extension) | ||
| 1317 | //MaintainableType// (extension) | ||
| 1318 | //ItemSchemeType// (restriction) | ||
| 1319 | ConceptSchemeType | ||
| 1320 | |||
| 1321 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1322 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 1323 | |||
| 1324 | Content: | ||
| 1325 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, (% style="color:#e74c3c" %)Concept(%%)* | ||
| 1326 | |||
| 1327 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1328 | |||
| 1329 | |**Name**|**Type**|**Documentation** | ||
| 1330 | |id|com: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). | ||
| 1331 | |urn|xs:anyURI|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). | ||
| 1332 | |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. | ||
| 1333 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 1334 | |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(%%). | ||
| 1335 | |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(%%). | ||
| 1336 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1337 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 1338 | |[[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. | ||
| 1339 | |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. | ||
| 1340 | |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. | ||
| 1341 | |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 key family in the context of a constraint. | ||
| 1342 | |||
| 1343 | Element Documentation: | ||
| 1344 | |||
| 1345 | |**Name**|**Type**|**Documentation** | ||
| 1346 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1347 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1348 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1349 | |(%%)(% 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]]. | ||
| 1350 | |||
| 1351 | //**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. | ||
| 1352 | |||
| 1353 | Derivation: | ||
| 1354 | //com:AnnotableType// (extension) | ||
| 1355 | //IdentifiableType// (extension) | ||
| 1356 | //NameableType// (restriction) | ||
| 1357 | //ItemBaseType// (extension) | ||
| 1358 | //ItemType// (restriction) | ||
| 1359 | //ConceptBaseType// | ||
| 1360 | |||
| 1361 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1362 | id, urn?, uri? | ||
| 1363 | |||
| 1364 | Content: | ||
| 1365 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Parent? | ||
| 1366 | |||
| 1367 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1368 | |||
| 1369 | |**Name**|**Type**|**Documentation** | ||
| 1370 | |id|com: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). | ||
| 1371 | |urn|xs:anyURI|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). | ||
| 1372 | |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. | ||
| 1373 | |||
| 1374 | Element Documentation: | ||
| 1375 | |||
| 1376 | |**Name**|**Type**|**Documentation** | ||
| 1377 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1378 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1379 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1380 | |Parent|com: LocalConceptReferenc eType|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. | ||
| 1381 | |||
| 1382 | **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). | ||
| 1383 | |||
| 1384 | Derivation: | ||
| 1385 | //com:AnnotableType// (extension) | ||
| 1386 | //IdentifiableType// (extension) | ||
| 1387 | //NameableType// (restriction) | ||
| 1388 | //ItemBaseType// (extension) | ||
| 1389 | //ItemType// (restriction) | ||
| 1390 | //ConceptBaseType// (extension) | ||
| 1391 | ConceptType | ||
| 1392 | |||
| 1393 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1394 | id, urn?, uri? | ||
| 1395 | |||
| 1396 | Content: | ||
| 1397 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Parent?, CoreRepresentation?, ISOConceptReference? | ||
| 1398 | |||
| 1399 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1400 | |||
| 1401 | |**Name**|**Type**|**Documentation** | ||
| 1402 | |id|com: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). | ||
| 1403 | |urn|xs:anyURI|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). | ||
| 1404 | |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. | ||
| 1405 | |||
| 1406 | Element Documentation: | ||
| 1407 | |||
| 1408 | |**Name**|**Type**|**Documentation** | ||
| 1409 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1410 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1411 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1412 | |Parent|com: LocalConceptReferenc eType|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. | ||
| 1413 | |CoreRepresentation|ConceptRepresentatio n| | ||
| 1414 | |ISOConceptReference|ISOConceptReferenceT ype|Provides a reference to an ISO 11179 (% style="color:#e74c3c" %)concept(%%). | ||
| 1415 | |||
| 1416 | **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. | ||
| 1417 | |||
| 1418 | Derivation: | ||
| 1419 | |||
| 1420 | //RepresentationType// (restriction) | ||
| 1421 | ConceptRepresentation | ||
| 1422 | |||
| 1423 | Content: | ||
| 1424 | (TextFormat | (Enumeration, EnumerationFormat?)) | ||
| 1425 | |||
| 1426 | Element Documentation: | ||
| 1427 | |||
| 1428 | |**Name**|**Type**|**Documentation** | ||
| 1429 | |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format. | ||
| 1430 | |Enumeration|com: CodelistReferenceTyp e|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(%%). | ||
| 1431 | |EnumerationFormat|CodededTextFormatTyp e|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. | ||
| 1432 | |||
| 1433 | **ISOConceptReferenceType: **ISOConceptReferenceType provides a reference to and ISO 11179 (% style="color:#e74c3c" %)concept(%%). | ||
| 1434 | |||
| 1435 | Content: | ||
| 1436 | ConceptAgency, ConceptSchemeID, ConceptID | ||
| 1437 | |||
| 1438 | Element Documentation: | ||
| 1439 | |||
| 1440 | |**Name**|**Type**|**Documentation** | ||
| 1441 | |ConceptAgency|xs:string| | ||
| 1442 | |ConceptSchemeID|xs:string| | ||
| 1443 | |ConceptID|xs:string| | ||
| 1444 | |||
| 1445 | //**ConstraintBaseType**//**: **ConstraintBaseType is an abstract base type that forms the basis of the main abstract ConstraintType. It requires that a name be provided. | ||
| 1446 | |||
| 1447 | Derivation: | ||
| 1448 | //com:AnnotableType// (extension) | ||
| 1449 | //IdentifiableType// (extension) | ||
| 1450 | //NameableType// (extension) | ||
| 1451 | //VersionableType// (restriction) | ||
| 1452 | //MaintainableBaseType// (extension) | ||
| 1453 | //MaintainableType// (restriction) | ||
| 1454 | //ConstraintBaseType// | ||
| 1455 | |||
| 1456 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1457 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 1458 | |||
| 1459 | Content: | ||
| 1460 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 1461 | |||
| 1462 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1463 | |||
| 1464 | |**Name**|**Type**|**Documentation** | ||
| 1465 | |id|com:IDType|The id is the identifier for the object. | ||
| 1466 | |urn|xs:anyURI|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). | ||
| 1467 | |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. | ||
| 1468 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 1469 | |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(%%). | ||
| 1470 | |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(%%). | ||
| 1471 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1472 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 1473 | |[[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. | ||
| 1474 | |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. | ||
| 1475 | |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. | ||
| 1476 | |||
| 1477 | Element Documentation: | ||
| 1478 | |||
| 1479 | |**Name**|**Type**|**Documentation** | ||
| 1480 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1481 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1482 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1483 | |||
| 1484 | //**ConstraintType**//**: **ConstraintType is an abstract base type that specific types of (% style="color:#e74c3c" %)constraints(%%) (content and attachment) restrict and extend to describe their details. The inclusion of a key or region in a (% style="color:#e74c3c" %)constraint(%%) is determined by first processing the included key sets, and then removing those keys defined in the excluded key sets. If no included key sets are defined, then it is assumed the all possible keys or regions are included, and any excluded key or regions are removed from this complete set. | ||
| 1485 | |||
| 1486 | Derivation: | ||
| 1487 | //com:AnnotableType// (extension) | ||
| 1488 | //IdentifiableType// (extension) | ||
| 1489 | //NameableType// (extension) | ||
| 1490 | //VersionableType// (restriction) | ||
| 1491 | //MaintainableBaseType// (extension) | ||
| 1492 | //MaintainableType// (restriction) | ||
| 1493 | //ConstraintBaseType// (extension) | ||
| 1494 | //ConstraintType// | ||
| 1495 | |||
| 1496 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1497 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 1498 | |||
| 1499 | Content: | ||
| 1500 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)* | ||
| 1501 | |||
| 1502 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1503 | |||
| 1504 | |**Name**|**Type**|**Documentation** | ||
| 1505 | |id|com:IDType|The id is the identifier for the object. | ||
| 1506 | |urn|xs:anyURI|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). | ||
| 1507 | |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. | ||
| 1508 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 1509 | |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(%%). | ||
| 1510 | |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(%%). | ||
| 1511 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1512 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 1513 | |[[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. | ||
| 1514 | |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. | ||
| 1515 | |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. | ||
| 1516 | |||
| 1517 | Element Documentation: | ||
| 1518 | |||
| 1519 | |**Name**|**Type**|**Documentation** | ||
| 1520 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1521 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1522 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1523 | |ConstraintAttachment|//ConstraintAttachment Type//|ConstraintAttachment describes the collection of constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that the (% style="color:#e74c3c" %)constraint(%%) is attached to. | ||
| 1524 | |DataKeySet|DataKeySetType| | ||
| 1525 | |MetadataKeySet|MetadataKeySetType| | ||
| 1526 | |CubeRegion|com:CubeRegionType| | ||
| 1527 | |MetadataTargetRegion|com: MetadataTargetRegion Type| | ||
| 1528 | |||
| 1529 | **AttachmentConstraintType: **AttachmentConstraintType describes the details of an attachment (% style="color:#e74c3c" %)constraint(%%) by defining the data or [[metadata key sets>>doc:sdmx:Glossary.Metadata key set.WebHome]] or [[component>>doc:sdmx:Glossary.Component.WebHome]] regions that [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] may be attached in the (% style="color:#e74c3c" %)constraint(%%) attachment objects. | ||
| 1530 | |||
| 1531 | Derivation: | ||
| 1532 | //com:AnnotableType// (extension) | ||
| 1533 | //IdentifiableType// (extension) | ||
| 1534 | //NameableType// (extension) | ||
| 1535 | //VersionableType// (restriction) | ||
| 1536 | //MaintainableBaseType// (extension) | ||
| 1537 | //MaintainableType// (restriction) | ||
| 1538 | //ConstraintBaseType// (extension) | ||
| 1539 | //ConstraintType// (restriction) | ||
| 1540 | AttachmentConstraintType | ||
| 1541 | |||
| 1542 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1543 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 1544 | |||
| 1545 | Content: | ||
| 1546 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet)* | ||
| 1547 | |||
| 1548 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1549 | |||
| 1550 | |**Name**|**Type**|**Documentation** | ||
| 1551 | |id|com:IDType|The id is the identifier for the object. | ||
| 1552 | |urn|xs:anyURI|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). | ||
| 1553 | |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. | ||
| 1554 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 1555 | |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(%%). | ||
| 1556 | |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(%%). | ||
| 1557 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1558 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 1559 | |[[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. | ||
| 1560 | |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. | ||
| 1561 | |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. | ||
| 1562 | |||
| 1563 | Element Documentation: | ||
| 1564 | |||
| 1565 | |**Name**|**Type**|**Documentation** | ||
| 1566 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1567 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1568 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1569 | |ConstraintAttachment|AttachmentConstraint AttachmentType|ConstraintAttachment describes the collection of constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that the (% style="color:#e74c3c" %)constraint(%%) is attached to. | ||
| 1570 | |DataKeySet|DataKeySetType| | ||
| 1571 | |MetadataKeySet|MetadataKeySetType| | ||
| 1572 | |||
| 1573 | //**ContentConstraintBaseType**//**: **ContentConstraintBaseType is an abstract base type that forms the basis for the ContentConstraintType. | ||
| 1574 | |||
| 1575 | Derivation: | ||
| 1576 | //com:AnnotableType// (extension) | ||
| 1577 | //IdentifiableType// (extension) | ||
| 1578 | //NameableType// (extension) | ||
| 1579 | //VersionableType// (restriction) | ||
| 1580 | //MaintainableBaseType// (extension) | ||
| 1581 | //MaintainableType// (restriction) | ||
| 1582 | //ConstraintBaseType// (extension) | ||
| 1583 | //ConstraintType// (restriction) | ||
| 1584 | //ContentConstraintBaseType// | ||
| 1585 | |||
| 1586 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1587 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 1588 | |||
| 1589 | Content: | ||
| 1590 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)* | ||
| 1591 | |||
| 1592 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1593 | |||
| 1594 | |**Name**|**Type**|**Documentation** | ||
| 1595 | |id|com:IDType|The id is the identifier for the object. | ||
| 1596 | |urn|xs:anyURI|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). | ||
| 1597 | |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. | ||
| 1598 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 1599 | |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(%%). | ||
| 1600 | |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(%%). | ||
| 1601 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1602 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 1603 | |[[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. | ||
| 1604 | |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. | ||
| 1605 | |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. | ||
| 1606 | |||
| 1607 | Element Documentation: | ||
| 1608 | |||
| 1609 | |**Name**|**Type**|**Documentation** | ||
| 1610 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1611 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1612 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1613 | |ConstraintAttachment|ContentConstraintAtt achmentType|ConstraintAttachment describes the collection of constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that the (% style="color:#e74c3c" %)constraint(%%) is attached to. | ||
| 1614 | |DataKeySet|DataKeySetType|DataKeySet defines a collection of full or partial data keys. | ||
| 1615 | |MetadataKeySet|MetadataKeySetType|MetadataKeySet defines a collection of metadata keys. | ||
| 1616 | |CubeRegion|com:CubeRegionType|CubeRegion describes a set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which define a region and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which relate to the region for the purpose of describing a (% style="color:#e74c3c" %)constraint(%%). | ||
| 1617 | |MetadataTargetRegion|com: MetadataTargetRegion Type|MetadataTargetRegion describes a set of target object values for a given report structure which define a region, and the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which relate to the target for the purpose of describing a (% style="color:#e74c3c" %)constraint(%%). | ||
| 1618 | |||
| 1619 | **ContentConstraintType: **ContentConstraintType describes the details of a content (% style="color:#e74c3c" %)constraint(%%) by defining the content regions, key sets, or release information for the (% style="color:#e74c3c" %)constraint(%%) attachment objects. Note that if the (% style="color:#e74c3c" %)constraint(%%) is for a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]], then only [[release calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]] information is relevant, as there is no reliable way of determining which key family is being used to frame (% style="color:#e74c3c" %)constraints(%%) in terms of cube regions or key sets. | ||
| 1620 | |||
| 1621 | Derivation: | ||
| 1622 | //com:AnnotableType// (extension) | ||
| 1623 | //IdentifiableType// (extension) | ||
| 1624 | //NameableType// (extension) | ||
| 1625 | //VersionableType// (restriction) | ||
| 1626 | //MaintainableBaseType// (extension) | ||
| 1627 | //MaintainableType// (restriction) | ||
| 1628 | //ConstraintBaseType// (extension) | ||
| 1629 | //ConstraintType// (restriction) | ||
| 1630 | //ContentConstraintBaseType// (extension) | ||
| 1631 | ContentConstraintType | ||
| 1632 | |||
| 1633 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1634 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, type? | ||
| 1635 | |||
| 1636 | Content: | ||
| 1637 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*, ReleaseCalendar?, ReferencePeriod? | ||
| 1638 | |||
| 1639 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1640 | |||
| 1641 | |**Name**|**Type**|**Documentation** | ||
| 1642 | |id|com:IDType|The id is the identifier for the object. | ||
| 1643 | |urn|xs:anyURI|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). | ||
| 1644 | |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. | ||
| 1645 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 1646 | |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(%%). | ||
| 1647 | |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(%%). | ||
| 1648 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1649 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 1650 | |[[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. | ||
| 1651 | |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. | ||
| 1652 | |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. | ||
| 1653 | |type (default: Actual)|com: ContentConstraintTyp eCodeType|The type [[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. The default value is "Actual", meaning the data actually present for the (% style="color:#e74c3c" %)constraint(%%) attachment. | ||
| 1654 | |||
| 1655 | Element Documentation: | ||
| 1656 | |||
| 1657 | |**Name**|**Type**|**Documentation** | ||
| 1658 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1659 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1660 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1661 | |ConstraintAttachment|ContentConstraintAtt achmentType|ConstraintAttachment describes the collection of constrainable [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that the (% style="color:#e74c3c" %)constraint(%%) is attached to. | ||
| 1662 | |DataKeySet|DataKeySetType|DataKeySet defines a collection of full or partial data keys. | ||
| 1663 | |MetadataKeySet|MetadataKeySetType|MetadataKeySet defines a collection of metadata keys. | ||
| 1664 | |CubeRegion|com:CubeRegionType|CubeRegion describes a set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which define a region and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which relate to the region for the purpose of describing a (% style="color:#e74c3c" %)constraint(%%). | ||
| 1665 | |MetadataTargetRegion|com: MetadataTargetRegion Type|MetadataTargetRegion describes a set of target object values for a given report structure which define a region, and the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which relate to the target for the purpose of describing a (% style="color:#e74c3c" %)constraint(%%). | ||
| 1666 | |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available. | ||
| 1667 | |ReferencePeriod|com: ReferencePeriodType|ReferencePeriod is used to report start date and end date (% style="color:#e74c3c" %)constraints(%%). | ||
| 1668 | |||
| 1669 | **ReleaseCalendarType: **ReleaseCalendarType describes information about the timing of releases of the constrained data. All of these values use the standard "P7D" - style format. | ||
| 1670 | |||
| 1671 | Content: | ||
| 1672 | Periodicity, Offset, Tolerance | ||
| 1673 | |||
| 1674 | Element Documentation: | ||
| 1675 | |||
| 1676 | |**Name**|**Type**|**Documentation** | ||
| 1677 | |Periodicity|xs:string|Periodicity is the period between releases of the data set. | ||
| 1678 | |Offset|xs:string|Offset is the interval between January first and the first release of data within the year. | ||
| 1679 | |Tolerance|xs:string|Tolerance is the period after which the release of data may be deemed late. | ||
| 1680 | |||
| 1681 | //**KeySetType**//**: **KeySetType is an abstract base type for defining a collection of keys. | ||
| 1682 | |||
| 1683 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1684 | isIncluded | ||
| 1685 | |||
| 1686 | Content: | ||
| 1687 | Key+ | ||
| 1688 | |||
| 1689 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1690 | |||
| 1691 | |**Name**|**Type**|**Documentation** | ||
| 1692 | |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(%%). | ||
| 1693 | |||
| 1694 | Element Documentation: | ||
| 1695 | |||
| 1696 | |**Name**|**Type**|**Documentation** | ||
| 1697 | |Key|//com:DistinctKeyType//|Key contains a data or metadata key, which are sets of [[component>>doc:sdmx:Glossary.Component.WebHome]] values which identify the data or metadata. | ||
| 1698 | |||
| 1699 | **DataKeySetType: **DataKeySetType defines a collection of full or partial data keys ([[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values). | ||
| 1700 | |||
| 1701 | Derivation: | ||
| 1702 | //KeySetType// (restriction) | ||
| 1703 | DataKeySetType | ||
| 1704 | |||
| 1705 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1706 | isIncluded | ||
| 1707 | |||
| 1708 | Content: | ||
| 1709 | Key+ | ||
| 1710 | |||
| 1711 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1712 | |||
| 1713 | |**Name**|**Type**|**Documentation** | ||
| 1714 | |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(%%). | ||
| 1715 | |||
| 1716 | Element Documentation: | ||
| 1717 | |||
| 1718 | |**Name**|**Type**|**Documentation** | ||
| 1719 | |Key|com:DataKeyType|Key contains a set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which identify a full set of data. | ||
| 1720 | |||
| 1721 | **MetadataKeySetType: **MetadataKeySetType defines a collection of metadata keys (identifier [[component>>doc:sdmx:Glossary.Component.WebHome]] values). | ||
| 1722 | |||
| 1723 | Derivation: | ||
| 1724 | //KeySetType// (restriction) | ||
| 1725 | MetadataKeySetType | ||
| 1726 | |||
| 1727 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1728 | isIncluded | ||
| 1729 | |||
| 1730 | Content: | ||
| 1731 | Key+ | ||
| 1732 | |||
| 1733 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1734 | |||
| 1735 | |**Name**|**Type**|**Documentation** | ||
| 1736 | |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(%%). | ||
| 1737 | |||
| 1738 | Element Documentation: | ||
| 1739 | |||
| 1740 | |**Name**|**Type**|**Documentation** | ||
| 1741 | |Key|com:MetadataKeyType|Key contains a set of target object values for a specified report structure which serve to identify which object [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] conforming to the specified report structure is available for. | ||
| 1742 | |||
| 1743 | //**ConstraintAttachmentType**//**: **ConstraintAttachmentType describes a collection of references to constrainable artefacts. | ||
| 1744 | |||
| 1745 | Content: | ||
| 1746 | (DataProvider | [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]+ | MetadataSet+ | SimpleDataSource+ | (DataStructure+, QueryableDataSource*) | (MetadataStructure+, QueryableDataSource*) | ([[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]+, QueryableDataSource*) | ([[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*)) | ||
| 1747 | |||
| 1748 | Element Documentation: | ||
| 1749 | |||
| 1750 | |**Name**|**Type**|**Documentation** | ||
| 1751 | |DataProvider|com: 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. | ||
| 1752 | |[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|com:SetReferenceType|[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] is reference to a [[data set>>doc:sdmx:Glossary.Data 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. | ||
| 1753 | |MetadataSet|com:SetReferenceType|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. | ||
| 1754 | |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. | ||
| 1755 | |DataStructure|com: DataStructureReferen ceType|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. | ||
| 1756 | |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. | ||
| 1757 | |MetadataStructure|com: MetadataStructureRef erenceType|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. | ||
| 1758 | |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. | ||
| 1759 | |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|com: DataflowReferenceTyp e|[[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. | ||
| 1760 | |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. | ||
| 1761 | |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|com: MetadataflowReferenc eType|[[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. | ||
| 1762 | |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. | ||
| 1763 | |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|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. | ||
| 1764 | |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. | ||
| 1765 | |||
| 1766 | **AttachmentConstraintAttachmentType: **AttachmentConstraintAttachmentType defines the structure for specifying the object to which an attachment (% style="color:#e74c3c" %)constraints(%%) applies. | ||
| 1767 | |||
| 1768 | Derivation: | ||
| 1769 | //ConstraintAttachmentType// (restriction) | ||
| 1770 | AttachmentConstraintAttachmentType | ||
| 1771 | |||
| 1772 | Content: | ||
| 1773 | ([[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]+ | MetadataSet+ | SimpleDataSource+ | DataStructure+ | MetadataStructure+ | [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]+ | [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]+ | ProvisionAgreement+) | ||
| 1774 | |||
| 1775 | Element Documentation: | ||
| 1776 | |||
| 1777 | |**Name**|**Type**|**Documentation** | ||
| 1778 | |[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|com:SetReferenceType|[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] is reference to a [[data set>>doc:sdmx:Glossary.Data 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. Multiple instance can only be used if they have the same underlying structure. | ||
| 1779 | |MetadataSet|com:SetReferenceType|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. Multiple instance can only be used if they have the same underlying structure. | ||
| 1780 | |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. Multiple instance can only be used if they have the same underlying structure. | ||
| 1781 | |DataStructure|com: DataStructureReferen ceType|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. | ||
| 1782 | |MetadataStructure|com: MetadataStructureRef erenceType|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. | ||
| 1783 | |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|com: DataflowReferenceTyp e|[[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. | ||
| 1784 | |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|com: MetadataflowReferenc eType|[[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. | ||
| 1785 | |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|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. | ||
| 1786 | |||
| 1787 | **ContentConstraintAttachmentType: **ContentConstraintAttachmentType defines the structure for specifying the target object(s) of a content (% style="color:#e74c3c" %)constraint(%%). | ||
| 1788 | |||
| 1789 | Derivation: | ||
| 1790 | //ConstraintAttachmentType// (restriction) | ||
| 1791 | ContentConstraintAttachmentType | ||
| 1792 | |||
| 1793 | Content: | ||
| 1794 | (DataProvider | [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] | MetadataSet | SimpleDataSource | (DataStructure+, QueryableDataSource*) | (MetadataStructure+, QueryableDataSource*) | ([[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]+, QueryableDataSource*) | ([[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*)) | ||
| 1795 | |||
| 1796 | Element Documentation: | ||
| 1797 | |||
| 1798 | |**Name**|**Type**|**Documentation** | ||
| 1799 | |DataProvider|com: 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. | ||
| 1800 | |[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|com:SetReferenceType|[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] is reference to a [[data set>>doc:sdmx:Glossary.Data 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. | ||
| 1801 | |MetadataSet|com:SetReferenceType|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. | ||
| 1802 | |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. | ||
| 1803 | |DataStructure|com: DataStructureReferen ceType|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. | ||
| 1804 | |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. | ||
| 1805 | |MetadataStructure|com: MetadataStructureRef erenceType|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. | ||
| 1806 | |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. | ||
| 1807 | |[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|com: DataflowReferenceTyp e|[[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. | ||
| 1808 | |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. | ||
| 1809 | |[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|com: MetadataflowReferenc eType|[[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. | ||
| 1810 | |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. | ||
| 1811 | |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|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. | ||
| 1812 | |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to which the (% style="color:#e74c3c" %)constraint(%%) is attached. | ||
| 1813 | |||
| 1814 | **DataStructureType: **DataStructureType describes the structure of 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. | ||
| 1815 | |||
| 1816 | Derivation: | ||
| 1817 | //com:AnnotableType// (extension) | ||
| 1818 | //IdentifiableType// (extension) | ||
| 1819 | //NameableType// (extension) | ||
| 1820 | //VersionableType// (restriction) | ||
| 1821 | //MaintainableBaseType// (extension) | ||
| 1822 | //MaintainableType// (extension) | ||
| 1823 | //StructureType// (restriction) | ||
| 1824 | DataStructureType | ||
| 1825 | |||
| 1826 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1827 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 1828 | |||
| 1829 | Content: | ||
| 1830 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, DataStructureComponents? | ||
| 1831 | |||
| 1832 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1833 | |||
| 1834 | |**Name**|**Type**|**Documentation** | ||
| 1835 | |id|com:IDType|The id is the identifier for the object. | ||
| 1836 | |urn|xs:anyURI|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). | ||
| 1837 | |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. | ||
| 1838 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 1839 | |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(%%). | ||
| 1840 | |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(%%). | ||
| 1841 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 1842 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 1843 | |[[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. | ||
| 1844 | |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. | ||
| 1845 | |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. | ||
| 1846 | |||
| 1847 | Element Documentation: | ||
| 1848 | |||
| 1849 | |**Name**|**Type**|**Documentation** | ||
| 1850 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1851 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1852 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 1853 | |DataStructureCompone nts|DataStructureCompone ntsType|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 three reserved identifiers in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]; OBS_VALUE, TIME_PERIOD, and REPORTING_PERIOD_START_DAY. These identifiers may not be used outside of their respective defintions (PrimaryMeasure, 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. | ||
| 1854 | |||
| 1855 | //**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>>doc:sdmx:Glossary.Component.WebHome]] lists. | ||
| 1856 | |||
| 1857 | Derivation: | ||
| 1858 | //GroupingType// (restriction) | ||
| 1859 | //DataStructureComponentsBaseType// | ||
| 1860 | |||
| 1861 | Content: | ||
| 1862 | {Empty} | ||
| 1863 | |||
| 1864 | **DataStructureComponentsType: **DataStructureComponentsType describes the structure of the grouping to 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]]. At a minimum at least one [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] and a primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] must be defined. | ||
| 1865 | |||
| 1866 | Derivation: | ||
| 1867 | //GroupingType// (restriction) | ||
| 1868 | //DataStructureComponentsBaseType// (extension) | ||
| 1869 | DataStructureComponentsType | ||
| 1870 | |||
| 1871 | Content: | ||
| 1872 | DimensionList, Group*, AttributeList?, MeasureList | ||
| 1873 | |||
| 1874 | Element Documentation: | ||
| 1875 | |||
| 1876 | |**Name**|**Type**|**Documentation** | ||
| 1877 | |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. | ||
| 1878 | |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]]. | ||
| 1879 | |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]]. | ||
| 1880 | |MeasureList|MeasureListType|MeasureList describes the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] descriptor for a key family. It contains a single metadata (% style="color:#e74c3c" %)concepts(%%) that define the primary [[measures>>doc:sdmx:Glossary.Measure.WebHome]] of a data structure. | ||
| 1881 | |||
| 1882 | //**AttributeListBaseType**//**: **AttributeListBaseType is an abstract base type used as the basis for the AttributeListType. | ||
| 1883 | |||
| 1884 | Derivation: | ||
| 1885 | //com:AnnotableType// (extension) | ||
| 1886 | // IdentifiableType// (extension) | ||
| 1887 | // ComponentListType// (restriction) | ||
| 1888 | //AttributeListBaseType// | ||
| 1889 | |||
| 1890 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1891 | id?, urn?, uri? | ||
| 1892 | |||
| 1893 | Content: | ||
| 1894 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]? | ||
| 1895 | |||
| 1896 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1897 | |||
| 1898 | |**Name**|**Type**|**Documentation** | ||
| 1899 | |id (fixed: AttributeDescriptor)|com:IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is provided in this case for completeness. However, its value is fixed to AttributeDescriptor. | ||
| 1900 | |urn|xs:anyURI|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). | ||
| 1901 | |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. | ||
| 1902 | |||
| 1903 | Element Documentation: | ||
| 1904 | |||
| 1905 | |**Name**|**Type**|**Documentation** | ||
| 1906 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1907 | |||
| 1908 | **AttributeListType: **AttributeListType describes the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] descriptor for the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. | ||
| 1909 | |||
| 1910 | Derivation: | ||
| 1911 | //com:AnnotableType// (extension) | ||
| 1912 | //IdentifiableType// (extension) | ||
| 1913 | //ComponentListType// (restriction) | ||
| 1914 | //AttributeListBaseType// (extension) | ||
| 1915 | AttributeListType | ||
| 1916 | |||
| 1917 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1918 | id?, urn?, uri? | ||
| 1919 | |||
| 1920 | Content: | ||
| 1921 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ([[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] | ReportingYearStartDay)+ | ||
| 1922 | |||
| 1923 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1924 | |||
| 1925 | |**Name**|**Type**|**Documentation** | ||
| 1926 | |id (fixed: AttributeDescriptor)|com:IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is provided in this case for completeness. However, its value is fixed to AttributeDescriptor. | ||
| 1927 | |urn|xs:anyURI|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). | ||
| 1928 | |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. | ||
| 1929 | |||
| 1930 | Element Documentation: | ||
| 1931 | |||
| 1932 | |**Name**|**Type**|**Documentation** | ||
| 1933 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1934 | |[[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. | ||
| 1935 | |ReportingYearStartDa y|ReportingYearStartDa yType|ReportingYearStartDay is a specialized data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which provides important context to the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. If the value of the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is one of the standard reporting periods (see common:ReportingTimePeriodType) then this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to state the month and day that the reporting year begins. This provides a reference point from which the actual calendar dates covered by these periods can be determined. If this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does not occur in a [[data set>>doc:sdmx:Glossary.Data set.WebHome]], then the reporting year start day will be assumed to be January 1. | ||
| 1936 | |||
| 1937 | //**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>>doc:sdmx:Glossary.Component.WebHome]] (that does not allow for XHTML [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). The local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is restricted to the values defined in [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. The (% style="color:#e74c3c" %)concept(%%) role is restricted to the values valid for a data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 1938 | |||
| 1939 | Derivation: | ||
| 1940 | //com:AnnotableType// (extension) | ||
| 1941 | //IdentifiableType// (restriction) | ||
| 1942 | //ComponentBaseType// (extension) | ||
| 1943 | //ComponentType// (restriction) | ||
| 1944 | //AttributeBaseType// | ||
| 1945 | |||
| 1946 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1947 | id?, urn?, uri? | ||
| 1948 | |||
| 1949 | Content: | ||
| 1950 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation? | ||
| 1951 | |||
| 1952 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1953 | |||
| 1954 | |**Name**|**Type**|**Documentation** | ||
| 1955 | |id|com: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). | ||
| 1956 | |urn|xs:anyURI|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). | ||
| 1957 | |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. | ||
| 1958 | |||
| 1959 | Element Documentation: | ||
| 1960 | |||
| 1961 | |**Name**|**Type**|**Documentation** | ||
| 1962 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1963 | |ConceptIdentity|com: 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]]. | ||
| 1964 | |LocalRepresentation|SimpleDataStructureR epresentationType|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. | ||
| 1965 | |||
| 1966 | **AttributeType: **AttributeType describes the structure of a data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], which is defined as a characteristic of an object or entity. The [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] takes its semantic, and in some cases it [[representation>>doc:sdmx:Glossary.Representation.WebHome]], from its (% style="color:#e74c3c" %)concept(%%) identity. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be coded by referencing a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] from its coded local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. It can also specify its text format, which is used as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] if a coded [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is not defined. Neither the coded or uncoded [[representation>>doc:sdmx:Glossary.Representation.WebHome]] are necessary, since the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] may take these from the referenced (% style="color:#e74c3c" %)concept(%%). An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies its relationship with other data structure [[components>>doc:sdmx:Glossary.Component.WebHome]] and is given an assignment status. These two properties dictate where in a data message the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will be attached, and whether or not the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will be required to be given a value. A set of roles defined in [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] can be assigned to the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 1967 | |||
| 1968 | Derivation: | ||
| 1969 | //com:AnnotableType// (extension) | ||
| 1970 | //IdentifiableType// (restriction) | ||
| 1971 | //ComponentBaseType// (extension) | ||
| 1972 | //ComponentType// (restriction) | ||
| 1973 | //AttributeBaseType// (extension) | ||
| 1974 | AttributeType | ||
| 1975 | |||
| 1976 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 1977 | id?, urn?, uri?, assignmentStatus | ||
| 1978 | |||
| 1979 | Content: | ||
| 1980 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation?, ConceptRole*, AttributeRelationship | ||
| 1981 | |||
| 1982 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 1983 | |||
| 1984 | |**Name**|**Type**|**Documentation** | ||
| 1985 | |id|com: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). | ||
| 1986 | |urn|xs:anyURI|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). | ||
| 1987 | |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. | ||
| 1988 | |assignmentStatus|UsageStatusType|The assignmentStatus [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether a value must be provided for the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] when sending documentation along with the data. | ||
| 1989 | |||
| 1990 | Element Documentation: | ||
| 1991 | |||
| 1992 | |**Name**|**Type**|**Documentation** | ||
| 1993 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 1994 | |ConceptIdentity|com: 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]]. | ||
| 1995 | |LocalRepresentation|SimpleDataStructureR epresentationType|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. | ||
| 1996 | |ConceptRole|com: ConceptReferenceType|ConceptRole references (% style="color:#e74c3c" %)concepts(%%) which define roles which this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] serves. If the (% style="color:#e74c3c" %)concept(%%) from which the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] takes its identity also defines a role the (% style="color:#e74c3c" %)concept(%%) serves, then the isConceptRole indicator can be set to true on the (% style="color:#e74c3c" %)concept(%%) identity rather than repeating the reference here. | ||
| 1997 | |AttributeRelationshi p|AttributeRelationshi pType|AttributeRelationship describes how the value of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] varies with the values of other [[components>>doc:sdmx:Glossary.Component.WebHome]]. These relationships will be used to determine the [[attachment level>>doc:sdmx:Glossary.Attachment level.WebHome]] of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the various data formats. | ||
| 1998 | |||
| 1999 | **AttributeRelationshipType: **AttributeRelationshipType defines the structure for stating the relationship between an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and other [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 2000 | |||
| 2001 | Content: | ||
| 2002 | (None | ([[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]+, AttachmentGroup*) | Group | PrimaryMeasure) | ||
| 2003 | |||
| 2004 | Element Documentation: | ||
| 2005 | |||
| 2006 | |**Name**|**Type**|**Documentation** | ||
| 2007 | |None|com:EmptyType|This means that value of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will not vary with any of the other key family [[components>>doc:sdmx:Glossary.Component.WebHome]]. This will always be treated as a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 2008 | |[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]|com: LocalDimensionRefere nceType|This is used to reference [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] on which the value of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] depends. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] using this relationship can be either a group, series (or section), or observation (% style="color:#e74c3c" %)level(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. The [[attachment level>>doc:sdmx:Glossary.Attachment level.WebHome]] of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will be determined by the data format and which [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] are referenced. | ||
| 2009 | |AttachmentGroup|com: LocalGroupKeyDescrip torReferenceType|This is used to specify that the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should always be attached to the groups referenced here. Note that if one of the referenced [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], the groups referenced here will be ignored. | ||
| 2010 | |Group|com: LocalGroupKeyDescrip torReferenceType|This is used as a convenience to referencing all of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the referenced group. The [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will also be attached to this group. | ||
| 2011 | |PrimaryMeasure|com: LocalPrimaryMeasureR eferenceType|This is used to specify that the value of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is dependent upon the observed value. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with this relationship will always be treated as an observation (% style="color:#e74c3c" %)level(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 2012 | |||
| 2013 | **ReportingYearStartDayType: **ReportingYearStartDayType defines the structure of the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. The reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] takes its semantic from its (% style="color:#e74c3c" %)concept(%%) identity (usually the REPORTING_YEAR_START_DAY (% style="color:#e74c3c" %)concept(%%)), yet is always has a fixed identifier (REPORTING_YEAR_START_DAY). The reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] always has a fixed text format, which specifies that the format of its value is always a day and month in the ISO 8601 format of 'MM-DD'. As with any other [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] must be specified. this relationship should be carefully selected as it will determin what type of data the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] will allow. For example, if an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of none is specified, this will mean the [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] conforming to this [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] can only contain data with standard reporting periods where the all reporting periods have the same start day. In this case, data reported as standard reporting periods from two entities with different fiscal year start days could not be contained in the same [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 2014 | |||
| 2015 | Derivation: | ||
| 2016 | //com:AnnotableType// (extension) | ||
| 2017 | //IdentifiableType// (restriction) | ||
| 2018 | //ComponentBaseType// (extension) | ||
| 2019 | //ComponentType// (restriction) | ||
| 2020 | //AttributeBaseType// (extension) | ||
| 2021 | AttributeType (restriction) | ||
| 2022 | ReportingYearStartDayType | ||
| 2023 | |||
| 2024 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2025 | id?, urn?, uri?, assignmentStatus | ||
| 2026 | |||
| 2027 | Content: | ||
| 2028 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation, AttributeRelationship | ||
| 2029 | |||
| 2030 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2031 | |||
| 2032 | |**Name**|**Type**|**Documentation** | ||
| 2033 | |id (fixed: REPORTING_YEAR_START_DAY)|com: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). | ||
| 2034 | |urn|xs:anyURI|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). | ||
| 2035 | |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. | ||
| 2036 | |assignmentStatus|UsageStatusType|The assignmentStatus [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether a value must be provided for the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] when sending documentation along with the data. | ||
| 2037 | |||
| 2038 | Element Documentation: | ||
| 2039 | |||
| 2040 | |**Name**|**Type**|**Documentation** | ||
| 2041 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2042 | |ConceptIdentity|com: 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]]. | ||
| 2043 | |LocalRepresentation|ReportingYearStartDa yRepresentationType|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. | ||
| 2044 | |AttributeRelationshi p|AttributeRelationshi pType|AttributeRelationship describes how the value of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] varies with the values of other [[components>>doc:sdmx:Glossary.Component.WebHome]]. These relationships will be used to determine the [[attachment level>>doc:sdmx:Glossary.Attachment level.WebHome]] of the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the various data formats. | ||
| 2045 | |||
| 2046 | **ReportingYearStartDayRepresentationType: **ReportingYearStartDayRepresentationType defines the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. Enumerated values are not allowed and the text format is fixed to be a day and month in the ISO 8601 format of 'MM-DD'. | ||
| 2047 | |||
| 2048 | Derivation: | ||
| 2049 | //RepresentationType// (restriction) | ||
| 2050 | //DataStructureRepresentationType// (restriction) | ||
| 2051 | SimpleDataStructureRepresentationType (restriction) | ||
| 2052 | ReportingYearStartDayRepresentationType | ||
| 2053 | |||
| 2054 | Content: | ||
| 2055 | TextFormat | ||
| 2056 | |||
| 2057 | Element Documentation: | ||
| 2058 | |||
| 2059 | |**Name**|**Type**|**Documentation** | ||
| 2060 | |TextFormat|ReportingYearStartDa yTextFormatType|TextFormat describes an uncoded textual format. | ||
| 2061 | |||
| 2062 | **ReportingYearStartDayTextFormatType: **ReportingYearStartDayTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the NonFacetedTextFormatType that fixes the value of the text type to be DayMonth. This type exists solely for the purpose of fixing the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 2063 | |||
| 2064 | Derivation: | ||
| 2065 | TextFormatType (restriction) | ||
| 2066 | BasicComponentTextFormatType (restriction) | ||
| 2067 | SimpleComponentTextFormatType (restriction) | ||
| 2068 | NonFacetedTextFormatType (restriction) | ||
| 2069 | ReportingYearStartDayTextFormatType | ||
| 2070 | |||
| 2071 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2072 | textType? | ||
| 2073 | |||
| 2074 | Content: | ||
| 2075 | {Empty} | ||
| 2076 | |||
| 2077 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2078 | |||
| 2079 | |**Name**|**Type**|**Documentation** | ||
| 2080 | |textType (fixed: MonthDay)|com: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. | ||
| 2081 | |||
| 2082 | //**DimensionListBaseType**//**: **DimensionListBaseType is an abstract base type used as the basis for the DimensionListType. | ||
| 2083 | |||
| 2084 | Derivation: | ||
| 2085 | //com:AnnotableType// (extension) | ||
| 2086 | //IdentifiableType// (extension) | ||
| 2087 | //ComponentListType// (restriction) | ||
| 2088 | //DimensionListBaseType// | ||
| 2089 | |||
| 2090 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2091 | id?, urn?, uri? | ||
| 2092 | |||
| 2093 | Content: | ||
| 2094 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]? | ||
| 2095 | |||
| 2096 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2097 | |||
| 2098 | |**Name**|**Type**|**Documentation** | ||
| 2099 | |id (fixed: DimensionDescriptor)|com:IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is provided in this case for completeness. However, its value is fixed to DimensionDescriptor. | ||
| 2100 | |urn|xs:anyURI|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). | ||
| 2101 | |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. | ||
| 2102 | |||
| 2103 | Element Documentation: | ||
| 2104 | |||
| 2105 | |**Name**|**Type**|**Documentation** | ||
| 2106 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2107 | |||
| 2108 | **DimensionListType: **DimensionListType describes the key descriptor for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The order of the declaration of child [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] 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>>doc:sdmx:Glossary.Dimension.WebHome]], which is not represented as a member of the ordered key). Any [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] which uses the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] should also declare a frequency [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], conventionally the first [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the key (the set of ordered non-time [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]). If is not necessary to assign a time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], as data can be organised in any fashion required. | ||
| 2109 | |||
| 2110 | Derivation: | ||
| 2111 | //com:AnnotableType// (extension) | ||
| 2112 | //IdentifiableType// (extension) | ||
| 2113 | //ComponentListType// (restriction) | ||
| 2114 | //DimensionListBaseType// (extension) | ||
| 2115 | DimensionListType | ||
| 2116 | |||
| 2117 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2118 | id?, urn?, uri? | ||
| 2119 | |||
| 2120 | Content: | ||
| 2121 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ([[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] | MeasureDimension | TimeDimension)+ | ||
| 2122 | |||
| 2123 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2124 | |||
| 2125 | |**Name**|**Type**|**Documentation** | ||
| 2126 | |id (fixed: DimensionDescriptor)|com:IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is provided in this case for completeness. However, its value is fixed to DimensionDescriptor. | ||
| 2127 | |urn|xs:anyURI|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). | ||
| 2128 | |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. | ||
| 2129 | |||
| 2130 | Element Documentation: | ||
| 2131 | |||
| 2132 | |**Name**|**Type**|**Documentation** | ||
| 2133 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2134 | |[[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>>doc:sdmx:Glossary.Reference area.WebHome]]. | ||
| 2135 | |MeasureDimension|MeasureDimensionType|MeasureDimension is a special type of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which defines multiple [[measures>>doc:sdmx:Glossary.Measure.WebHome]] in a key family. This is represented as any other [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in a unless it is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. It takes it [[representation>>doc:sdmx:Glossary.Representation.WebHome]] from a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]], and this scheme defines the [[measures>>doc:sdmx:Glossary.Measure.WebHome]] and their [[representations>>doc:sdmx:Glossary.Representation.WebHome]]. When data is formatted with this as the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], these [[measures>>doc:sdmx:Glossary.Measure.WebHome]] can be made explicit or the value of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be treated as any other [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. If the [[measures>>doc:sdmx:Glossary.Measure.WebHome]] are explicit, the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the observation will be specific to the core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for each (% style="color:#e74c3c" %)concept(%%) in the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]. Note that it is necessary that these [[representations>>doc:sdmx:Glossary.Representation.WebHome]] are compliant (the same or derived from) with that of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. | ||
| 2136 | |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. | ||
| 2137 | |||
| 2138 | //**BaseDimensionBaseType**//**: **BaseDimensionBaseType is an abstract base type that serves as the basis for any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. It restricts the text format base to a text format valid for data [[components>>doc:sdmx:Glossary.Component.WebHome]] (that does not allow for XHTML [[representation>>doc:sdmx:Glossary.Representation.WebHome]]). | ||
| 2139 | |||
| 2140 | Derivation: | ||
| 2141 | //com:AnnotableType// (extension) | ||
| 2142 | //IdentifiableType// (restriction) | ||
| 2143 | //ComponentBaseType// (extension) | ||
| 2144 | //ComponentType// (restriction) | ||
| 2145 | //BaseDimensionBaseType// | ||
| 2146 | |||
| 2147 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2148 | id?, urn?, uri? | ||
| 2149 | |||
| 2150 | Content: | ||
| 2151 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation? | ||
| 2152 | |||
| 2153 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2154 | |||
| 2155 | |**Name**|**Type**|**Documentation** | ||
| 2156 | |id|com: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). | ||
| 2157 | |urn|xs:anyURI|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). | ||
| 2158 | |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. | ||
| 2159 | |||
| 2160 | Element Documentation: | ||
| 2161 | |||
| 2162 | |**Name**|**Type**|**Documentation** | ||
| 2163 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2164 | |ConceptIdentity|com: 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]]. | ||
| 2165 | |LocalRepresentation|//DataStructureReprese ntationType//|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. | ||
| 2166 | |||
| 2167 | //**BaseDimensionType**//**: **BaseDimensionType is an abstract base type which defines the basic structure of all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 2168 | |||
| 2169 | Derivation: | ||
| 2170 | //com:AnnotableType// (extension) | ||
| 2171 | //IdentifiableType// (restriction) | ||
| 2172 | //ComponentBaseType// (extension) | ||
| 2173 | //ComponentType// (restriction) | ||
| 2174 | //BaseDimensionBaseType// (extension) | ||
| 2175 | //BaseDimensionType// | ||
| 2176 | |||
| 2177 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2178 | id?, urn?, uri?, position?, type? | ||
| 2179 | |||
| 2180 | Content: | ||
| 2181 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation?, ConceptRole* | ||
| 2182 | |||
| 2183 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2184 | |||
| 2185 | |**Name**|**Type**|**Documentation** | ||
| 2186 | |id|com: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). | ||
| 2187 | |urn|xs:anyURI|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). | ||
| 2188 | |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. | ||
| 2189 | |position|xs:int|The position [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the position of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. It is optional an the position of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only. | ||
| 2190 | |type|com: DimensionTypeType|The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifies whether then [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], or a regular [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Although these are all apparent by the element names, this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] allows for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to be processed independent of its element as well as maintaining the restriction of only one [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] while still allowing [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to occur in any order. | ||
| 2191 | |||
| 2192 | Element Documentation: | ||
| 2193 | |||
| 2194 | |**Name**|**Type**|**Documentation** | ||
| 2195 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2196 | |ConceptIdentity|com: 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]]. | ||
| 2197 | |LocalRepresentation|//DataStructureReprese ntationType//|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. | ||
| 2198 | |ConceptRole|com: ConceptReferenceType|ConceptRole references (% style="color:#e74c3c" %)concepts(%%) which define roles which this [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] serves. If the (% style="color:#e74c3c" %)concept(%%) from which the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] takes its identity also defines a role the (% style="color:#e74c3c" %)concept(%%) serves, then the isConceptRole indicator can be set to true on the (% style="color:#e74c3c" %)concept(%%) identity rather than repeating the reference here. | ||
| 2199 | |||
| 2200 | **DimensionType: **DimensionType describes the structure of an ordinary [[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>>doc:sdmx:Glossary.Reference area.WebHome]]. The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] takes its semantic, and in some cases it [[representation>>doc:sdmx:Glossary.Representation.WebHome]], from its (% style="color:#e74c3c" %)concept(%%) identity. A [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can be coded by referencing a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] from its coded local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. It can also specify its text format, which is used as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] if a coded [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is not defined. Neither the coded or uncoded [[representation>>doc:sdmx:Glossary.Representation.WebHome]] are necessary, since the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] may take these from the referenced (% style="color:#e74c3c" %)concept(%%). | ||
| 2201 | |||
| 2202 | Derivation: | ||
| 2203 | //com:AnnotableType// (extension) | ||
| 2204 | //IdentifiableType// (restriction) | ||
| 2205 | //ComponentBaseType// (extension) | ||
| 2206 | //ComponentType// (restriction) | ||
| 2207 | //BaseDimensionBaseType// (extension) | ||
| 2208 | //BaseDimensionType// (restriction) | ||
| 2209 | DimensionType | ||
| 2210 | |||
| 2211 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2212 | id?, urn?, uri?, position?, type? | ||
| 2213 | |||
| 2214 | Content: | ||
| 2215 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation?, ConceptRole* | ||
| 2216 | |||
| 2217 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2218 | |||
| 2219 | |**Name**|**Type**|**Documentation** | ||
| 2220 | |id|com: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). | ||
| 2221 | |urn|xs:anyURI|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). | ||
| 2222 | |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. | ||
| 2223 | |position|xs:int|The position [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the position of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. It is optional an the position of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only. | ||
| 2224 | |type (fixed: [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]])|com: DimensionTypeType|The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifies whether then [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], or a regular [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Although these are all apparent by the element names, this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] allows for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to be processed independent of its element as well as maintaining the restriction of only one [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] while still allowing [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to occur in any order. | ||
| 2225 | |||
| 2226 | Element Documentation: | ||
| 2227 | |||
| 2228 | |**Name**|**Type**|**Documentation** | ||
| 2229 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2230 | |ConceptIdentity|com: 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]]. | ||
| 2231 | |LocalRepresentation|SimpleDataStructureR epresentationType|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. | ||
| 2232 | |ConceptRole|com: ConceptReferenceType|ConceptRole references (% style="color:#e74c3c" %)concepts(%%) which define roles which this [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] serves. If the (% style="color:#e74c3c" %)concept(%%) from which the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] takes its identity also defines a role the (% style="color:#e74c3c" %)concept(%%) serves, then the isConceptRole indicator can be set to true on the (% style="color:#e74c3c" %)concept(%%) identity rather than repeating the reference here. | ||
| 2233 | |||
| 2234 | **TimeDimensionType: **TimeDimensionType describes the structure of a time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. The time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] takes its semantic from its (% style="color:#e74c3c" %)concept(%%) identity (usually the TIME_PERIOD (% style="color:#e74c3c" %)concept(%%)), yet is always has a fixed identifier (TIME_PERIOD). The time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] always has a fixed text format, which specifies that its format is always the in the value set of the observational [[time period>>doc:sdmx:Glossary.Time period.WebHome]] (see common:ObservationalTimePeriodType). It is possible that the format may be a sub-set of the observational [[time period>>doc:sdmx:Glossary.Time period.WebHome]] value set. For example, it is possible to state that the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] might always be a calendar year. See the enumerations of the textType [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the LocalRepresentation/TextFormat for more details of the possible sub-sets. It is also possible to [[facet>>doc:sdmx:Glossary.Facet.WebHome]] this [[representation>>doc:sdmx:Glossary.Representation.WebHome]] with start and end dates. The purpose of such facts is to restrict the value of the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to occur within the specified range. If the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] also be included in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. When the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used, any standard reporting period values will be assumed to be based on the start day contained in this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. If the reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 2235 | |||
| 2236 | Derivation: | ||
| 2237 | //com:AnnotableType// (extension) | ||
| 2238 | //IdentifiableType// (restriction) | ||
| 2239 | //ComponentBaseType// (extension) | ||
| 2240 | //ComponentType// (restriction) | ||
| 2241 | //BaseDimensionBaseType// (extension) | ||
| 2242 | //BaseDimensionType// (restriction) | ||
| 2243 | TimeDimensionType | ||
| 2244 | |||
| 2245 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2246 | id?, urn?, uri?, position?, type? | ||
| 2247 | |||
| 2248 | Content: | ||
| 2249 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation | ||
| 2250 | |||
| 2251 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2252 | |||
| 2253 | |**Name**|**Type**|**Documentation** | ||
| 2254 | |id (fixed: TIME_PERIOD)|com: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). | ||
| 2255 | |urn|xs:anyURI|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). | ||
| 2256 | |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. | ||
| 2257 | |position|xs:int|The position [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the position of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. It is optional an the position of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only. | ||
| 2258 | |type (fixed: TimeDimension)|com: DimensionTypeType|The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifies whether then [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], or a regular [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Although these are all apparent by the element names, this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] allows for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to be processed independent of its element as well as maintaining the restriction of only one [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] while still allowing [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to occur in any order. | ||
| 2259 | |||
| 2260 | Element Documentation: | ||
| 2261 | |||
| 2262 | |**Name**|**Type**|**Documentation** | ||
| 2263 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2264 | |ConceptIdentity|com: 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]]. | ||
| 2265 | |LocalRepresentation|TimeDimensionReprese ntationType|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. | ||
| 2266 | |||
| 2267 | **MeasureDimensionType: **MeasureDimensionType defines the structure of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. It is derived from the base [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] structure, but requires that a coded [[representation>>doc:sdmx:Glossary.Representation.WebHome]] taken from a [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] is given. | ||
| 2268 | |||
| 2269 | Derivation: | ||
| 2270 | //com:AnnotableType// (extension) | ||
| 2271 | //IdentifiableType// (restriction) | ||
| 2272 | //ComponentBaseType// (extension) | ||
| 2273 | //ComponentType// (restriction) | ||
| 2274 | //BaseDimensionBaseType// (extension) | ||
| 2275 | //BaseDimensionType// (restriction) | ||
| 2276 | MeasureDimensionType | ||
| 2277 | |||
| 2278 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2279 | id?, urn?, uri?, position?, type? | ||
| 2280 | |||
| 2281 | Content: | ||
| 2282 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation, ConceptRole* | ||
| 2283 | |||
| 2284 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2285 | |||
| 2286 | |**Name**|**Type**|**Documentation** | ||
| 2287 | |id|com: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). | ||
| 2288 | |urn|xs:anyURI|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). | ||
| 2289 | |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. | ||
| 2290 | |position|xs:int|The position [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the position of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. It is optional an the position of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only. | ||
| 2291 | |type (fixed: MeasureDimension)|com: DimensionTypeType|The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifies whether then [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], or a regular [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Although these are all apparent by the element names, this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] allows for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to be processed independent of its element as well as maintaining the restriction of only one [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] while still allowing [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] to occur in any order. | ||
| 2292 | |||
| 2293 | Element Documentation: | ||
| 2294 | |||
| 2295 | |**Name**|**Type**|**Documentation** | ||
| 2296 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2297 | |ConceptIdentity|com: 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]]. | ||
| 2298 | |LocalRepresentation|MeasureDimensionRepr esentationType|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. | ||
| 2299 | |ConceptRole|com: ConceptReferenceType|ConceptRole references (% style="color:#e74c3c" %)concepts(%%) which define roles which this [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] serves. If the (% style="color:#e74c3c" %)concept(%%) from which the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] takes its identity also defines a role the (% style="color:#e74c3c" %)concept(%%) serves, then the isConceptRole indicator can be set to true on the (% style="color:#e74c3c" %)concept(%%) identity rather than repeating the reference here. | ||
| 2300 | |||
| 2301 | //**GroupBaseType**//**: **GroupBaseType is an abstract base type that forms the basis for the GroupType. | ||
| 2302 | |||
| 2303 | Derivation: | ||
| 2304 | //com:AnnotableType// (extension) | ||
| 2305 | //IdentifiableType// (extension) | ||
| 2306 | //ComponentListType// (restriction) | ||
| 2307 | //GroupBaseType// | ||
| 2308 | |||
| 2309 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2310 | id, urn?, uri? | ||
| 2311 | |||
| 2312 | Content: | ||
| 2313 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]? | ||
| 2314 | |||
| 2315 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2316 | |||
| 2317 | |**Name**|**Type**|**Documentation** | ||
| 2318 | |id|com:IDType|The id is the identifier for the object. | ||
| 2319 | |urn|xs:anyURI|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). | ||
| 2320 | |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. | ||
| 2321 | |||
| 2322 | Element Documentation: | ||
| 2323 | |||
| 2324 | |**Name**|**Type**|**Documentation** | ||
| 2325 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2326 | |||
| 2327 | **GroupType: **GroupType describes the structure of a group descriptor in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. A group may consist of a of partial key, or collection of distinct cube regions or key sets to which [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] may be attached. The purpose of a group is to specify [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 2328 | |||
| 2329 | Derivation: | ||
| 2330 | //com:AnnotableType// (extension) | ||
| 2331 | //IdentifiableType// (extension) | ||
| 2332 | //ComponentListType// (restriction) | ||
| 2333 | //GroupBaseType// (extension) | ||
| 2334 | GroupType | ||
| 2335 | |||
| 2336 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2337 | id, urn?, uri? | ||
| 2338 | |||
| 2339 | Content: | ||
| 2340 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, (GroupDimension+ | AttachmentConstraint) | ||
| 2341 | |||
| 2342 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2343 | |||
| 2344 | |**Name**|**Type**|**Documentation** | ||
| 2345 | |id|com:IDType|The id is the identifier for the object. | ||
| 2346 | |urn|xs:anyURI|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). | ||
| 2347 | |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. | ||
| 2348 | |||
| 2349 | Element Documentation: | ||
| 2350 | |||
| 2351 | |**Name**|**Type**|**Documentation** | ||
| 2352 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2353 | |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(%%). | ||
| 2354 | |AttachmentConstraint|com: AttachmentConstraint ReferenceType|AttachmentConstraint references an attachment (% style="color:#e74c3c" %)constraint(%%) that defines the key sets and/or cube regions that [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] may be attached to. This is an alternative to referencing the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], and allows [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] to be attached to data for given values of [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 2355 | |||
| 2356 | //**GroupDimensionBaseType**//**: **GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType. | ||
| 2357 | |||
| 2358 | Derivation: | ||
| 2359 | //com:AnnotableType// (extension) | ||
| 2360 | //IdentifiableType// (restriction) | ||
| 2361 | //ComponentBaseType// (extension) | ||
| 2362 | //ComponentType// (restriction) | ||
| 2363 | //GroupDimensionBaseType// | ||
| 2364 | |||
| 2365 | Content: | ||
| 2366 | {Empty} | ||
| 2367 | |||
| 2368 | **GroupDimensionType: **GroupDimensionType defines a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]] with a [[group key>>doc:sdmx:Glossary.Group key.WebHome]] descriptor [[component>>doc:sdmx:Glossary.Component.WebHome]] list. Although technically a [[component>>doc:sdmx:Glossary.Component.WebHome]], this is essentially a reference to a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the key descriptor. Therefore, the identification, name, and description, (% style="color:#e74c3c" %)concept(%%) identity and [[representation>>doc:sdmx:Glossary.Representation.WebHome]] properties that are typically available for a [[component>>doc:sdmx:Glossary.Component.WebHome]] are not allowed here, as they are all inherited from the referenced [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 2369 | |||
| 2370 | Derivation: | ||
| 2371 | //com:AnnotableType// (extension) | ||
| 2372 | //IdentifiableType// (restriction) | ||
| 2373 | //ComponentBaseType// (extension) | ||
| 2374 | //ComponentType// (restriction) | ||
| 2375 | //GroupDimensionBaseType// (extension) | ||
| 2376 | GroupDimensionType | ||
| 2377 | |||
| 2378 | Content: | ||
| 2379 | DimensionReference | ||
| 2380 | |||
| 2381 | Element Documentation: | ||
| 2382 | |||
| 2383 | |**Name**|**Type**|**Documentation** | ||
| 2384 | |DimensionReference|com: LocalDimensionRefere nceType|DimensionReference provides a reference to a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the key descriptor of the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] in which this [[group key>>doc:sdmx:Glossary.Group key.WebHome]] descriptor is defined. | ||
| 2385 | |||
| 2386 | **MeasureListType: **MeasureListType describes the structure of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] descriptor for a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Only a primary may be defined. | ||
| 2387 | |||
| 2388 | Derivation: | ||
| 2389 | //com:AnnotableType// (extension) | ||
| 2390 | //IdentifiableType// (extension) | ||
| 2391 | //ComponentListType// (restriction) | ||
| 2392 | MeasureListType | ||
| 2393 | |||
| 2394 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2395 | id?, urn?, uri? | ||
| 2396 | |||
| 2397 | Content: | ||
| 2398 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, PrimaryMeasure | ||
| 2399 | |||
| 2400 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2401 | |||
| 2402 | |**Name**|**Type**|**Documentation** | ||
| 2403 | |id (fixed: MeasureDescriptor)|com:IDType|The id is the identifier for the object. | ||
| 2404 | |urn|xs:anyURI|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). | ||
| 2405 | |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. | ||
| 2406 | |||
| 2407 | Element Documentation: | ||
| 2408 | |||
| 2409 | |**Name**|**Type**|**Documentation** | ||
| 2410 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2411 | |PrimaryMeasure|PrimaryMeasureType|PrimaryMeasure defines the structure of the primary [[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]]. Although this may take its semantic from any (% style="color:#e74c3c" %)concept(%%), this is provided a fixed identifier (OBS_VALUE) so that it may be easily distinguished in data messages. | ||
| 2412 | |||
| 2413 | **PrimaryMeasureType: **PrimaryMeasureType describes the structure of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]]. It describes the [[observation values>>doc:sdmx:Glossary.Observation value.WebHome]] for all presentations of the data. The primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] takes its semantic, and in some cases it [[representation>>doc:sdmx:Glossary.Representation.WebHome]], from its (% style="color:#e74c3c" %)concept(%%) identity (conventionally the OBS_VALUE (% style="color:#e74c3c" %)concept(%%)). The primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] can be coded by referencing a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] from its coded local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. It can also specify its text format, which is used as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] if a coded [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is not defined. Neither the coded or uncoded [[representation>>doc:sdmx:Glossary.Representation.WebHome]] are necessary, since the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] may take these from the referenced (% style="color:#e74c3c" %)concept(%%). Note that if the data structure declares a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of this must be a superset of all possible [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)concept(%%) [[representations>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 2414 | |||
| 2415 | Derivation: | ||
| 2416 | //com:AnnotableType// (extension) | ||
| 2417 | //IdentifiableType// (restriction) | ||
| 2418 | //ComponentBaseType// (extension) | ||
| 2419 | //ComponentType// (restriction) | ||
| 2420 | PrimaryMeasureType | ||
| 2421 | |||
| 2422 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2423 | id?, urn?, uri? | ||
| 2424 | |||
| 2425 | Content: | ||
| 2426 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation? | ||
| 2427 | |||
| 2428 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2429 | |||
| 2430 | |**Name**|**Type**|**Documentation** | ||
| 2431 | |id (fixed: OBS_VALUE)|com: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). | ||
| 2432 | |urn|xs:anyURI|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). | ||
| 2433 | |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. | ||
| 2434 | |||
| 2435 | Element Documentation: | ||
| 2436 | |||
| 2437 | |**Name**|**Type**|**Documentation** | ||
| 2438 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2439 | |ConceptIdentity|com: 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]]. | ||
| 2440 | |LocalRepresentation|SimpleDataStructureR epresentationType|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. | ||
| 2441 | |||
| 2442 | //**DataStructureRepresentationType**//**: **DataStructureRepresentationType is an abstract base type which defines the allowable [[representations>>doc:sdmx:Glossary.Representation.WebHome]] for any [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]]. The enumeration must be restricted to the proper type for [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] for a given [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 2443 | |||
| 2444 | Derivation: | ||
| 2445 | //RepresentationType// (restriction) | ||
| 2446 | //DataStructureRepresentationType// | ||
| 2447 | |||
| 2448 | Content: | ||
| 2449 | (TextFormat | (Enumeration, EnumerationFormat?)) | ||
| 2450 | |||
| 2451 | Element Documentation: | ||
| 2452 | |||
| 2453 | |**Name**|**Type**|**Documentation** | ||
| 2454 | |TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format. | ||
| 2455 | |Enumeration|//com: ItemSchemeReferenceB aseType//|Enumeration references an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that enumerates the allowable values for this [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 2456 | |EnumerationFormat|CodededTextFormatTyp e|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. | ||
| 2457 | |||
| 2458 | **SimpleDataStructureRepresentationType: **SimpleDataStructureRepresentationType defines the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for any non-[[measure>>doc:sdmx:Glossary.Measure.WebHome]] and non-time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 2459 | |||
| 2460 | Derivation: | ||
| 2461 | |||
| 2462 | //RepresentationType// (restriction) | ||
| 2463 | [[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType// (restriction) | ||
| 2464 | [[image:inherit.gif||height="9" width="9"]] SimpleDataStructureRepresentationType | ||
| 2465 | |||
| 2466 | Content: | ||
| 2467 | (TextFormat | (Enumeration, EnumerationFormat?)) | ||
| 2468 | |||
| 2469 | Element Documentation: | ||
| 2470 | |||
| 2471 | |**Name**|**Type**|**Documentation** | ||
| 2472 | |TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format. | ||
| 2473 | |Enumeration|com: CodelistReferenceTyp e|Enumeration references an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that enumerates the allowable values for this [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 2474 | |EnumerationFormat|CodededTextFormatTyp e|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. | ||
| 2475 | |||
| 2476 | **MeasureDimensionRepresentationType: **BaseDimensionRepresentationType is an abstract base which defines the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. | ||
| 2477 | |||
| 2478 | Derivation: | ||
| 2479 | //RepresentationType// (restriction) | ||
| 2480 | //DataStructureRepresentationType// (restriction) | ||
| 2481 | MeasureDimensionRepresentationType | ||
| 2482 | |||
| 2483 | Content: | ||
| 2484 | Enumeration | ||
| 2485 | |||
| 2486 | Element Documentation: | ||
| 2487 | |||
| 2488 | |**Name**|**Type**|**Documentation** | ||
| 2489 | |Enumeration|com: ConceptSchemeReferen ceType|Enumeration references an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that enumerates the allowable values for this [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 2490 | |||
| 2491 | **TimeDimensionRepresentationType: **TimeDimensionRepresentationType defines the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. Enumerated values are not allowed. | ||
| 2492 | |||
| 2493 | Derivation: | ||
| 2494 | //RepresentationType// (restriction) | ||
| 2495 | //DataStructureRepresentationType// (restriction) | ||
| 2496 | SimpleDataStructureRepresentationType (restriction) | ||
| 2497 | TimeDimensionRepresentationType | ||
| 2498 | |||
| 2499 | Content: | ||
| 2500 | TextFormat | ||
| 2501 | |||
| 2502 | Element Documentation: | ||
| 2503 | |||
| 2504 | |**Name**|**Type**|**Documentation** | ||
| 2505 | |TextFormat|TimeTextFormatType|TextFormat describes an uncoded textual format. | ||
| 2506 | |||
| 2507 | **DataflowType: **DataflowType describes the structure of a [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]]. A [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] is defined as the structure of data that will provided for different [[reference periods>>doc:sdmx:Glossary.Reference period.WebHome]]. If this type is not referenced externally, then a reference to a key family definition must be provided. | ||
| 2508 | |||
| 2509 | Derivation: | ||
| 2510 | //com:AnnotableType// (extension) | ||
| 2511 | //IdentifiableType// (extension) | ||
| 2512 | //NameableType// (extension) | ||
| 2513 | //VersionableType// (restriction) | ||
| 2514 | //MaintainableBaseType// (extension) | ||
| 2515 | //MaintainableType// (extension) | ||
| 2516 | //StructureUsageType// (restriction) | ||
| 2517 | DataflowType | ||
| 2518 | |||
| 2519 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2520 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 2521 | |||
| 2522 | Content: | ||
| 2523 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Structure? | ||
| 2524 | |||
| 2525 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2526 | |||
| 2527 | |**Name**|**Type**|**Documentation** | ||
| 2528 | |id|com:IDType|The id is the identifier for the object. | ||
| 2529 | |urn|xs:anyURI|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). | ||
| 2530 | |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. | ||
| 2531 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 2532 | |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(%%). | ||
| 2533 | |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(%%). | ||
| 2534 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 2535 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 2536 | |[[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. | ||
| 2537 | |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. | ||
| 2538 | |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. | ||
| 2539 | |||
| 2540 | Element Documentation: | ||
| 2541 | |||
| 2542 | |**Name**|**Type**|**Documentation** | ||
| 2543 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2544 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2545 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2546 | |Structure|com: DataStructureReferen ceType|Structure provides a reference to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] which defines the structure of all data for this flow. | ||
| 2547 | |||
| 2548 | //**HierarchicalCodelistBaseType**//**: **HierarchicalCodelistBaseType is an abstract base class that is the basis for the HierarchicalCodelistType. It requires that a name be supplied. | ||
| 2549 | |||
| 2550 | Derivation: | ||
| 2551 | //com:AnnotableType// (extension) | ||
| 2552 | //IdentifiableType// (extension) | ||
| 2553 | //NameableType// (extension) | ||
| 2554 | //VersionableType// (restriction) | ||
| 2555 | //MaintainableBaseType// (extension) | ||
| 2556 | //MaintainableType// (restriction) | ||
| 2557 | //HierarchicalCodelistBaseType// | ||
| 2558 | |||
| 2559 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2560 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 2561 | |||
| 2562 | Content: | ||
| 2563 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 2564 | |||
| 2565 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2566 | |||
| 2567 | |**Name**|**Type**|**Documentation** | ||
| 2568 | |id|com:IDType|The id is the identifier for the object. | ||
| 2569 | |urn|xs:anyURI|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). | ||
| 2570 | |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. | ||
| 2571 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 2572 | |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(%%). | ||
| 2573 | |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(%%). | ||
| 2574 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 2575 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 2576 | |[[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. | ||
| 2577 | |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. | ||
| 2578 | |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. | ||
| 2579 | |||
| 2580 | Element Documentation: | ||
| 2581 | |||
| 2582 | |**Name**|**Type**|**Documentation** | ||
| 2583 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2584 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2585 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2586 | |||
| 2587 | **HierarchicalCodelistType: **HierarchicalCodelistType describes the structure of a hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. A [[hierarchical code list>>doc:sdmx:Glossary.Hierarchical code list.WebHome]] 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, as defined by one or more [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of the list. | ||
| 2588 | |||
| 2589 | Derivation: | ||
| 2590 | //com:AnnotableType// (extension) | ||
| 2591 | //IdentifiableType// (extension) | ||
| 2592 | //NameableType// (extension) | ||
| 2593 | //VersionableType// (restriction) | ||
| 2594 | //MaintainableBaseType// (extension) | ||
| 2595 | //MaintainableType// (restriction) | ||
| 2596 | //HierarchicalCodelistBaseType// (extension) | ||
| 2597 | HierarchicalCodelistType | ||
| 2598 | |||
| 2599 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2600 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 2601 | |||
| 2602 | Content: | ||
| 2603 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, IncludedCodelist*, [[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]* | ||
| 2604 | |||
| 2605 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2606 | |||
| 2607 | |**Name**|**Type**|**Documentation** | ||
| 2608 | |id|com:IDType|The id is the identifier for the object. | ||
| 2609 | |urn|xs:anyURI|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). | ||
| 2610 | |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. | ||
| 2611 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 2612 | |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(%%). | ||
| 2613 | |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(%%). | ||
| 2614 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 2615 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 2616 | |[[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. | ||
| 2617 | |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. | ||
| 2618 | |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. | ||
| 2619 | |||
| 2620 | Element Documentation: | ||
| 2621 | |||
| 2622 | |**Name**|**Type**|**Documentation** | ||
| 2623 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2624 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2625 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2626 | |IncludedCodelist|IncludedCodelistRefe renceType|IndludedCodelist provides a collection of references to the [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] whose [[codes>>doc:sdmx:Glossary.Code.WebHome]] are arranged in this [[hierarchical code list>>doc:sdmx:Glossary.Hierarchical code list.WebHome]]. | ||
| 2627 | |[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]|HierarchyType|[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] describes a classification structure arranged in (% style="color:#e74c3c" %)levels(%%) of detail from the broadest to the most detailed (% style="color:#e74c3c" %)level(%%). These (% style="color:#e74c3c" %)levels(%%) can be formal or informal, and are not necessary to describe. If the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] does contain (% style="color:#e74c3c" %)levels(%%), then each [[hierarchical code>>doc:sdmx:Glossary.Hierarchical code.WebHome]] is assumed to exist in the (% style="color:#e74c3c" %)level(%%) where the depths of nesting match. | ||
| 2628 | |||
| 2629 | //**HierarchyBaseType**//**: **HierarchyBaseType is an abstract base type that serves as the basis for the HierarchyType. It requires a name and id be provided. | ||
| 2630 | |||
| 2631 | Derivation: | ||
| 2632 | //com:AnnotableType// (extension) | ||
| 2633 | //IdentifiableType// (extension) | ||
| 2634 | //NameableType// (restriction) | ||
| 2635 | //HierarchyBaseType// | ||
| 2636 | |||
| 2637 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2638 | id, urn?, uri? | ||
| 2639 | |||
| 2640 | Content: | ||
| 2641 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 2642 | |||
| 2643 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2644 | |||
| 2645 | |**Name**|**Type**|**Documentation** | ||
| 2646 | |id|com:IDType|The id is the identifier for the object. | ||
| 2647 | |urn|xs:anyURI|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). | ||
| 2648 | |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. | ||
| 2649 | |||
| 2650 | Element Documentation: | ||
| 2651 | |||
| 2652 | |**Name**|**Type**|**Documentation** | ||
| 2653 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2654 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2655 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2656 | |||
| 2657 | **HierarchyType: **The [[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] is an abstract type that provides for a classification structure of referenced [[codes>>doc:sdmx:Glossary.Code.WebHome]] arranged in (% style="color:#e74c3c" %)levels(%%) of detail from the broadest to the most detailed (% style="color:#e74c3c" %)level(%%). The (% style="color:#e74c3c" %)levels(%%) in which the [[code>>doc:sdmx:Glossary.Code.WebHome]] exist can be formal or informal. | ||
| 2658 | |||
| 2659 | Derivation: | ||
| 2660 | //com:AnnotableType// (extension) | ||
| 2661 | //IdentifiableType// (extension) | ||
| 2662 | //NameableType// (restriction) | ||
| 2663 | //HierarchyBaseType// (extension) | ||
| 2664 | HierarchyType | ||
| 2665 | |||
| 2666 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2667 | id, urn?, uri?, (% style="color:#e74c3c" %)leveled(%%)? | ||
| 2668 | |||
| 2669 | Content: | ||
| 2670 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, HierarchicalCode+, (% style="color:#e74c3c" %)Level(%%)? | ||
| 2671 | |||
| 2672 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2673 | |||
| 2674 | |**Name**|**Type**|**Documentation** | ||
| 2675 | |id|com:IDType|The id is the identifier for the object. | ||
| 2676 | |urn|xs:anyURI|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). | ||
| 2677 | |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. | ||
| 2678 | |(%%)(% style="color:#e74c3c" %)leveled(%%) (default: false)|xs:boolean|The (% style="color:#e74c3c" %)leveled(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates that the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] has formal (% style="color:#e74c3c" %)levels(%%). In this case, every [[code>>doc:sdmx:Glossary.Code.WebHome]] should have a (% style="color:#e74c3c" %)level(%%) associated with it. | ||
| 2679 | |||
| 2680 | Element Documentation: | ||
| 2681 | |||
| 2682 | |**Name**|**Type**|**Documentation** | ||
| 2683 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2684 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2685 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2686 | |HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to assemble the [[codes>>doc:sdmx:Glossary.Code.WebHome]] from the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]](s) referenced into a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. | ||
| 2687 | |(%%)(% style="color:#e74c3c" %)Level|LevelType|In a formally (% style="color:#e74c3c" %)leveled(%%) [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], (% style="color:#e74c3c" %)Level(%%) describes a group of [[codes>>doc:sdmx:Glossary.Code.WebHome]] which are characterised by homogeneous coding, and where the parent of each [[code>>doc:sdmx:Glossary.Code.WebHome]] in the group is at the same higher (% style="color:#e74c3c" %)level(%%) of the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. In a value based [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] (% style="color:#e74c3c" %)Level(%%) describes information about the [[codes>>doc:sdmx:Glossary.Code.WebHome]] at the specified nesting (% style="color:#e74c3c" %)level(%%). This structure is recursive to indicate the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of the (% style="color:#e74c3c" %)levels(%%). | ||
| 2688 | |||
| 2689 | //**HierarchicalCodeBaseType**//**: **HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri. | ||
| 2690 | |||
| 2691 | Derivation: | ||
| 2692 | //com:AnnotableType// (extension) | ||
| 2693 | //IdentifiableType// (restriction) | ||
| 2694 | //HierarchicalCodeBaseType// | ||
| 2695 | |||
| 2696 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2697 | id, urn?, uri? | ||
| 2698 | |||
| 2699 | Content: | ||
| 2700 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]? | ||
| 2701 | |||
| 2702 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2703 | |||
| 2704 | |**Name**|**Type**|**Documentation** | ||
| 2705 | |id|com:IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] allows for an id to be assigned to the use of the particular [[code>>doc:sdmx:Glossary.Code.WebHome]] at that specific point in the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. This value is unique within the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] being created, and is used to (% style="color:#e74c3c" %)map(%%) the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] against external structures. | ||
| 2706 | |urn|xs:anyURI|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). | ||
| 2707 | |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. | ||
| 2708 | |||
| 2709 | Element Documentation: | ||
| 2710 | |||
| 2711 | |**Name**|**Type**|**Documentation** | ||
| 2712 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2713 | |||
| 2714 | **HierarchicalCodeType: **HierarchicalCodeType describes the structure of a [[hierarchical code>>doc:sdmx:Glossary.Hierarchical code.WebHome]]. A [[hierarchical code>>doc:sdmx:Glossary.Hierarchical code.WebHome]] provides for a reference to a [[code>>doc:sdmx:Glossary.Code.WebHome]] that is referenced within the [[hierarchical code list>>doc:sdmx:Glossary.Hierarchical code list.WebHome]] via either a complete reference to a [[code>>doc:sdmx:Glossary.Code.WebHome]] through either a URN or full set of reference fields, or a local reference which utilizes the included [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] reference alias and the identification of a [[code>>doc:sdmx:Glossary.Code.WebHome]] from the list. [[Codes>>doc:sdmx:Glossary.Code.WebHome]] are arranged in a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] by this reference. Note that it is possible to reference a single [[code>>doc:sdmx:Glossary.Code.WebHome]] such that it has multiple parents within the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. Further, the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] may or may not be a (% style="color:#e74c3c" %)leveled(%%) one. | ||
| 2715 | |||
| 2716 | Derivation: | ||
| 2717 | //com:AnnotableType// (extension) | ||
| 2718 | //IdentifiableType// (restriction) | ||
| 2719 | //HierarchicalCodeBaseType// (extension) | ||
| 2720 | HierarchicalCodeType | ||
| 2721 | |||
| 2722 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2723 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo? | ||
| 2724 | |||
| 2725 | Content: | ||
| 2726 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ([[Code>>doc:sdmx:Glossary.Code.WebHome]] | (CodelistAliasRef, CodeID)), HierarchicalCode*, (% style="color:#e74c3c" %)Level(%%)? | ||
| 2727 | |||
| 2728 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2729 | |||
| 2730 | |**Name**|**Type**|**Documentation** | ||
| 2731 | |id|com:IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] allows for an id to be assigned to the use of the particular [[code>>doc:sdmx:Glossary.Code.WebHome]] at that specific point in the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. This value is unique within the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] being created, and is used to (% style="color:#e74c3c" %)map(%%) the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] against external structures. | ||
| 2732 | |urn|xs:anyURI|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). | ||
| 2733 | |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. | ||
| 2734 | |(%%)(% style="color:#e74c3c" %)version|com:VersionType|The (% style="color:#e74c3c" %)version(%%) attriubte contains a (% style="color:#e74c3c" %)version(%%) number for the [[hierarchical code>>doc:sdmx:Glossary.Hierarchical code.WebHome]]. A [[hierarchical code>>doc:sdmx:Glossary.Hierarchical code.WebHome]] is not formally versionable, therefore each [[code>>doc:sdmx:Glossary.Code.WebHome]] must have a unique identifier. The (% style="color:#e74c3c" %)version(%%) supplied here is for informational purposes only and is not used to uniquely identity the [[code>>doc:sdmx:Glossary.Code.WebHome]]. | ||
| 2735 | |validFrom|xs:dateTime|The validFrom attriubte indicates the point in time in which the hiearchical [[code>>doc:sdmx:Glossary.Code.WebHome]] became effective. This can be used to track the historicity of [[codes>>doc:sdmx:Glossary.Code.WebHome]] changing over time. | ||
| 2736 | |validTo|xs:dateTime|The validTo attriubte indicates the point in time in which the hiearchical [[code>>doc:sdmx:Glossary.Code.WebHome]] became no longer effective. This can be used to track the historicity of [[codes>>doc:sdmx:Glossary.Code.WebHome]] changing over time. | ||
| 2737 | |||
| 2738 | Element Documentation: | ||
| 2739 | |||
| 2740 | |**Name**|**Type**|**Documentation** | ||
| 2741 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2742 | |[[Code>>doc:sdmx:Glossary.Code.WebHome]]|com: CodeReferenceType|[[Code>>doc:sdmx:Glossary.Code.WebHome]] provides a complete, explicit reference to a [[code>>doc:sdmx:Glossary.Code.WebHome]] through either its URN, or a complete reference to the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] and [[code>>doc:sdmx:Glossary.Code.WebHome]]. | ||
| 2743 | |CodelistAliasRef|com:IDType|CodelistAliasRef references an alias assigned in a IncludedCodelistReference element in the containing hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. This is used in conjunction with the CodeID element to reference a [[code>>doc:sdmx:Glossary.Code.WebHome]] from one of the included codelists. | ||
| 2744 | |CodeID|com: LocalCodeReferenceTy pe|CodeID references the id of a [[code>>doc:sdmx:Glossary.Code.WebHome]] from the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] that is referenced through the CodelistAliaRef element. | ||
| 2745 | |HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to nest referenced [[codes>>doc:sdmx:Glossary.Code.WebHome]] into a value based [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. | ||
| 2746 | |(%%)(% style="color:#e74c3c" %)Level|com: LocalLevelReferenceT ype|(%%)(% style="color:#e74c3c" %)Level(%%) references a formal (% style="color:#e74c3c" %)level(%%) defined within the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] which defines this [[hierarchical code>>doc:sdmx:Glossary.Hierarchical code.WebHome]]. This is only necessary if the nesting depth of the [[hierarchical code>>doc:sdmx:Glossary.Hierarchical code.WebHome]] does not correspond to the nesting depth of the (% style="color:#e74c3c" %)level(%%) to which it belongs (i.e. the hieararchical [[code>>doc:sdmx:Glossary.Code.WebHome]] is to skip down a (% style="color:#e74c3c" %)level(%%)). Otherwise, the [[code>>doc:sdmx:Glossary.Code.WebHome]] is assumed to exist at the (% style="color:#e74c3c" %)level(%%) in which the nesting depth of the (% style="color:#e74c3c" %)level(%%) matches the nesting depth of the [[code>>doc:sdmx:Glossary.Code.WebHome]]. | ||
| 2747 | |||
| 2748 | //**LevelBaseType**//**: **LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id. | ||
| 2749 | |||
| 2750 | Derivation: | ||
| 2751 | //com:AnnotableType// (extension) | ||
| 2752 | //IdentifiableType// (extension) | ||
| 2753 | //NameableType// (restriction) | ||
| 2754 | //LevelBaseType// | ||
| 2755 | |||
| 2756 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2757 | id, urn?, uri? | ||
| 2758 | |||
| 2759 | Content: | ||
| 2760 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 2761 | |||
| 2762 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2763 | |||
| 2764 | |**Name**|**Type**|**Documentation** | ||
| 2765 | |id|com:IDType|The id is the identifier for the object. | ||
| 2766 | |urn|xs:anyURI|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). | ||
| 2767 | |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. | ||
| 2768 | |||
| 2769 | Element Documentation: | ||
| 2770 | |||
| 2771 | |**Name**|**Type**|**Documentation** | ||
| 2772 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2773 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2774 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2775 | |||
| 2776 | **LevelType: **LevelType describes a (% style="color:#e74c3c" %)level(%%) in a hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. Where (% style="color:#e74c3c" %)level(%%) is defined as a group where [[codes>>doc:sdmx:Glossary.Code.WebHome]] can be characterised by homogeneous coding, and where the parent of each [[code>>doc:sdmx:Glossary.Code.WebHome]] in the group is at the same higher (% style="color:#e74c3c" %)level(%%) of the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. | ||
| 2777 | |||
| 2778 | Derivation: | ||
| 2779 | //com:AnnotableType// (extension) | ||
| 2780 | //IdentifiableType// (extension) | ||
| 2781 | //NameableType// (restriction) | ||
| 2782 | //LevelBaseType// (extension) | ||
| 2783 | LevelType | ||
| 2784 | |||
| 2785 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2786 | id, urn?, uri? | ||
| 2787 | |||
| 2788 | Content: | ||
| 2789 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, CodingFormat?, (% style="color:#e74c3c" %)Level(%%)? | ||
| 2790 | |||
| 2791 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2792 | |||
| 2793 | |**Name**|**Type**|**Documentation** | ||
| 2794 | |id|com:IDType|The id is the identifier for the object. | ||
| 2795 | |urn|xs:anyURI|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). | ||
| 2796 | |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. | ||
| 2797 | |||
| 2798 | Element Documentation: | ||
| 2799 | |||
| 2800 | |**Name**|**Type**|**Documentation** | ||
| 2801 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2802 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2803 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2804 | |CodingFormat|CodingTextFormatType|CodingFormat specifies the text formatting of the [[codes>>doc:sdmx:Glossary.Code.WebHome]] in this (% style="color:#e74c3c" %)level(%%). This includes [[facets>>doc:sdmx:Glossary.Facet.WebHome]] such as the expected characters and the length of the [[codes>>doc:sdmx:Glossary.Code.WebHome]]. | ||
| 2805 | |(%%)(% style="color:#e74c3c" %)Level|LevelType|(%%)(% style="color:#e74c3c" %)Level(%%) describes the next (% style="color:#e74c3c" %)level(%%) down in the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. | ||
| 2806 | |||
| 2807 | **IncludedCodelistReferenceType: **IncludedCodelistReferenceType provides the structure for a referencing a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] and optionally providing a local alias identification for this reference. | ||
| 2808 | |||
| 2809 | Derivation: | ||
| 2810 | //com:ReferenceType// (restriction) | ||
| 2811 | //com:MaintainableReferenceBaseType// (restriction) | ||
| 2812 | //com:ItemSchemeReferenceBaseType// (restriction) | ||
| 2813 | com:CodelistReferenceType (extension) | ||
| 2814 | IncludedCodelistReferenceType | ||
| 2815 | |||
| 2816 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2817 | alias? | ||
| 2818 | |||
| 2819 | Content: | ||
| 2820 | ( (Ref, URN?) | URN) | ||
| 2821 | |||
| 2822 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2823 | |||
| 2824 | |**Name**|**Type**|**Documentation** | ||
| 2825 | |alias|com:IDType|The alias [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to carry the identifier for the referenced [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], so that [[codes>>doc:sdmx:Glossary.Code.WebHome]] from that list can be easily referenced by the [[hierarchical codes>>doc:sdmx:Glossary.Hierarchical code.WebHome]] contained in the parent [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], without having to repeat the reference to the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] itself. The alias [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must be unique within the parent hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 2826 | |||
| 2827 | Element Documentation: | ||
| 2828 | |||
| 2829 | |**Name**|**Type**|**Documentation** | ||
| 2830 | |Ref|com:CodelistRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference. | ||
| 2831 | |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element. | ||
| 2832 | |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element. | ||
| 2833 | |||
| 2834 | **CodingTextFormatType:** | ||
| 2835 | |||
| 2836 | Derivation: | ||
| 2837 | TextFormatType (restriction) | ||
| 2838 | BasicComponentTextFormatType (restriction) | ||
| 2839 | SimpleComponentTextFormatType (restriction) | ||
| 2840 | CodingTextFormatType | ||
| 2841 | |||
| 2842 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2843 | textType?, isSequence?, interval?, startValue?, endValue?, minLength?, maxLength?, minValue?, maxValue?, pattern? | ||
| 2844 | |||
| 2845 | Content: | ||
| 2846 | {Empty} | ||
| 2847 | |||
| 2848 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2849 | |||
| 2850 | |**Name**|**Type**|**Documentation** | ||
| 2851 | |textType|SimpleCodeDataType|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]]. | ||
| 2852 | |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. | ||
| 2853 | |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. | ||
| 2854 | |startValue|xs:positiveInteger|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. | ||
| 2855 | |endValue|xs:positiveInteger|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. | ||
| 2856 | |minLength|xs:positiveInteger|The minLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the minimum and length of the value in characters. | ||
| 2857 | |maxLength|xs:positiveInteger|The maxLength [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the maximum length of the value in characters. | ||
| 2858 | |minValue|xs:positiveInteger|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. | ||
| 2859 | |maxValue|xs:positiveInteger|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. | ||
| 2860 | |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. | ||
| 2861 | |||
| 2862 | **MetadataflowType: **MetadataflowType describes the structure of a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]]. A [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] 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]]. If this type is not referenced externally, then a reference to a [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] must be provided | ||
| 2863 | |||
| 2864 | Derivation: | ||
| 2865 | //com:AnnotableType// (extension) | ||
| 2866 | //IdentifiableType// (extension) | ||
| 2867 | //NameableType// (extension) | ||
| 2868 | //VersionableType// (restriction) | ||
| 2869 | //MaintainableBaseType// (extension) | ||
| 2870 | //MaintainableType// (extension) | ||
| 2871 | //StructureUsageType// (restriction) | ||
| 2872 | MetadataflowType | ||
| 2873 | |||
| 2874 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2875 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 2876 | |||
| 2877 | Content: | ||
| 2878 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Structure? | ||
| 2879 | |||
| 2880 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2881 | |||
| 2882 | |**Name**|**Type**|**Documentation** | ||
| 2883 | |id|com:IDType|The id is the identifier for the object. | ||
| 2884 | |urn|xs:anyURI|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). | ||
| 2885 | |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. | ||
| 2886 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 2887 | |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(%%). | ||
| 2888 | |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(%%). | ||
| 2889 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 2890 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 2891 | |[[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. | ||
| 2892 | |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. | ||
| 2893 | |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. | ||
| 2894 | |||
| 2895 | Element Documentation: | ||
| 2896 | |||
| 2897 | |**Name**|**Type**|**Documentation** | ||
| 2898 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2899 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2900 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2901 | |Structure|com: MetadataStructureRef erenceType|Structure provides a reference to the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] describing the structure of all [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] for this flow. | ||
| 2902 | |||
| 2903 | **MetadataStructureType: **MetadataStructureType is used to describe 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]]. | ||
| 2904 | |||
| 2905 | Derivation: | ||
| 2906 | //com:AnnotableType// (extension) | ||
| 2907 | //IdentifiableType// (extension) | ||
| 2908 | //NameableType// (extension) | ||
| 2909 | //VersionableType// (restriction) | ||
| 2910 | //MaintainableBaseType// (extension) | ||
| 2911 | //MaintainableType// (extension) | ||
| 2912 | //StructureType// (restriction) | ||
| 2913 | MetadataStructureType | ||
| 2914 | |||
| 2915 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2916 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 2917 | |||
| 2918 | Content: | ||
| 2919 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, MetadataStructureComponents? | ||
| 2920 | |||
| 2921 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2922 | |||
| 2923 | |**Name**|**Type**|**Documentation** | ||
| 2924 | |id|com:IDType|The id is the identifier for the object. | ||
| 2925 | |urn|xs:anyURI|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). | ||
| 2926 | |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. | ||
| 2927 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 2928 | |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(%%). | ||
| 2929 | |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(%%). | ||
| 2930 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 2931 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 2932 | |[[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. | ||
| 2933 | |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. | ||
| 2934 | |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. | ||
| 2935 | |||
| 2936 | Element Documentation: | ||
| 2937 | |||
| 2938 | |**Name**|**Type**|**Documentation** | ||
| 2939 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2940 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2941 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 2942 | |MetadataStructureCom ponents|MetadataStructureCom ponentsType|MetadataStructureComponents defines the grouping of the sets of the [[components>>doc:sdmx:Glossary.Component.WebHome]] that make up the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. All [[components>>doc:sdmx:Glossary.Component.WebHome]] and [[component>>doc:sdmx:Glossary.Component.WebHome]] list (target identifiers, identifier [[components>>doc:sdmx:Glossary.Component.WebHome]], report structures, and metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) in the structure definition must have a unique identification. | ||
| 2943 | |||
| 2944 | **MetadataStructureComponentsBaseType: **MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType. | ||
| 2945 | |||
| 2946 | Derivation: | ||
| 2947 | //GroupingType// (restriction) | ||
| 2948 | MetadataStructureComponentsBaseType | ||
| 2949 | |||
| 2950 | Content: | ||
| 2951 | {Empty} | ||
| 2952 | |||
| 2953 | **MetadataStructureComponentsType: **MetadataStructureComponentsType describes the structure of the grouping of the sets of the [[components>>doc:sdmx:Glossary.Component.WebHome]] that make up the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. At a minimum, a full target identifier and at least one report structure must be defined. | ||
| 2954 | |||
| 2955 | Derivation: | ||
| 2956 | //GroupingType// (restriction) | ||
| 2957 | MetadataStructureComponentsBaseType (extension) | ||
| 2958 | MetadataStructureComponentsType | ||
| 2959 | |||
| 2960 | Content: | ||
| 2961 | MetadataTarget+, ReportStructure+ | ||
| 2962 | |||
| 2963 | Element Documentation: | ||
| 2964 | |||
| 2965 | |**Name**|**Type**|**Documentation** | ||
| 2966 | |MetadataTarget|MetadataTargetType|MetadataTarget is a collection of target objects which when taken together describe a structure which defines the key of an object type to which metadata may be attached and serve to disambiguate [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] set reports. | ||
| 2967 | |ReportStructure|ReportStructureType|ReportStructure defines a report structure, which comprises a 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 report 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. | ||
| 2968 | |||
| 2969 | //**MetadataTargetBaseType**//**: **MetadataTargetBaseType is an abstract base type which forms the basis for the MetadataTargetType. | ||
| 2970 | |||
| 2971 | Derivation: | ||
| 2972 | //com:AnnotableType// (extension) | ||
| 2973 | //IdentifiableType// (extension) | ||
| 2974 | //ComponentListType// (restriction) | ||
| 2975 | //MetadataTargetBaseType// | ||
| 2976 | |||
| 2977 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 2978 | id, urn?, uri? | ||
| 2979 | |||
| 2980 | Content: | ||
| 2981 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]? | ||
| 2982 | |||
| 2983 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 2984 | |||
| 2985 | |**Name**|**Type**|**Documentation** | ||
| 2986 | |id|com:IDType|The id is the identifier for the object. | ||
| 2987 | |urn|xs:anyURI|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). | ||
| 2988 | |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. | ||
| 2989 | |||
| 2990 | Element Documentation: | ||
| 2991 | |||
| 2992 | |**Name**|**Type**|**Documentation** | ||
| 2993 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 2994 | |||
| 2995 | **MetadataTargetType:** | ||
| 2996 | |||
| 2997 | Derivation: | ||
| 2998 | //com:AnnotableType// (extension) | ||
| 2999 | //IdentifiableType// (extension) | ||
| 3000 | //ComponentListType// (restriction) | ||
| 3001 | //MetadataTargetBaseType// (extension) | ||
| 3002 | MetadataTargetType | ||
| 3003 | |||
| 3004 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3005 | id, urn?, uri? | ||
| 3006 | |||
| 3007 | Content: | ||
| 3008 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, (KeyDescriptorValuesTarget | DataSetTarget | ConstraintContentTarget | ReportPeriodTarget | IdentifiableObjectTarget)+ | ||
| 3009 | |||
| 3010 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3011 | |||
| 3012 | |**Name**|**Type**|**Documentation** | ||
| 3013 | |id|com:IDType|The id is the identifier for the object. | ||
| 3014 | |urn|xs:anyURI|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). | ||
| 3015 | |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. | ||
| 3016 | |||
| 3017 | Element Documentation: | ||
| 3018 | |||
| 3019 | |**Name**|**Type**|**Documentation** | ||
| 3020 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3021 | |KeyDescriptorValuesT arget|KeyDescriptorValuesT argetType|KeyDescriptorValuesTarget is target object which references a data key for the purpose of attach [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] to portions of data. A data key is a set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] references and values for those [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This [[component>>doc:sdmx:Glossary.Component.WebHome]] on its own is not of much use, as the data key only has local references to the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]. Therefore it is typical that this is used in combination with some sort of reference to the data (either a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] reference or a reference to the underlying structure, structure usage, or [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] of the data. | ||
| 3022 | |DataSetTarget|DataSetTargetType|DataSetTarget is target object which references a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] for the purpose of attaching [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] data. A [[data set>>doc:sdmx:Glossary.Data set.WebHome]] reference is a full reference to a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] and an identifier for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. | ||
| 3023 | |ConstraintContentTar get|ConstraintContentTar getType|ConstraintContentTarget is target object which references an attachment (% style="color:#e74c3c" %)constraint(%%) for the purpose of attaching [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] data to data key sets or cube regions defined by the (% style="color:#e74c3c" %)constraint(%%). | ||
| 3024 | |ReportPeriodTarget|ReportPeriodTargetTy pe|ReportPeriodTarget is target object which specifies a reporting period to which a metadata report applies. | ||
| 3025 | |IdentifiableObjectTa rget|IdentifiableObjectTa rgetType|IdentifiableObjectTarget is target object which references an Identifiable object as defined in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. The reference must be complete (i.e. a URN or a complete set of reference fields). For an item object, it is possible to define a local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] from which the item must be referenced. | ||
| 3026 | |||
| 3027 | //**TargetObject**//**: **TargetObject is an abstract base type from which all target objects of a metadata target are derived. It is based on a [[component>>doc:sdmx:Glossary.Component.WebHome]]. Implementations of this will refined the local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] so that the allowed values accurately reflect the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target object reference. | ||
| 3028 | |||
| 3029 | Derivation: | ||
| 3030 | //com:AnnotableType// (extension) | ||
| 3031 | //IdentifiableType// (restriction) | ||
| 3032 | //ComponentBaseType// (extension) | ||
| 3033 | //ComponentType// (extension) | ||
| 3034 | //TargetObject// | ||
| 3035 | |||
| 3036 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3037 | id?, urn?, uri? | ||
| 3038 | |||
| 3039 | Content: | ||
| 3040 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity?, LocalRepresentation? | ||
| 3041 | |||
| 3042 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3043 | |||
| 3044 | |**Name**|**Type**|**Documentation** | ||
| 3045 | |id|com: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). | ||
| 3046 | |urn|xs:anyURI|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). | ||
| 3047 | |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. | ||
| 3048 | |||
| 3049 | Element Documentation: | ||
| 3050 | |||
| 3051 | |**Name**|**Type**|**Documentation** | ||
| 3052 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3053 | |ConceptIdentity|com: 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]]. | ||
| 3054 | |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. | ||
| 3055 | |||
| 3056 | **KeyDescriptorValuesTargetType: **KeyDescriptorValuesTargetType defines the structure of a key descriptor values target object. The key descriptor values target object has a fixed [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and identifier. | ||
| 3057 | |||
| 3058 | Derivation: | ||
| 3059 | //com:AnnotableType// (extension) | ||
| 3060 | //IdentifiableType// (restriction) | ||
| 3061 | //ComponentBaseType// (extension) | ||
| 3062 | //ComponentType// (extension) | ||
| 3063 | //TargetObject// (restriction) | ||
| 3064 | KeyDescriptorValuesTargetType | ||
| 3065 | |||
| 3066 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3067 | id?, urn?, uri? | ||
| 3068 | |||
| 3069 | Content: | ||
| 3070 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, LocalRepresentation | ||
| 3071 | |||
| 3072 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3073 | |||
| 3074 | |**Name**|**Type**|**Documentation** | ||
| 3075 | |id (fixed: DIMENSION_DESCRIPTOR_VALUES_TARGET)|com: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). | ||
| 3076 | |urn|xs:anyURI|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). | ||
| 3077 | |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. | ||
| 3078 | |||
| 3079 | Element Documentation: | ||
| 3080 | |||
| 3081 | |**Name**|**Type**|**Documentation** | ||
| 3082 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3083 | |LocalRepresentation|KeyDescriptorValuesR epresentationType|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. | ||
| 3084 | |||
| 3085 | **DataSetTargetType: **DataSetTargetType defines the structure of a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] target object. The [[data set>>doc:sdmx:Glossary.Data set.WebHome]] target object has a fixed [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and identifier. | ||
| 3086 | |||
| 3087 | Derivation: | ||
| 3088 | //com:AnnotableType// (extension) | ||
| 3089 | //IdentifiableType// (restriction) | ||
| 3090 | //ComponentBaseType// (extension) | ||
| 3091 | //ComponentType// (extension) | ||
| 3092 | //TargetObject// (restriction) | ||
| 3093 | DataSetTargetType | ||
| 3094 | |||
| 3095 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3096 | id?, urn?, uri? | ||
| 3097 | |||
| 3098 | Content: | ||
| 3099 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, LocalRepresentation | ||
| 3100 | |||
| 3101 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3102 | |||
| 3103 | |**Name**|**Type**|**Documentation** | ||
| 3104 | |id (fixed: DATA_SET_TARGET)|com: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). | ||
| 3105 | |urn|xs:anyURI|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). | ||
| 3106 | |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. | ||
| 3107 | |||
| 3108 | Element Documentation: | ||
| 3109 | |||
| 3110 | |**Name**|**Type**|**Documentation** | ||
| 3111 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3112 | |LocalRepresentation|DataSetRepresentatio nType|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. | ||
| 3113 | |||
| 3114 | **ConstraintContentTargetType: **ConstraintTargetType defines the structure of a (% style="color:#e74c3c" %)constraint(%%) target object. The (% style="color:#e74c3c" %)constraint(%%) target object has a fixed [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and identifier. | ||
| 3115 | |||
| 3116 | Derivation: | ||
| 3117 | //com:AnnotableType// (extension) | ||
| 3118 | //IdentifiableType// (restriction) | ||
| 3119 | //ComponentBaseType// (extension) | ||
| 3120 | //ComponentType// (extension) | ||
| 3121 | //TargetObject// (restriction) | ||
| 3122 | ConstraintContentTargetType | ||
| 3123 | |||
| 3124 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3125 | id?, urn?, uri? | ||
| 3126 | |||
| 3127 | Content: | ||
| 3128 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, LocalRepresentation | ||
| 3129 | |||
| 3130 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3131 | |||
| 3132 | |**Name**|**Type**|**Documentation** | ||
| 3133 | |id (fixed: CONSTRAINT_CONTENT_TARGET)|com: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). | ||
| 3134 | |urn|xs:anyURI|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). | ||
| 3135 | |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. | ||
| 3136 | |||
| 3137 | Element Documentation: | ||
| 3138 | |||
| 3139 | |**Name**|**Type**|**Documentation** | ||
| 3140 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3141 | |LocalRepresentation|ConstraintRepresenta tionType|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. | ||
| 3142 | |||
| 3143 | **ReportPeriodTargetType: **ReportPeriodTargetType defines the structure of a report period target object. The report period target object has a fixed [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and identifier. | ||
| 3144 | |||
| 3145 | Derivation: | ||
| 3146 | //com:AnnotableType// (extension) | ||
| 3147 | //IdentifiableType// (restriction) | ||
| 3148 | //ComponentBaseType// (extension) | ||
| 3149 | //ComponentType// (extension) | ||
| 3150 | //TargetObject// (restriction) | ||
| 3151 | ReportPeriodTargetType | ||
| 3152 | |||
| 3153 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3154 | id?, urn?, uri? | ||
| 3155 | |||
| 3156 | Content: | ||
| 3157 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, LocalRepresentation | ||
| 3158 | |||
| 3159 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3160 | |||
| 3161 | |**Name**|**Type**|**Documentation** | ||
| 3162 | |id (fixed: REPORT_PERIOD_TARGET)|com: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). | ||
| 3163 | |urn|xs:anyURI|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). | ||
| 3164 | |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. | ||
| 3165 | |||
| 3166 | Element Documentation: | ||
| 3167 | |||
| 3168 | |**Name**|**Type**|**Documentation** | ||
| 3169 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3170 | |LocalRepresentation|ReportPeriodRepresen tationType|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. | ||
| 3171 | |||
| 3172 | //**IdentifiableObjectTargetBaseType**//**: **IdentifiableObjectTargetBaseType is an abstract base type which forms the basis for the IdentifiableObjectTargetType. | ||
| 3173 | |||
| 3174 | Derivation: | ||
| 3175 | //com:AnnotableType// (extension) | ||
| 3176 | //IdentifiableType// (restriction) | ||
| 3177 | //ComponentBaseType// (extension) | ||
| 3178 | //ComponentType// (extension) | ||
| 3179 | //TargetObject// (restriction) | ||
| 3180 | //IdentifiableObjectTargetBaseType// | ||
| 3181 | |||
| 3182 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3183 | id, urn?, uri? | ||
| 3184 | |||
| 3185 | Content: | ||
| 3186 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, LocalRepresentation | ||
| 3187 | |||
| 3188 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3189 | |||
| 3190 | |**Name**|**Type**|**Documentation** | ||
| 3191 | |id|com: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). | ||
| 3192 | |urn|xs:anyURI|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). | ||
| 3193 | |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. | ||
| 3194 | |||
| 3195 | Element Documentation: | ||
| 3196 | |||
| 3197 | |**Name**|**Type**|**Documentation** | ||
| 3198 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3199 | |LocalRepresentation|IdentifiableObjectRe presentationType|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. | ||
| 3200 | |||
| 3201 | **IdentifiableObjectTargetType: **IdentifiableObjectTargetType defines the structure of an identifiable target object. The identifiable target object has a fixed [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a reference and can specify a local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of any [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] for the purpose of restricting which items may be referenced. The identifiable object target must specify the object type which the target object is meant to reference. | ||
| 3202 | |||
| 3203 | Derivation: | ||
| 3204 | //com:AnnotableType// (extension) | ||
| 3205 | //IdentifiableType// (restriction) | ||
| 3206 | //ComponentBaseType// (extension) | ||
| 3207 | //ComponentType// (extension) | ||
| 3208 | //TargetObject// (restriction) | ||
| 3209 | //IdentifiableObjectTargetBaseType// (extension) | ||
| 3210 | IdentifiableObjectTargetType | ||
| 3211 | |||
| 3212 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3213 | id, urn?, uri?, objectType | ||
| 3214 | |||
| 3215 | Content: | ||
| 3216 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, LocalRepresentation | ||
| 3217 | |||
| 3218 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3219 | |||
| 3220 | |**Name**|**Type**|**Documentation** | ||
| 3221 | |id|com: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). | ||
| 3222 | |urn|xs:anyURI|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). | ||
| 3223 | |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. | ||
| 3224 | |objectType|com: ObjectTypeCodelistTy pe| | ||
| 3225 | |||
| 3226 | Element Documentation: | ||
| 3227 | |||
| 3228 | |**Name**|**Type**|**Documentation** | ||
| 3229 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3230 | |LocalRepresentation|IdentifiableObjectRe presentationType|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. | ||
| 3231 | |||
| 3232 | //**ReportStructureBaseType**//**: **ReportStructureBaseType is an abstract base type that serves as the basis for the ReportStructureType. | ||
| 3233 | |||
| 3234 | Derivation: | ||
| 3235 | //com:AnnotableType// (extension) | ||
| 3236 | //IdentifiableType// (extension) | ||
| 3237 | //ComponentListType// (restriction) | ||
| 3238 | //ReportStructureBaseType// | ||
| 3239 | |||
| 3240 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3241 | id, urn?, uri? | ||
| 3242 | |||
| 3243 | Content: | ||
| 3244 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, MetadataAttribute+ | ||
| 3245 | |||
| 3246 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3247 | |||
| 3248 | |**Name**|**Type**|**Documentation** | ||
| 3249 | |id|com:IDType|The id is the identifier for the object. | ||
| 3250 | |urn|xs:anyURI|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). | ||
| 3251 | |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. | ||
| 3252 | |||
| 3253 | Element Documentation: | ||
| 3254 | |||
| 3255 | |**Name**|**Type**|**Documentation** | ||
| 3256 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3257 | |MetadataAttribute|MetadataAttributeTyp e|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>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. | ||
| 3258 | |||
| 3259 | **ReportStructureType: **ReportStructureType describes the structure of a report structure. It comprises a set of metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that can be defined as a [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], and identifies the potential attachment of these [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] to an object by referencing a target identifier. | ||
| 3260 | |||
| 3261 | Derivation: | ||
| 3262 | |||
| 3263 | //com:AnnotableType// (extension) | ||
| 3264 | //IdentifiableType// (extension) | ||
| 3265 | //ComponentListType// (restriction) | ||
| 3266 | //ReportStructureBaseType// (extension) | ||
| 3267 | ReportStructureType | ||
| 3268 | |||
| 3269 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3270 | id, urn?, uri? | ||
| 3271 | |||
| 3272 | Content: | ||
| 3273 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, MetadataAttribute+, MetadataTarget+ | ||
| 3274 | |||
| 3275 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3276 | |||
| 3277 | |**Name**|**Type**|**Documentation** | ||
| 3278 | |id|com:IDType|The id is the identifier for the object. | ||
| 3279 | |urn|xs:anyURI|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). | ||
| 3280 | |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. | ||
| 3281 | |||
| 3282 | Element Documentation: | ||
| 3283 | |||
| 3284 | |**Name**|**Type**|**Documentation** | ||
| 3285 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3286 | |MetadataAttribute|MetadataAttributeTyp e|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>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. | ||
| 3287 | |MetadataTarget|com: LocalMetadataTargetR eferenceType|MetadataTarget references a metadata target defined in the [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. A report structure can reference multiple metadata targets which allows a report structure to be reused for attaching metadata to different types of targets. | ||
| 3288 | |||
| 3289 | //**MetadataAttributeBaseType**//**: **MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType. | ||
| 3290 | |||
| 3291 | Derivation: | ||
| 3292 | //com:AnnotableType// (extension) | ||
| 3293 | //IdentifiableType// (restriction) | ||
| 3294 | //ComponentBaseType// (extension) | ||
| 3295 | //ComponentType// (restriction) | ||
| 3296 | //MetadataAttributeBaseType// | ||
| 3297 | |||
| 3298 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3299 | id?, urn?, uri? | ||
| 3300 | |||
| 3301 | Content: | ||
| 3302 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation? | ||
| 3303 | |||
| 3304 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3305 | |||
| 3306 | |**Name**|**Type**|**Documentation** | ||
| 3307 | |id|com: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). | ||
| 3308 | |urn|xs:anyURI|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). | ||
| 3309 | |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. | ||
| 3310 | |||
| 3311 | Element Documentation: | ||
| 3312 | |||
| 3313 | |**Name**|**Type**|**Documentation** | ||
| 3314 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3315 | |ConceptIdentity|com: 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]]. | ||
| 3316 | |LocalRepresentation|MetadataAttributeRep resentationType|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. | ||
| 3317 | |||
| 3318 | **MetadataAttributeType: **MetadataAttributeType describes the structure of a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. The metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] takes its semantic, and in some cases it [[representation>>doc:sdmx:Glossary.Representation.WebHome]], from its (% style="color:#e74c3c" %)concept(%%) identity. A metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] may be coded (via the local [[representation>>doc:sdmx:Glossary.Representation.WebHome]]), uncoded (via the text format), or take no value. In addition to this value, the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] may also specify subordinate metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. If a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] only serves the purpose of containing subordinate metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], then the isPresentational [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be used. Otherwise, it is assumed to also take a value. If the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does take a value, and a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is not defined, it will be inherited from the (% style="color:#e74c3c" %)concept(%%) it takes its semantic from. The optional id on the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] uniquely identifies it within the [[metadata structured definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. If this id is not supplied, its value is assumed to be that of the (% style="color:#e74c3c" %)concept(%%) referenced from the (% style="color:#e74c3c" %)concept(%%) identity. Note that a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] (as identified by the id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) definition must be unique across the entire [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] (including target identifier, identifier [[component>>doc:sdmx:Glossary.Component.WebHome]], and report structure ids). A metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] may be used in multiple report structures and at different (% style="color:#e74c3c" %)levels(%%), but the content (value and/or child metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] and their cardinality) of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] cannot change. | ||
| 3319 | |||
| 3320 | Derivation: | ||
| 3321 | //com:AnnotableType// (extension) | ||
| 3322 | //IdentifiableType// (restriction) | ||
| 3323 | //ComponentBaseType// (extension) | ||
| 3324 | //ComponentType// (restriction) | ||
| 3325 | //MetadataAttributeBaseType// (extension) | ||
| 3326 | MetadataAttributeType | ||
| 3327 | |||
| 3328 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3329 | id?, urn?, uri?, minOccurs?, maxOccurs?, isPresentational? | ||
| 3330 | |||
| 3331 | Content: | ||
| 3332 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ConceptIdentity, LocalRepresentation?, MetadataAttribute* | ||
| 3333 | |||
| 3334 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3335 | |||
| 3336 | |**Name**|**Type**|**Documentation** | ||
| 3337 | |id|com: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). | ||
| 3338 | |urn|xs:anyURI|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). | ||
| 3339 | |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. | ||
| 3340 | |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the minimum number of times this metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can occur within its parent object. | ||
| 3341 | |maxOccurs (default: 1)|com:OccurenceType|The maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the maximum number of times this metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can occur within its parent object. | ||
| 3342 | |isPresentational (default: false)|xs:boolean|The isPresentational [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should allow for a value. A value of true, meaning the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is presentational means that the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] only contains child metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], and does not contain a value. If this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set to true, and a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (coded or uncoded) is not defined, then the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will be inherited from the (% style="color:#e74c3c" %)concept(%%) from which it takes its identity. | ||
| 3343 | |||
| 3344 | Element Documentation: | ||
| 3345 | |||
| 3346 | |**Name**|**Type**|**Documentation** | ||
| 3347 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3348 | |ConceptIdentity|com: 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]]. | ||
| 3349 | |LocalRepresentation|MetadataAttributeRep resentationType|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. | ||
| 3350 | |MetadataAttribute|MetadataAttributeTyp e|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>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. | ||
| 3351 | |||
| 3352 | **KeyDescriptorValuesRepresentationType: **KeyDescriptorValuesRepresentationType defines the possible local [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of a key descriptor values target object. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is fixed to always be a data key (KeyValues). | ||
| 3353 | |||
| 3354 | Derivation: | ||
| 3355 | //RepresentationType// (restriction) | ||
| 3356 | KeyDescriptorValuesRepresentationType | ||
| 3357 | |||
| 3358 | Content: | ||
| 3359 | TextFormat | ||
| 3360 | |||
| 3361 | Element Documentation: | ||
| 3362 | |||
| 3363 | |**Name**|**Type**|**Documentation** | ||
| 3364 | |TextFormat|KeyDescriptorValuesT extFormatType|TextFormat describes an uncoded textual format. | ||
| 3365 | |||
| 3366 | **DataSetRepresentationType: **DataSetRepresentationType defines the possible local [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] reference target object. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is fixed to always be a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] reference. | ||
| 3367 | |||
| 3368 | Derivation: | ||
| 3369 | //RepresentationType// (restriction) | ||
| 3370 | DataSetRepresentationType | ||
| 3371 | |||
| 3372 | Content: | ||
| 3373 | TextFormat | ||
| 3374 | |||
| 3375 | Element Documentation: | ||
| 3376 | |||
| 3377 | |**Name**|**Type**|**Documentation** | ||
| 3378 | |TextFormat|DataSetTextFormatTyp e|TextFormat describes an uncoded textual format. | ||
| 3379 | |||
| 3380 | **ConstraintRepresentationType: **ConstraintRepresentationType defines the possible local [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of a (% style="color:#e74c3c" %)constraint(%%) reference target object. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is fixed to always be an attachment (% style="color:#e74c3c" %)constraint(%%) reference. | ||
| 3381 | |||
| 3382 | Derivation: | ||
| 3383 | //RepresentationType// (restriction) | ||
| 3384 | ConstraintRepresentationType | ||
| 3385 | |||
| 3386 | Content: | ||
| 3387 | TextFormat | ||
| 3388 | |||
| 3389 | Element Documentation: | ||
| 3390 | |||
| 3391 | |**Name**|**Type**|**Documentation** | ||
| 3392 | |TextFormat|ConstraintTextFormat Type|TextFormat describes an uncoded textual format. | ||
| 3393 | |||
| 3394 | **ReportPeriodRepresentationType: **ReportPeriodRepresentationType defines the possible local [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of a report period target object. The reprentation must be a [[time period>>doc:sdmx:Glossary.Time period.WebHome]] or a subset of this [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 3395 | |||
| 3396 | Derivation: | ||
| 3397 | //RepresentationType// (restriction) | ||
| 3398 | ReportPeriodRepresentationType | ||
| 3399 | |||
| 3400 | Content: | ||
| 3401 | TextFormat | ||
| 3402 | |||
| 3403 | Element Documentation: | ||
| 3404 | |||
| 3405 | |**Name**|**Type**|**Documentation** | ||
| 3406 | |TextFormat|TimeTextFormatType|TextFormat describes an uncoded textual format. | ||
| 3407 | |||
| 3408 | **IdentifiableObjectRepresentationType: **IdentifiableObjectRepresentationType defines the possible local [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of an identifiable object target object. | ||
| 3409 | |||
| 3410 | Derivation: | ||
| 3411 | //RepresentationType// (restriction) | ||
| 3412 | IdentifiableObjectRepresentationType | ||
| 3413 | |||
| 3414 | Content: | ||
| 3415 | (TextFormat | Enumeration) | ||
| 3416 | |||
| 3417 | Element Documentation: | ||
| 3418 | |||
| 3419 | |**Name**|**Type**|**Documentation** | ||
| 3420 | |TextFormat|IdentifiableObjectTe xtFormatType|TextFormat describes an uncoded textual format. | ||
| 3421 | |Enumeration|com: ItemSchemeReferenceT ype|Enumeration is only permissible if the object type of the identifiable object target is an item in an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]. This enumeration is meant to limit the referencable objects to the items defined in the referenced [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]. | ||
| 3422 | |||
| 3423 | **MetadataAttributeRepresentationType: **MetadataAttributeRepresentationType defines the possible local [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of a metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| 3424 | |||
| 3425 | Derivation: | ||
| 3426 | //RepresentationType// (restriction) | ||
| 3427 | MetadataAttributeRepresentationType | ||
| 3428 | |||
| 3429 | Content: | ||
| 3430 | (TextFormat | (Enumeration, EnumerationFormat?)) | ||
| 3431 | |||
| 3432 | Element Documentation: | ||
| 3433 | |||
| 3434 | |**Name**|**Type**|**Documentation** | ||
| 3435 | |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format. | ||
| 3436 | |Enumeration|com: CodelistReferenceTyp e|Enumeration references an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] that enumerates the allowable values for this [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 3437 | |EnumerationFormat|CodededTextFormatTyp e|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. | ||
| 3438 | |||
| 3439 | **TargetObjectTextFormatType: **TargetObjectTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the TextFormatType that does not allow for any [[facets>>doc:sdmx:Glossary.Facet.WebHome]] and only allows the text types for target objects. | ||
| 3440 | |||
| 3441 | Derivation: | ||
| 3442 | TextFormatType (restriction) | ||
| 3443 | TargetObjectTextFormatType | ||
| 3444 | |||
| 3445 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3446 | textType? | ||
| 3447 | |||
| 3448 | Content: | ||
| 3449 | {Empty} | ||
| 3450 | |||
| 3451 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3452 | |||
| 3453 | |**Name**|**Type**|**Documentation** | ||
| 3454 | |textType|TargetObjectDataType|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]]. | ||
| 3455 | |||
| 3456 | **KeyDescriptorValuesTextFormatType: **KeyDescriptorValuesTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the NonFacetedTextFormatType that specifies a fixed KeyValues [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 3457 | |||
| 3458 | Derivation: | ||
| 3459 | TextFormatType (restriction) | ||
| 3460 | TargetObjectTextFormatType (restriction) | ||
| 3461 | KeyDescriptorValuesTextFormatType | ||
| 3462 | |||
| 3463 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3464 | textType? | ||
| 3465 | |||
| 3466 | Content: | ||
| 3467 | {Empty} | ||
| 3468 | |||
| 3469 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3470 | |||
| 3471 | |**Name**|**Type**|**Documentation** | ||
| 3472 | |textType (fixed: KeyValues)|TargetObjectDataType|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]]. | ||
| 3473 | |||
| 3474 | **DataSetTextFormatType: **DataSetTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the NonFacetedTextFormatType that specifies a fixed DataSetReference [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 3475 | |||
| 3476 | Derivation: | ||
| 3477 | TextFormatType (restriction) | ||
| 3478 | TargetObjectTextFormatType (restriction) | ||
| 3479 | DataSetTextFormatType | ||
| 3480 | |||
| 3481 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3482 | textType? | ||
| 3483 | |||
| 3484 | Content: | ||
| 3485 | {Empty} | ||
| 3486 | |||
| 3487 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3488 | |||
| 3489 | |**Name**|**Type**|**Documentation** | ||
| 3490 | |textType (fixed: DataSetReference)|TargetObjectDataType|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]]. | ||
| 3491 | |||
| 3492 | **ConstraintTextFormatType: **ConstraintTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the NonFacetedTextFormatType that specifies a fixed AttachmentConstraintReference [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 3493 | |||
| 3494 | Derivation: | ||
| 3495 | |||
| 3496 | TextFormatType (restriction) | ||
| 3497 | TargetObjectTextFormatType (restriction) | ||
| 3498 | ConstraintTextFormatType | ||
| 3499 | |||
| 3500 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3501 | textType? | ||
| 3502 | |||
| 3503 | Content: | ||
| 3504 | {Empty} | ||
| 3505 | |||
| 3506 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3507 | |||
| 3508 | |**Name**|**Type**|**Documentation** | ||
| 3509 | |textType (fixed: AttachmentConstraintReference)|TargetObjectDataType|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. | ||
| 3510 | |||
| 3511 | **IdentifiableObjectTextFormatType: **IdentifiableObjectTextFormatType is a restricted (% style="color:#e74c3c" %)version(%%) of the NonFacetedTextFormatType that specifies a fixed IdentifiableReference [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. | ||
| 3512 | |||
| 3513 | Derivation: | ||
| 3514 | TextFormatType (restriction) | ||
| 3515 | TargetObjectTextFormatType (restriction) | ||
| 3516 | IdentifiableObjectTextFormatType | ||
| 3517 | |||
| 3518 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3519 | textType? | ||
| 3520 | |||
| 3521 | Content: | ||
| 3522 | {Empty} | ||
| 3523 | |||
| 3524 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3525 | |||
| 3526 | |**Name**|**Type**|**Documentation** | ||
| 3527 | |textType (fixed: IdentifiableReference)|TargetObjectDataType|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. | ||
| 3528 | |||
| 3529 | //**OrganisationSchemeBaseType**//**: **OrganisationSchemeBaseType is an abstract base type for any organisation scheme. | ||
| 3530 | |||
| 3531 | Derivation: | ||
| 3532 | //com:AnnotableType// (extension) | ||
| 3533 | //IdentifiableType// (extension) | ||
| 3534 | //NameableType// (extension) | ||
| 3535 | //VersionableType// (restriction) | ||
| 3536 | //MaintainableBaseType// (extension) | ||
| 3537 | //MaintainableType// (extension) | ||
| 3538 | //ItemSchemeType// (restriction) | ||
| 3539 | //OrganisationSchemeBaseType// | ||
| 3540 | |||
| 3541 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3542 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 3543 | |||
| 3544 | Content: | ||
| 3545 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 3546 | |||
| 3547 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3548 | |||
| 3549 | |**Name**|**Type**|**Documentation** | ||
| 3550 | |id|com:IDType|The id is the identifier for the object. | ||
| 3551 | |urn|xs:anyURI|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). | ||
| 3552 | |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. | ||
| 3553 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 3554 | |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(%%). | ||
| 3555 | |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(%%). | ||
| 3556 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 3557 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 3558 | |[[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. | ||
| 3559 | |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. | ||
| 3560 | |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. | ||
| 3561 | |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 key family in the context of a constraint. | ||
| 3562 | |||
| 3563 | Element Documentation: | ||
| 3564 | |||
| 3565 | |**Name**|**Type**|**Documentation** | ||
| 3566 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3567 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3568 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3569 | |||
| 3570 | //**OrganisationSchemeType**//**: **OrganisationSchemeType describes the structure of an organisation scheme. | ||
| 3571 | |||
| 3572 | Derivation: | ||
| 3573 | //com:AnnotableType// (extension) | ||
| 3574 | //IdentifiableType// (extension) | ||
| 3575 | //NameableType// (extension) | ||
| 3576 | //VersionableType// (restriction) | ||
| 3577 | //MaintainableBaseType// (extension) | ||
| 3578 | //MaintainableType// (extension) | ||
| 3579 | //ItemSchemeType// (restriction) | ||
| 3580 | //OrganisationSchemeBaseType// (extension) | ||
| 3581 | //OrganisationSchemeType// | ||
| 3582 | |||
| 3583 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3584 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 3585 | |||
| 3586 | Content: | ||
| 3587 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, //Organisation*// | ||
| 3588 | |||
| 3589 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3590 | |||
| 3591 | |**Name**|**Type**|**Documentation** | ||
| 3592 | |id|com:IDType|The id is the identifier for the object. | ||
| 3593 | |urn|xs:anyURI|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). | ||
| 3594 | |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. | ||
| 3595 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 3596 | |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(%%). | ||
| 3597 | |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(%%). | ||
| 3598 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 3599 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 3600 | |[[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. | ||
| 3601 | |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. | ||
| 3602 | |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. | ||
| 3603 | |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 key family in the context of a constraint. | ||
| 3604 | |||
| 3605 | Element Documentation: | ||
| 3606 | |||
| 3607 | |**Name**|**Type**|**Documentation** | ||
| 3608 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3609 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3610 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3611 | |//Organisation//|//OrganisationType//|Organisation is an abstract substitution head for a generic organisation. | ||
| 3612 | |||
| 3613 | //**BaseOrganisationType**//**: **BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType. | ||
| 3614 | |||
| 3615 | Derivation: | ||
| 3616 | //com:AnnotableType// (extension) | ||
| 3617 | //IdentifiableType// (extension) | ||
| 3618 | //NameableType// (restriction) | ||
| 3619 | //ItemBaseType// (extension) | ||
| 3620 | //ItemType// (restriction) | ||
| 3621 | //BaseOrganisationType// | ||
| 3622 | |||
| 3623 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3624 | id, urn?, uri? | ||
| 3625 | |||
| 3626 | Content: | ||
| 3627 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Parent? | ||
| 3628 | |||
| 3629 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3630 | |||
| 3631 | |**Name**|**Type**|**Documentation** | ||
| 3632 | |id|com:IDType|The id is the identifier for the object. | ||
| 3633 | |urn|xs:anyURI|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). | ||
| 3634 | |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. | ||
| 3635 | |||
| 3636 | Element Documentation: | ||
| 3637 | |||
| 3638 | |**Name**|**Type**|**Documentation** | ||
| 3639 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3640 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3641 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3642 | |Parent|//com: LocalOrganisationRef erenceBaseType//|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. | ||
| 3643 | |||
| 3644 | //**OrganisationType**//**: **OrganisationType in an abstract type which describes the structure of the details of an organisation. In addition to the basic organisation identification, (% style="color:#e74c3c" %)contact(%%) details can be provided. | ||
| 3645 | |||
| 3646 | Derivation: | ||
| 3647 | //com:AnnotableType// (extension) | ||
| 3648 | //IdentifiableType// (extension) | ||
| 3649 | //NameableType// (restriction) | ||
| 3650 | //ItemBaseType// (extension) | ||
| 3651 | //ItemType// (restriction) | ||
| 3652 | //BaseOrganisationType// (extension) | ||
| 3653 | //OrganisationType// | ||
| 3654 | |||
| 3655 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3656 | id, urn?, uri? | ||
| 3657 | |||
| 3658 | Content: | ||
| 3659 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Parent?, (% style="color:#e74c3c" %)Contact(%%)* | ||
| 3660 | |||
| 3661 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3662 | |||
| 3663 | |**Name**|**Type**|**Documentation** | ||
| 3664 | |id|com:IDType|The id is the identifier for the object. | ||
| 3665 | |urn|xs:anyURI|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). | ||
| 3666 | |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. | ||
| 3667 | |||
| 3668 | Element Documentation: | ||
| 3669 | |||
| 3670 | |**Name**|**Type**|**Documentation** | ||
| 3671 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3672 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3673 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3674 | |Parent|//com: LocalOrganisationRef erenceBaseType//|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. | ||
| 3675 | |(%%)(% style="color:#e74c3c" %)Contact|ContactType|(%%)(% style="color:#e74c3c" %)Contact(%%) describes a (% style="color:#e74c3c" %)contact(%%) for the organisation, | ||
| 3676 | |||
| 3677 | **AgencySchemeType: **AgencySchemeType defines a specific type of organisation scheme which contains only [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]]. The [[agency scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] maintained by a particular [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] is always provided a fixed identifier and (% style="color:#e74c3c" %)version(%%), and is never final. Therefore, agencies can be added or removed without have to (% style="color:#e74c3c" %)version(%%) the scheme. [[Agencies schemes>>doc:sdmx:Glossary.Agency scheme.WebHome]] have no [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], 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. | ||
| 3678 | |||
| 3679 | Derivation: | ||
| 3680 | //com:AnnotableType// (extension) | ||
| 3681 | //IdentifiableType// (extension) | ||
| 3682 | //NameableType// (extension) | ||
| 3683 | //VersionableType// (restriction) | ||
| 3684 | //MaintainableBaseType// (extension) | ||
| 3685 | //MaintainableType// (extension) | ||
| 3686 | //ItemSchemeType// (restriction) | ||
| 3687 | //OrganisationSchemeBaseType// (extension) | ||
| 3688 | //OrganisationSchemeType// (restriction) | ||
| 3689 | AgencySchemeType | ||
| 3690 | |||
| 3691 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3692 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 3693 | |||
| 3694 | Content: | ||
| 3695 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Agency* | ||
| 3696 | |||
| 3697 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3698 | |||
| 3699 | |**Name**|**Type**|**Documentation** | ||
| 3700 | |id (fixed: AGENCIES)|com:IDType|The id is the identifier for the object. | ||
| 3701 | |urn|xs:anyURI|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). | ||
| 3702 | |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. | ||
| 3703 | |(%%)(% style="color:#e74c3c" %)version(%%) (fixed: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 3704 | |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(%%). | ||
| 3705 | |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(%%). | ||
| 3706 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 3707 | |isFinal (fixed: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 3708 | |[[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. | ||
| 3709 | |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. | ||
| 3710 | |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. | ||
| 3711 | |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 key family in the context of a constraint. | ||
| 3712 | |||
| 3713 | Element Documentation: | ||
| 3714 | |||
| 3715 | |**Name**|**Type**|**Documentation** | ||
| 3716 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3717 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3718 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3719 | |Agency|AgencyType|Agency is an organisation which maintains [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] such as statistical classifications, glossaries, key family structural definitions, and [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].. | ||
| 3720 | |||
| 3721 | **DataConsumerSchemeType: **DataConsumerSchemeType defines a type of organisation scheme which contains only [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]]. The [[data consumer scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]] maintained by a particular [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] is always provided a fixed identifier and (% style="color:#e74c3c" %)version(%%), and is never final. Therefore, consumers can be added or removed without have to (% style="color:#e74c3c" %)version(%%) the scheme. This scheme has no [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], meaning that no organisation may define a relationship with another organisation in the scheme. | ||
| 3722 | |||
| 3723 | Derivation: | ||
| 3724 | //com:AnnotableType// (extension) | ||
| 3725 | //IdentifiableType// (extension) | ||
| 3726 | //NameableType// (extension) | ||
| 3727 | //VersionableType// (restriction) | ||
| 3728 | //MaintainableBaseType// (extension) | ||
| 3729 | //MaintainableType// (extension) | ||
| 3730 | //ItemSchemeType// (restriction) | ||
| 3731 | //OrganisationSchemeBaseType// (extension) | ||
| 3732 | //OrganisationSchemeType// (restriction) | ||
| 3733 | DataConsumerSchemeType | ||
| 3734 | |||
| 3735 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3736 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 3737 | |||
| 3738 | Content: | ||
| 3739 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, DataConsumer* | ||
| 3740 | |||
| 3741 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3742 | |||
| 3743 | |**Name**|**Type**|**Documentation** | ||
| 3744 | |id (fixed: DATA_CONSUMERS)|com:IDType|The id is the identifier for the object. | ||
| 3745 | |urn|xs:anyURI|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). | ||
| 3746 | |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. | ||
| 3747 | |(%%)(% style="color:#e74c3c" %)version(%%) (fixed: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 3748 | |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(%%). | ||
| 3749 | |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(%%). | ||
| 3750 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 3751 | |isFinal (fixed: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 3752 | |[[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. | ||
| 3753 | |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. | ||
| 3754 | |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. | ||
| 3755 | |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 key family in the context of a constraint. | ||
| 3756 | |||
| 3757 | Element Documentation: | ||
| 3758 | |||
| 3759 | |**Name**|**Type**|**Documentation** | ||
| 3760 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3761 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3762 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3763 | |DataConsumer|DataConsumerType|DataConsumer describes an organisation using data as input for further processing. | ||
| 3764 | |||
| 3765 | **DataProviderSchemeType: **DataProviderSchemeType defines a type of organisation scheme which contains only [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]]. The [[data provider scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]] maintained by a particular [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] is always provided a fixed identifier and (% style="color:#e74c3c" %)version(%%), and is never final. Therefore, providers can be added or removed without have to (% style="color:#e74c3c" %)version(%%) the scheme. This scheme has no [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], meaning that no organisation may define a relationship with another organisation in the scheme | ||
| 3766 | |||
| 3767 | Derivation: | ||
| 3768 | //com:AnnotableType// (extension) | ||
| 3769 | //IdentifiableType// (extension) | ||
| 3770 | //NameableType// (extension) | ||
| 3771 | //VersionableType// (restriction) | ||
| 3772 | //MaintainableBaseType// (extension) | ||
| 3773 | //MaintainableType// (extension) | ||
| 3774 | //ItemSchemeType// (restriction) | ||
| 3775 | //OrganisationSchemeBaseType// (extension) | ||
| 3776 | //OrganisationSchemeType// (restriction) | ||
| 3777 | DataProviderSchemeType | ||
| 3778 | |||
| 3779 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3780 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 3781 | |||
| 3782 | Content: | ||
| 3783 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, DataProvider* | ||
| 3784 | |||
| 3785 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3786 | |||
| 3787 | |**Name**|**Type**|**Documentation** | ||
| 3788 | |id (fixed: DATA_PROVIDERS)|com:IDType|The id is the identifier for the object. | ||
| 3789 | |urn|xs:anyURI|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). | ||
| 3790 | |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. | ||
| 3791 | |(%%)(% style="color:#e74c3c" %)version(%%) (fixed: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 3792 | |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(%%). | ||
| 3793 | |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(%%). | ||
| 3794 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 3795 | |isFinal (fixed: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 3796 | |[[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. | ||
| 3797 | |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. | ||
| 3798 | |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. | ||
| 3799 | |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 key family in the context of a constraint. | ||
| 3800 | |||
| 3801 | Element Documentation: | ||
| 3802 | |||
| 3803 | |**Name**|**Type**|**Documentation** | ||
| 3804 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3805 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3806 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3807 | |DataProvider|DataProviderType|DataProvider describes an organisation that produces data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]. | ||
| 3808 | |||
| 3809 | **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. | ||
| 3810 | |||
| 3811 | Derivation: | ||
| 3812 | //com:AnnotableType// (extension) | ||
| 3813 | //IdentifiableType// (extension) | ||
| 3814 | //NameableType// (extension) | ||
| 3815 | //VersionableType// (restriction) | ||
| 3816 | //MaintainableBaseType// (extension) | ||
| 3817 | //MaintainableType// (extension) | ||
| 3818 | //ItemSchemeType// (restriction) | ||
| 3819 | //OrganisationSchemeBaseType// (extension) | ||
| 3820 | //OrganisationSchemeType// (restriction) | ||
| 3821 | OrganisationUnitSchemeType | ||
| 3822 | |||
| 3823 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3824 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 3825 | |||
| 3826 | Content: | ||
| 3827 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, OrganisationUnit* | ||
| 3828 | |||
| 3829 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3830 | |||
| 3831 | |**Name**|**Type**|**Documentation** | ||
| 3832 | |id|com:IDType|The id is the identifier for the object. | ||
| 3833 | |urn|xs:anyURI|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). | ||
| 3834 | |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. | ||
| 3835 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 3836 | |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(%%). | ||
| 3837 | |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(%%). | ||
| 3838 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 3839 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 3840 | |[[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. | ||
| 3841 | |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. | ||
| 3842 | |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. | ||
| 3843 | |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 key family in the context of a constraint. | ||
| 3844 | |||
| 3845 | Element Documentation: | ||
| 3846 | |||
| 3847 | |**Name**|**Type**|**Documentation** | ||
| 3848 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3849 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3850 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3851 | |OrganisationUnit|OrganisationUnitType|OrganisationUnit describes a generic organisation, which serves not predefined role in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. | ||
| 3852 | |||
| 3853 | **AgencyType: **AgencyType defines the structure of an agency description. The (% style="color:#e74c3c" %)contacts(%%) defined for the organisation are specific to the agency role the organisation is serving. | ||
| 3854 | |||
| 3855 | Derivation: | ||
| 3856 | //com:AnnotableType// (extension) | ||
| 3857 | //IdentifiableType// (extension) | ||
| 3858 | //NameableType// (restriction) | ||
| 3859 | //ItemBaseType// (extension) | ||
| 3860 | //ItemType// (restriction) | ||
| 3861 | //BaseOrganisationType// (extension) | ||
| 3862 | //OrganisationType// (restriction) | ||
| 3863 | AgencyType | ||
| 3864 | |||
| 3865 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3866 | id, urn?, uri? | ||
| 3867 | |||
| 3868 | Content: | ||
| 3869 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, (% style="color:#e74c3c" %)Contact(%%)* | ||
| 3870 | |||
| 3871 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3872 | |||
| 3873 | |**Name**|**Type**|**Documentation** | ||
| 3874 | |id|com:NCNameIDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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). | ||
| 3875 | |urn|xs:anyURI|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). | ||
| 3876 | |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. | ||
| 3877 | |||
| 3878 | Element Documentation: | ||
| 3879 | |||
| 3880 | |**Name**|**Type**|**Documentation** | ||
| 3881 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3882 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3883 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3884 | |(%%)(% style="color:#e74c3c" %)Contact|ContactType|(%%)(% style="color:#e74c3c" %)Contact(%%) describes a (% style="color:#e74c3c" %)contact(%%) for the organisation, | ||
| 3885 | |||
| 3886 | **DataConsumerType: **DataConsumerType defines the structure of a [[data consumer>>doc:sdmx:Glossary.Data consumer.WebHome]] description. The (% style="color:#e74c3c" %)contacts(%%) defined for the organisation are specific to the [[data consumer>>doc:sdmx:Glossary.Data consumer.WebHome]] role the organisation is serving. | ||
| 3887 | |||
| 3888 | Derivation: | ||
| 3889 | //com:AnnotableType// (extension) | ||
| 3890 | //IdentifiableType// (extension) | ||
| 3891 | //NameableType// (restriction) | ||
| 3892 | //ItemBaseType// (extension) | ||
| 3893 | //ItemType// (restriction) | ||
| 3894 | //BaseOrganisationType// (extension) | ||
| 3895 | //OrganisationType// (restriction) | ||
| 3896 | DataConsumerType | ||
| 3897 | |||
| 3898 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3899 | id, urn?, uri? | ||
| 3900 | |||
| 3901 | Content: | ||
| 3902 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, (% style="color:#e74c3c" %)Contact(%%)* | ||
| 3903 | |||
| 3904 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3905 | |||
| 3906 | |**Name**|**Type**|**Documentation** | ||
| 3907 | |id|com:IDType|The id is the identifier for the object. | ||
| 3908 | |urn|xs:anyURI|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). | ||
| 3909 | |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. | ||
| 3910 | |||
| 3911 | Element Documentation: | ||
| 3912 | |||
| 3913 | |**Name**|**Type**|**Documentation** | ||
| 3914 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3915 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3916 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3917 | |(%%)(% style="color:#e74c3c" %)Contact|ContactType|(%%)(% style="color:#e74c3c" %)Contact(%%) describes a (% style="color:#e74c3c" %)contact(%%) for the organisation, | ||
| 3918 | |||
| 3919 | **DataProviderType: **DataProviderType defines the structure of a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] description. The (% style="color:#e74c3c" %)contacts(%%) defined for the organisation are specific to the [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] role the organisation is serving. | ||
| 3920 | |||
| 3921 | Derivation: | ||
| 3922 | |||
| 3923 | //com:AnnotableType// (extension) | ||
| 3924 | [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension) | ||
| 3925 | [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction) | ||
| 3926 | [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension) | ||
| 3927 | [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction) | ||
| 3928 | [[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension) | ||
| 3929 | [[image:inherit.gif||height="9" width="9"]] //OrganisationType// (restriction) | ||
| 3930 | [[image:inherit.gif||height="9" width="9"]] DataProviderType | ||
| 3931 | |||
| 3932 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3933 | |||
| 3934 | id, urn?, uri? | ||
| 3935 | |||
| 3936 | Content: | ||
| 3937 | |||
| 3938 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, (% style="color:#e74c3c" %)Contact(%%)* | ||
| 3939 | |||
| 3940 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3941 | |||
| 3942 | |**Name**|**Type**|**Documentation** | ||
| 3943 | |id|com:IDType|The id is the identifier for the object. | ||
| 3944 | |urn|xs:anyURI|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). | ||
| 3945 | |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. | ||
| 3946 | |||
| 3947 | Element Documentation: | ||
| 3948 | |||
| 3949 | |**Name**|**Type**|**Documentation** | ||
| 3950 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3951 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3952 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3953 | |(%%)(% style="color:#e74c3c" %)Contact|ContactType|(%%)(% style="color:#e74c3c" %)Contact(%%) describes a (% style="color:#e74c3c" %)contact(%%) for the organisation, | ||
| 3954 | |||
| 3955 | **OrganisationUnitType: **OrganisationUnitType defines the structure of an organisation unit description. In addition to general identification and (% style="color:#e74c3c" %)contact(%%) information, an organisation unit can specify a relationship with another organisation unit from the same scheme which is its parent organisation. | ||
| 3956 | |||
| 3957 | Derivation: | ||
| 3958 | |||
| 3959 | //com:AnnotableType// (extension) | ||
| 3960 | //IdentifiableType// (extension) | ||
| 3961 | //NameableType// (restriction) | ||
| 3962 | //ItemBaseType// (extension) | ||
| 3963 | //ItemType// (restriction) | ||
| 3964 | //BaseOrganisationType// (extension) | ||
| 3965 | //OrganisationType// (restriction) | ||
| 3966 | OrganisationUnitType | ||
| 3967 | |||
| 3968 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3969 | id, urn?, uri? | ||
| 3970 | |||
| 3971 | Content: | ||
| 3972 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Parent?, (% style="color:#e74c3c" %)Contact(%%)* | ||
| 3973 | |||
| 3974 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3975 | |||
| 3976 | |**Name**|**Type**|**Documentation** | ||
| 3977 | |id|com:IDType|The id is the identifier for the object. | ||
| 3978 | |urn|xs:anyURI|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). | ||
| 3979 | |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. | ||
| 3980 | |||
| 3981 | Element Documentation: | ||
| 3982 | |||
| 3983 | |**Name**|**Type**|**Documentation** | ||
| 3984 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 3985 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3986 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 3987 | |Parent|com: LocalOrganisationUni tReferenceType|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. | ||
| 3988 | |(%%)(% style="color:#e74c3c" %)Contact|ContactType|(%%)(% style="color:#e74c3c" %)Contact(%%) describes a (% style="color:#e74c3c" %)contact(%%) for the organisation, | ||
| 3989 | |||
| 3990 | **ContactType: **ContactType describes the structure of a (% style="color:#e74c3c" %)contact(%%)'s details. | ||
| 3991 | |||
| 3992 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 3993 | id? | ||
| 3994 | |||
| 3995 | Content: | ||
| 3996 | com:Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)* | ||
| 3997 | |||
| 3998 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 3999 | |||
| 4000 | |**Name**|**Type**|**Documentation** | ||
| 4001 | |id|com:IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to carry user id information for the (% style="color:#e74c3c" %)contact(%%). | ||
| 4002 | |||
| 4003 | Element Documentation: | ||
| 4004 | |||
| 4005 | |**Name**|**Type**|**Documentation** | ||
| 4006 | |com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object. | ||
| 4007 | |Department|com:TextType|Department is designation of the organisational structure by a linguistic expression, within which the (% style="color:#e74c3c" %)contact(%%) person works. | ||
| 4008 | |Role|com:TextType|Role is the responsibility of the (% style="color:#e74c3c" %)contact(%%) person with respect to the object for which this person is the (% style="color:#e74c3c" %)contact(%%). | ||
| 4009 | |Telephone|xs:string|Telephone holds the [[telephone number>>doc:sdmx:Glossary.Contact phone number.WebHome]] for the (% style="color:#e74c3c" %)contact(%%) person. | ||
| 4010 | |Fax|xs:string|Fax holds the fax number for the (% style="color:#e74c3c" %)contact(%%) person. | ||
| 4011 | |X400|xs:string|X400 holds the X.400 address for the (% style="color:#e74c3c" %)contact(%%) person. | ||
| 4012 | |URI|xs:anyURI|URI holds an information URL for the (% style="color:#e74c3c" %)contact(%%) person. | ||
| 4013 | |Email|xs:string|Email holds the email address for the (% style="color:#e74c3c" %)contact(%%) person. | ||
| 4014 | |||
| 4015 | **ProvisionAgreementType: **ProvisionAgreementType describes the structure of a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]. A [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] defines an agreement for a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] to report data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] against a flow. [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which describe how the registry must behave when data or metadata is registered against this [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] are supplied. | ||
| 4016 | |||
| 4017 | Derivation: | ||
| 4018 | //com:AnnotableType// (extension) | ||
| 4019 | //IdentifiableType// (extension) | ||
| 4020 | //NameableType// (extension) | ||
| 4021 | //VersionableType// (restriction) | ||
| 4022 | //MaintainableBaseType// (extension) | ||
| 4023 | //MaintainableType// (extension) | ||
| 4024 | ProvisionAgreementType | ||
| 4025 | |||
| 4026 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4027 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 4028 | |||
| 4029 | Content: | ||
| 4030 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, StructureUsage, DataProvider | ||
| 4031 | |||
| 4032 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4033 | |||
| 4034 | |**Name**|**Type**|**Documentation** | ||
| 4035 | |id|com:IDType|The id is the identifier for the object. | ||
| 4036 | |urn|xs:anyURI|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). | ||
| 4037 | |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. | ||
| 4038 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 4039 | |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(%%). | ||
| 4040 | |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(%%). | ||
| 4041 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 4042 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 4043 | |[[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. | ||
| 4044 | |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. | ||
| 4045 | |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. | ||
| 4046 | |||
| 4047 | Element Documentation: | ||
| 4048 | |||
| 4049 | |**Name**|**Type**|**Documentation** | ||
| 4050 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4051 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4052 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4053 | |StructureUsage|com: StructureUsageRefere nceType|DataflowReference provides a reference to a pre-existing structure usage (i.e. a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]) in the registry. The reference is provided via a URN and/or a full set of reference fields. | ||
| 4054 | |DataProvider|com: DataProviderReferenc eType|DataProvider provides a reference to a pre-existing data (or metadata) provider in the registry. The reference is provided via a URN and/or a full set of reference fields. | ||
| 4055 | |||
| 4056 | **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. | ||
| 4057 | |||
| 4058 | Derivation: | ||
| 4059 | //com:AnnotableType// (extension) | ||
| 4060 | //IdentifiableType// (extension) | ||
| 4061 | //NameableType// (extension) | ||
| 4062 | //VersionableType// (restriction) | ||
| 4063 | //MaintainableBaseType// (extension) | ||
| 4064 | //MaintainableType// (extension) | ||
| 4065 | ProcessType | ||
| 4066 | |||
| 4067 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4068 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 4069 | |||
| 4070 | Content: | ||
| 4071 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, ProcessStep* | ||
| 4072 | |||
| 4073 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4074 | |||
| 4075 | |**Name**|**Type**|**Documentation** | ||
| 4076 | |id|com:IDType|The id is the identifier for the object. | ||
| 4077 | |urn|xs:anyURI|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). | ||
| 4078 | |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. | ||
| 4079 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 4080 | |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(%%). | ||
| 4081 | |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(%%). | ||
| 4082 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 4083 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 4084 | |[[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. | ||
| 4085 | |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. | ||
| 4086 | |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. | ||
| 4087 | |||
| 4088 | Element Documentation: | ||
| 4089 | |||
| 4090 | |**Name**|**Type**|**Documentation** | ||
| 4091 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4092 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4093 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4094 | |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. | ||
| 4095 | |||
| 4096 | //**ProcessStepBaseType**//**: **ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType. | ||
| 4097 | |||
| 4098 | Derivation: | ||
| 4099 | //com:AnnotableType// (extension) | ||
| 4100 | //IdentifiableType// (extension) | ||
| 4101 | //NameableType// (restriction) | ||
| 4102 | //ProcessStepBaseType// | ||
| 4103 | |||
| 4104 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4105 | id, urn?, uri? | ||
| 4106 | |||
| 4107 | Content: | ||
| 4108 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 4109 | |||
| 4110 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4111 | |||
| 4112 | |**Name**|**Type**|**Documentation** | ||
| 4113 | |id|com:IDType|The id is the identifier for the object. | ||
| 4114 | |urn|xs:anyURI|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). | ||
| 4115 | |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. | ||
| 4116 | |||
| 4117 | Element Documentation: | ||
| 4118 | |||
| 4119 | |**Name**|**Type**|**Documentation** | ||
| 4120 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4121 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4122 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4123 | |||
| 4124 | **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. | ||
| 4125 | |||
| 4126 | Derivation: | ||
| 4127 | //com:AnnotableType// (extension) | ||
| 4128 | //IdentifiableType// (extension) | ||
| 4129 | //NameableType// (restriction) | ||
| 4130 | //ProcessStepBaseType// (extension) | ||
| 4131 | ProcessStepType | ||
| 4132 | |||
| 4133 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4134 | id, urn?, uri? | ||
| 4135 | |||
| 4136 | Content: | ||
| 4137 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Input*, Output*, Computation?, Transition*, ProcessStep* | ||
| 4138 | |||
| 4139 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4140 | |||
| 4141 | |**Name**|**Type**|**Documentation** | ||
| 4142 | |id|com:IDType|The id is the identifier for the object. | ||
| 4143 | |urn|xs:anyURI|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). | ||
| 4144 | |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. | ||
| 4145 | |||
| 4146 | Element Documentation: | ||
| 4147 | |||
| 4148 | |**Name**|**Type**|**Documentation** | ||
| 4149 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4150 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4151 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4152 | |Input|InputOutputType|Input references an object which is an input to the process step. | ||
| 4153 | |Output|InputOutputType|Output references an object which is an output form the process step. | ||
| 4154 | |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 (% style="color:#e74c3c" %)versions(%%). | ||
| 4155 | |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. | ||
| 4156 | |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. | ||
| 4157 | |||
| 4158 | **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. | ||
| 4159 | |||
| 4160 | Derivation: | ||
| 4161 | //com:AnnotableType// (extension) | ||
| 4162 | //IdentifiableType// (extension) | ||
| 4163 | TransitionType | ||
| 4164 | |||
| 4165 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4166 | id?, urn?, uri?, localID? | ||
| 4167 | |||
| 4168 | Content: | ||
| 4169 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, TargetStep, Condition+ | ||
| 4170 | |||
| 4171 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4172 | |||
| 4173 | |**Name**|**Type**|**Documentation** | ||
| 4174 | |id|com:IDType|The id is the identifier for the object. | ||
| 4175 | |urn|xs:anyURI|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). | ||
| 4176 | |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. | ||
| 4177 | |localID|com:IDType|The localID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an optional identification for the transition within the process. | ||
| 4178 | |||
| 4179 | Element Documentation: | ||
| 4180 | |||
| 4181 | |**Name**|**Type**|**Documentation** | ||
| 4182 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4183 | |TargetStep|com: LocalProcessStepRefe renceType|TargetStep references a process step within the process that should be transitioned to, should the conditions described be met. | ||
| 4184 | |Condition|com: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. | ||
| 4185 | |||
| 4186 | **ComputationType: **ComputationType describes a computation in a process. | ||
| 4187 | |||
| 4188 | Derivation: | ||
| 4189 | //com:AnnotableType// (extension) | ||
| 4190 | ComputationType | ||
| 4191 | |||
| 4192 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4193 | localID?, softwarePackage?, softwareLanguage?, softwareVersion? | ||
| 4194 | |||
| 4195 | Content: | ||
| 4196 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Description+ | ||
| 4197 | |||
| 4198 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4199 | |||
| 4200 | |**Name**|**Type**|**Documentation** | ||
| 4201 | |localID|com:IDType|The localID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an optional identification for the computation within the process. | ||
| 4202 | |softwarePackage|xs:string|The softwarePackage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the name of the software package that is used to perform the computation. | ||
| 4203 | |softwareLanguage|xs:string|The softwareLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the coding language that the software package used to perform the computation is written in. | ||
| 4204 | |softwareVersion|xs:string|The softwareVersion [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] hold the (% style="color:#e74c3c" %)version(%%) of the software package that is used to perform that computation. | ||
| 4205 | |||
| 4206 | Element Documentation: | ||
| 4207 | |||
| 4208 | |**Name**|**Type**|**Documentation** | ||
| 4209 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4210 | |com:Description|com: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 (% style="color:#e74c3c" %)versions(%%), | ||
| 4211 | |||
| 4212 | **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. | ||
| 4213 | |||
| 4214 | Derivation: | ||
| 4215 | |||
| 4216 | //com:AnnotableType// (extension) | ||
| 4217 | InputOutputType | ||
| 4218 | |||
| 4219 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4220 | localID? | ||
| 4221 | |||
| 4222 | Content: | ||
| 4223 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, ObjectReference | ||
| 4224 | |||
| 4225 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4226 | |||
| 4227 | |**Name**|**Type**|**Documentation** | ||
| 4228 | |localID|com:IDType|The localID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an optional identification for the input or output within the process. | ||
| 4229 | |||
| 4230 | Element Documentation: | ||
| 4231 | |||
| 4232 | |**Name**|**Type**|**Documentation** | ||
| 4233 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4234 | |ObjectReference|com: ObjectReferenceType|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. | ||
| 4235 | |||
| 4236 | **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>>doc:sdmx:Glossary.Component.WebHome]] can be described by an independent structure or structure usage description. | ||
| 4237 | |||
| 4238 | Derivation: | ||
| 4239 | //com:AnnotableType// (extension) | ||
| 4240 | //IdentifiableType// (extension) | ||
| 4241 | //NameableType// (extension) | ||
| 4242 | //VersionableType// (restriction) | ||
| 4243 | //MaintainableBaseType// (extension) | ||
| 4244 | //MaintainableType// (extension) | ||
| 4245 | //ItemSchemeType// (restriction) | ||
| 4246 | ReportingTaxonomyType | ||
| 4247 | |||
| 4248 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4249 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 4250 | |||
| 4251 | Content: | ||
| 4252 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, ReportingCategory* | ||
| 4253 | |||
| 4254 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4255 | |||
| 4256 | |**Name**|**Type**|**Documentation** | ||
| 4257 | |id|com:IDType|The id is the identifier for the object. | ||
| 4258 | |urn|xs:anyURI|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). | ||
| 4259 | |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. | ||
| 4260 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 4261 | |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(%%). | ||
| 4262 | |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(%%). | ||
| 4263 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 4264 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 4265 | |[[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. | ||
| 4266 | |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. | ||
| 4267 | |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. | ||
| 4268 | |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 key family in the context of a constraint. | ||
| 4269 | |||
| 4270 | Element Documentation: | ||
| 4271 | |||
| 4272 | |**Name**|**Type**|**Documentation** | ||
| 4273 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4274 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4275 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4276 | |ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting [[category>>doc:sdmx:Glossary.Category.WebHome]], which is used to group structure usages into useful sub-packages. | ||
| 4277 | |||
| 4278 | //**ReportingCategoryBaseType**//**: **ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType. | ||
| 4279 | |||
| 4280 | Derivation: | ||
| 4281 | //com:AnnotableType// (extension) | ||
| 4282 | //IdentifiableType// (extension) | ||
| 4283 | //NameableType// (restriction) | ||
| 4284 | //ItemBaseType// (extension) | ||
| 4285 | //ItemType// (restriction) | ||
| 4286 | //ReportingCategoryBaseType// | ||
| 4287 | |||
| 4288 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4289 | id, urn?, uri? | ||
| 4290 | |||
| 4291 | Content: | ||
| 4292 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, ReportingCategory* | ||
| 4293 | |||
| 4294 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4295 | |||
| 4296 | |**Name**|**Type**|**Documentation** | ||
| 4297 | |id|com:IDType|The id is the identifier for the object. | ||
| 4298 | |urn|xs:anyURI|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). | ||
| 4299 | |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. | ||
| 4300 | |||
| 4301 | Element Documentation: | ||
| 4302 | |||
| 4303 | |**Name**|**Type**|**Documentation** | ||
| 4304 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4305 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4306 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4307 | |ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting [[category>>doc:sdmx:Glossary.Category.WebHome]], which is used to group structure usages into useful sub-packages. | ||
| 4308 | |||
| 4309 | **ReportingCategoryType: **ReportingCategoryType describes the structure of a reporting [[category>>doc:sdmx:Glossary.Category.WebHome]], which groups structure usages into useful sub-packages. Sub ordinate reporting [[categories>>doc:sdmx:Glossary.Category.WebHome]] can be nested within the [[category>>doc:sdmx:Glossary.Category.WebHome]] definition. | ||
| 4310 | |||
| 4311 | Derivation: | ||
| 4312 | //com:AnnotableType// (extension) | ||
| 4313 | //IdentifiableType// (extension) | ||
| 4314 | //NameableType// (restriction) | ||
| 4315 | //ItemBaseType// (extension) | ||
| 4316 | //ItemType// (restriction) | ||
| 4317 | //ReportingCategoryBaseType// (extension) | ||
| 4318 | ReportingCategoryType | ||
| 4319 | |||
| 4320 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4321 | id, urn?, uri? | ||
| 4322 | |||
| 4323 | Content: | ||
| 4324 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, ReportingCategory*, (StructuralMetadata* | ProvisioningMetadata*) | ||
| 4325 | |||
| 4326 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4327 | |||
| 4328 | |**Name**|**Type**|**Documentation** | ||
| 4329 | |id|com:IDType|The id is the identifier for the object. | ||
| 4330 | |urn|xs:anyURI|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). | ||
| 4331 | |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. | ||
| 4332 | |||
| 4333 | Element Documentation: | ||
| 4334 | |||
| 4335 | |**Name**|**Type**|**Documentation** | ||
| 4336 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4337 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4338 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4339 | |ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting [[category>>doc:sdmx:Glossary.Category.WebHome]], which is used to group structure usages into useful sub-packages. | ||
| 4340 | |StructuralMetadata|com: StructureReferenceTy pe|StructuralMetadata provides a reference for [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] references which are grouped in the reporting [[category>>doc:sdmx:Glossary.Category.WebHome]]. It is assumed that all [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] objects referenced from a [[category>>doc:sdmx:Glossary.Category.WebHome]] will be of the same type. | ||
| 4341 | |ProvisioningMetadata|com: StructureUsageRefere nceType|ProvisioningMetadata provides a reference for [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] references which are grouped in the reporting [[category>>doc:sdmx:Glossary.Category.WebHome]]. It is assumed that all provisioning metadata objects referenced from a [[category>>doc:sdmx:Glossary.Category.WebHome]] will be of the same type. | ||
| 4342 | |||
| 4343 | //**StructureSetBaseType**//**: **StructureSetBaseType is an abstract base type that forms the basis for the StructureSetType. | ||
| 4344 | |||
| 4345 | Derivation: | ||
| 4346 | //com:AnnotableType// (extension) | ||
| 4347 | //IdentifiableType// (extension) | ||
| 4348 | //NameableType// (extension) | ||
| 4349 | //VersionableType// (restriction) | ||
| 4350 | //MaintainableBaseType// (extension) | ||
| 4351 | //MaintainableType// (restriction) | ||
| 4352 | //StructureSetBaseType// | ||
| 4353 | |||
| 4354 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4355 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 4356 | |||
| 4357 | Content: | ||
| 4358 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 4359 | |||
| 4360 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4361 | |||
| 4362 | |**Name**|**Type**|**Documentation** | ||
| 4363 | |id|com:IDType|The id is the identifier for the object. | ||
| 4364 | |urn|xs:anyURI|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). | ||
| 4365 | |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. | ||
| 4366 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 4367 | |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(%%). | ||
| 4368 | |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(%%). | ||
| 4369 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 4370 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 4371 | |[[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. | ||
| 4372 | |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. | ||
| 4373 | |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. | ||
| 4374 | |||
| 4375 | Element Documentation: | ||
| 4376 | |||
| 4377 | |**Name**|**Type**|**Documentation** | ||
| 4378 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4379 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4380 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4381 | |||
| 4382 | **StructureSetType: **StructureSetType describes the structure of a [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]]. It allows [[components>>doc:sdmx:Glossary.Component.WebHome]] in one structure, structure usage, or [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] to be (% style="color:#e74c3c" %)mapped(%%) to [[components>>doc:sdmx:Glossary.Component.WebHome]] in another structural [[component>>doc:sdmx:Glossary.Component.WebHome]] of the same type. | ||
| 4383 | |||
| 4384 | Derivation: | ||
| 4385 | //com:AnnotableType// (extension) | ||
| 4386 | //IdentifiableType// (extension) | ||
| 4387 | //NameableType// (extension) | ||
| 4388 | //VersionableType// (restriction) | ||
| 4389 | //MaintainableBaseType// (extension) | ||
| 4390 | //MaintainableType// (restriction) | ||
| 4391 | //StructureSetBaseType// (extension) | ||
| 4392 | StructureSetType | ||
| 4393 | |||
| 4394 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4395 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL? | ||
| 4396 | |||
| 4397 | Content: | ||
| 4398 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, RelatedStructure*, (OrganisationSchemeMap | CategorySchemeMap | CodelistMap | ConceptSchemeMap | ReportingTaxonomyMap | HybridCodelistMap | StructureMap)* | ||
| 4399 | |||
| 4400 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4401 | |||
| 4402 | |**Name**|**Type**|**Documentation** | ||
| 4403 | |id|com:IDType|The id is the identifier for the object. | ||
| 4404 | |urn|xs:anyURI|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). | ||
| 4405 | |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. | ||
| 4406 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 4407 | |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(%%). | ||
| 4408 | |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(%%). | ||
| 4409 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 4410 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 4411 | |[[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. | ||
| 4412 | |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. | ||
| 4413 | |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. | ||
| 4414 | |||
| 4415 | Element Documentation: | ||
| 4416 | |||
| 4417 | |**Name**|**Type**|**Documentation** | ||
| 4418 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4419 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4420 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4421 | |RelatedStructure|com: StructureOrUsageRefe renceType|RelatedStructures contains references to structures (key families and [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]) and structure usages ([[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]]) to indicate that a semantic relationship exist between them. The details of these relationships can be found in the structure (% style="color:#e74c3c" %)maps(%%). | ||
| 4422 | |OrganisationSchemeMa p|OrganisationSchemeMa pType|OrganisationSchemeMap links a source and target organisations from different schemes where there is a semantic equivalence between them. Organisations are (% style="color:#e74c3c" %)mapped(%%) without regard to role. | ||
| 4423 | |CategorySchemeMap|CategorySchemeMapTyp e|CategorySchemeMap links a source and target [[categories>>doc:sdmx:Glossary.Category.WebHome]] from different schemes where there is a semantic equivalence between them. | ||
| 4424 | |CodelistMap|CodelistMapType|CodelistMap links a source and target [[codes>>doc:sdmx:Glossary.Code.WebHome]] from different lists where there is a semantic equivalence between them. | ||
| 4425 | |ConceptSchemeMap|ConceptSchemeMapType|ConceptSchemeMap links a source and target (% style="color:#e74c3c" %)concepts(%%) from different schemes where there is a semantic equivalence between them. | ||
| 4426 | |ReportingTaxonomyMap|ReportingTaxonomyMap Type|ReportingTaxonomyMap links a source and target reporting [[categories>>doc:sdmx:Glossary.Category.WebHome]] from different taxonomies where there is a semantic equivalence between them. | ||
| 4427 | |HybridCodelistMap|HybridCodelistMapTyp e|HybridCodelistMap links a source and target [[codes>>doc:sdmx:Glossary.Code.WebHome]] from different [[codelists>>doc:sdmx:Glossary.Code list.WebHome]], which may be hierarchical or flat, where there is a semantic equivalence between them. | ||
| 4428 | |StructureMap|StructureMapType|StructureMap (% style="color:#e74c3c" %)maps(%%) [[components>>doc:sdmx:Glossary.Component.WebHome]] from one structure to [[components>>doc:sdmx:Glossary.Component.WebHome]] to another structure, and can describe how the value of the [[components>>doc:sdmx:Glossary.Component.WebHome]] are related. | ||
| 4429 | |||
| 4430 | //**ItemSchemeMapBaseType**//**: **ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType. | ||
| 4431 | |||
| 4432 | Derivation: | ||
| 4433 | //com:AnnotableType// (extension) | ||
| 4434 | //IdentifiableType// (extension) | ||
| 4435 | //NameableType// (restriction) | ||
| 4436 | //ItemSchemeMapBaseType// | ||
| 4437 | |||
| 4438 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4439 | id, urn?, uri? | ||
| 4440 | |||
| 4441 | Content: | ||
| 4442 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 4443 | |||
| 4444 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4445 | |||
| 4446 | |**Name**|**Type**|**Documentation** | ||
| 4447 | |id|com:IDType|The id is the identifier for the object. | ||
| 4448 | |urn|xs:anyURI|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). | ||
| 4449 | |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. | ||
| 4450 | |||
| 4451 | Element Documentation: | ||
| 4452 | |||
| 4453 | |**Name**|**Type**|**Documentation** | ||
| 4454 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4455 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4456 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4457 | |||
| 4458 | //**ItemSchemeMapType**//**: **ItemSchemeMapType is an abstract base type which forms the basis for (% style="color:#e74c3c" %)mapping(%%) items between [[item schemes>>doc:sdmx:Glossary.Item scheme.WebHome]] of the same type. | ||
| 4459 | |||
| 4460 | Derivation: | ||
| 4461 | |||
| 4462 | //com:AnnotableType// (extension) | ||
| 4463 | //IdentifiableType// (extension) | ||
| 4464 | //NameableType// (restriction) | ||
| 4465 | //ItemSchemeMapBaseType// (extension) | ||
| 4466 | //ItemSchemeMapType// | ||
| 4467 | |||
| 4468 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4469 | id, urn?, uri? | ||
| 4470 | |||
| 4471 | Content: | ||
| 4472 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Source, Target, //ItemAssociation+// | ||
| 4473 | |||
| 4474 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4475 | |||
| 4476 | |**Name**|**Type**|**Documentation** | ||
| 4477 | |id|com:IDType|The id is the identifier for the object. | ||
| 4478 | |urn|xs:anyURI|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). | ||
| 4479 | |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. | ||
| 4480 | |||
| 4481 | Element Documentation: | ||
| 4482 | |||
| 4483 | |**Name**|**Type**|**Documentation** | ||
| 4484 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4485 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4486 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4487 | |Source|//com: ItemSchemeReferenceB aseType//|Source provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) from. | ||
| 4488 | |Target|//com: ItemSchemeReferenceB aseType//|Target provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) to. | ||
| 4489 | |//ItemAssociation//|//ItemAssociationType//|ItemAssociation is an abstract description of the relation between two items for the purpose of (% style="color:#e74c3c" %)mapping(%%). | ||
| 4490 | |||
| 4491 | //**ItemAssociationType**//**: **ItemAssociationType is an abstract type which defines the relationship between two items from the source and target [[item schemes>>doc:sdmx:Glossary.Item scheme.WebHome]] of an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%). | ||
| 4492 | |||
| 4493 | Derivation: | ||
| 4494 | //com:AnnotableType// (extension) | ||
| 4495 | //ItemAssociationType// | ||
| 4496 | |||
| 4497 | Content: | ||
| 4498 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Source, Target | ||
| 4499 | |||
| 4500 | Element Documentation: | ||
| 4501 | |||
| 4502 | |**Name**|**Type**|**Documentation** | ||
| 4503 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4504 | |Source|//com: LocalItemReferenceTy pe//|Source provides a local reference (id only) to an item from the source [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) to another item. | ||
| 4505 | |Target|//com: LocalItemReferenceTy pe//|Target provides a local reference (id only) to an item from the target [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) from another item. | ||
| 4506 | |||
| 4507 | **OrganisationSchemeMapType: **OrganisationSchemeMapType defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between organisations in different organisation schemes. | ||
| 4508 | |||
| 4509 | Derivation: | ||
| 4510 | //com:AnnotableType// (extension) | ||
| 4511 | //IdentifiableType// (extension) | ||
| 4512 | //NameableType// (restriction) | ||
| 4513 | //ItemSchemeMapBaseType// (extension) | ||
| 4514 | //ItemSchemeMapType// (restriction) | ||
| 4515 | OrganisationSchemeMapType | ||
| 4516 | |||
| 4517 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4518 | id, urn?, uri? | ||
| 4519 | |||
| 4520 | Content: | ||
| 4521 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Source, Target, OrganisationMap+ | ||
| 4522 | |||
| 4523 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4524 | |||
| 4525 | |**Name**|**Type**|**Documentation** | ||
| 4526 | |id|com:IDType|The id is the identifier for the object. | ||
| 4527 | |urn|xs:anyURI|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). | ||
| 4528 | |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. | ||
| 4529 | |||
| 4530 | Element Documentation: | ||
| 4531 | |||
| 4532 | |**Name**|**Type**|**Documentation** | ||
| 4533 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4534 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4535 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4536 | |Source|com: OrganisationSchemeRe ferenceType|Source provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) from. | ||
| 4537 | |Target|com: OrganisationSchemeRe ferenceType|Target provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) to. | ||
| 4538 | |OrganisationMap|OrganisationMapType|OrganisationMap relates a source organisation to a target organisation. | ||
| 4539 | |||
| 4540 | **OrganisationMapType: **OrganisationMapType defines the structure for (% style="color:#e74c3c" %)mapping(%%) two organisations. A local reference is provided both the source and target organisation. | ||
| 4541 | |||
| 4542 | Derivation: | ||
| 4543 | //com:AnnotableType// (extension) | ||
| 4544 | //ItemAssociationType// (restriction) | ||
| 4545 | OrganisationMapType | ||
| 4546 | |||
| 4547 | Content: | ||
| 4548 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Source, Target | ||
| 4549 | |||
| 4550 | Element Documentation: | ||
| 4551 | |||
| 4552 | |**Name**|**Type**|**Documentation** | ||
| 4553 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4554 | |Source|com: LocalOrganisationRef erenceType|Source provides a local reference (id only) to an item from the source [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) to another item. | ||
| 4555 | |Target|com: LocalOrganisationRef erenceType|Target provides a local reference (id only) to an item from the target [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) from another item. | ||
| 4556 | |||
| 4557 | **CategorySchemeMapType: **CategorySchemeMapType defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between [[categories>>doc:sdmx:Glossary.Category.WebHome]] in different [[category>>doc:sdmx:Glossary.Category.WebHome]] schemes. | ||
| 4558 | |||
| 4559 | Derivation: | ||
| 4560 | //com:AnnotableType// (extension) | ||
| 4561 | //IdentifiableType// (extension) | ||
| 4562 | //NameableType// (restriction) | ||
| 4563 | //ItemSchemeMapBaseType// (extension) | ||
| 4564 | //ItemSchemeMapType// (restriction) | ||
| 4565 | CategorySchemeMapType | ||
| 4566 | |||
| 4567 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4568 | id, urn?, uri? | ||
| 4569 | |||
| 4570 | Content: | ||
| 4571 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Source, Target, CategoryMap+ | ||
| 4572 | |||
| 4573 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4574 | |||
| 4575 | |**Name**|**Type**|**Documentation** | ||
| 4576 | |id|com:IDType|The id is the identifier for the object. | ||
| 4577 | |urn|xs:anyURI|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). | ||
| 4578 | |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. | ||
| 4579 | |||
| 4580 | Element Documentation: | ||
| 4581 | |||
| 4582 | |**Name**|**Type**|**Documentation** | ||
| 4583 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4584 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4585 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4586 | |Source|com: CategorySchemeRefere nceType|Source provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) from. | ||
| 4587 | |Target|com: CategorySchemeRefere nceType|Target provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) to. | ||
| 4588 | |CategoryMap|CategoryMapType|CategoryMap defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between [[categories>>doc:sdmx:Glossary.Category.WebHome]] in different [[category>>doc:sdmx:Glossary.Category.WebHome]] schemes. | ||
| 4589 | |||
| 4590 | **CategoryMapType: **CategoryMapType defines the structure for (% style="color:#e74c3c" %)mapping(%%) two [[categories>>doc:sdmx:Glossary.Category.WebHome]]. A local reference is provided both the source and target [[category>>doc:sdmx:Glossary.Category.WebHome]]. | ||
| 4591 | |||
| 4592 | Derivation: | ||
| 4593 | //com:AnnotableType// (extension) | ||
| 4594 | //ItemAssociationType// (restriction) | ||
| 4595 | CategoryMapType | ||
| 4596 | |||
| 4597 | Content: | ||
| 4598 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Source, Target | ||
| 4599 | |||
| 4600 | Element Documentation: | ||
| 4601 | |||
| 4602 | |**Name**|**Type**|**Documentation** | ||
| 4603 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4604 | |Source|com: LocalCategoryReferen ceType|Source provides a local reference (id only) to an item from the source [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) to another item. | ||
| 4605 | |Target|com: LocalCategoryReferen ceType|Target provides a local reference (id only) to an item from the target [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) from another item. | ||
| 4606 | |||
| 4607 | **CodelistMapType: **CodelistMapType defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between [[codes>>doc:sdmx:Glossary.Code.WebHome]] in different [[codelists>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 4608 | |||
| 4609 | Derivation: | ||
| 4610 | //com:AnnotableType// (extension) | ||
| 4611 | //IdentifiableType// (extension) | ||
| 4612 | //NameableType// (restriction) | ||
| 4613 | //ItemSchemeMapBaseType// (extension) | ||
| 4614 | //ItemSchemeMapType// (restriction) | ||
| 4615 | CodelistMapType | ||
| 4616 | |||
| 4617 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4618 | id, urn?, uri? | ||
| 4619 | |||
| 4620 | Content: | ||
| 4621 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Source, Target, CodeMap+ | ||
| 4622 | |||
| 4623 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4624 | |||
| 4625 | |**Name**|**Type**|**Documentation** | ||
| 4626 | |id|com:IDType|The id is the identifier for the object. | ||
| 4627 | |urn|xs:anyURI|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). | ||
| 4628 | |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. | ||
| 4629 | |||
| 4630 | Element Documentation: | ||
| 4631 | |||
| 4632 | |**Name**|**Type**|**Documentation** | ||
| 4633 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4634 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4635 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4636 | |Source|com: CodelistReferenceTyp e|Source provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) from. | ||
| 4637 | |Target|com: CodelistReferenceTyp e|Target provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) to. | ||
| 4638 | |CodeMap|CodeMapType|CodeMap defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between [[codes>>doc:sdmx:Glossary.Code.WebHome]] in different [[codelists>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 4639 | |||
| 4640 | **CodeMapType: **CodeMapType defines the structure for (% style="color:#e74c3c" %)mapping(%%) two [[codes>>doc:sdmx:Glossary.Code.WebHome]]. A local reference is provided both the source and target [[code>>doc:sdmx:Glossary.Code.WebHome]]. | ||
| 4641 | |||
| 4642 | Derivation: | ||
| 4643 | //com:AnnotableType// (extension) | ||
| 4644 | //ItemAssociationType// (restriction) | ||
| 4645 | CodeMapType | ||
| 4646 | |||
| 4647 | Content: | ||
| 4648 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Source, Target | ||
| 4649 | |||
| 4650 | Element Documentation: | ||
| 4651 | |||
| 4652 | |**Name**|**Type**|**Documentation** | ||
| 4653 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4654 | |Source|com: LocalCodeReferenceTy pe|Source provides a local reference (id only) to an item from the source [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) to another item. | ||
| 4655 | |Target|com: LocalCodeReferenceTy pe|Target provides a local reference (id only) to an item from the target [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) from another item. | ||
| 4656 | |||
| 4657 | **ConceptSchemeMapType: **ConceptSchemeMapType defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between (% style="color:#e74c3c" %)concepts(%%) in different [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]]. | ||
| 4658 | |||
| 4659 | Derivation: | ||
| 4660 | //com:AnnotableType// (extension) | ||
| 4661 | //IdentifiableType// (extension) | ||
| 4662 | //NameableType// (restriction) | ||
| 4663 | //ItemSchemeMapBaseType// (extension) | ||
| 4664 | //ItemSchemeMapType// (restriction) | ||
| 4665 | ConceptSchemeMapType | ||
| 4666 | |||
| 4667 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4668 | id, urn?, uri? | ||
| 4669 | |||
| 4670 | Content: | ||
| 4671 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Source, Target, ConceptMap+ | ||
| 4672 | |||
| 4673 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4674 | |||
| 4675 | |**Name**|**Type**|**Documentation** | ||
| 4676 | |id|com:IDType|The id is the identifier for the object. | ||
| 4677 | |urn|xs:anyURI|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). | ||
| 4678 | |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. | ||
| 4679 | |||
| 4680 | Element Documentation: | ||
| 4681 | |||
| 4682 | |**Name**|**Type**|**Documentation** | ||
| 4683 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4684 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4685 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4686 | |Source|com: ConceptSchemeReferen ceType|Source provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) from. | ||
| 4687 | |Target|com: ConceptSchemeReferen ceType|Target provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) to. | ||
| 4688 | |ConceptMap|ConceptMapType|ConceptMap defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between (% style="color:#e74c3c" %)concepts(%%) in different [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]]. | ||
| 4689 | |||
| 4690 | **ConceptMapType: **ConceptMapType defines the structure for (% style="color:#e74c3c" %)mapping(%%) two (% style="color:#e74c3c" %)concepts(%%). A local reference is provided both the source and target (% style="color:#e74c3c" %)concept(%%). | ||
| 4691 | |||
| 4692 | Derivation: | ||
| 4693 | //com:AnnotableType// (extension) | ||
| 4694 | //ItemAssociationType// (restriction) | ||
| 4695 | ConceptMapType | ||
| 4696 | |||
| 4697 | Content: | ||
| 4698 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Source, Target | ||
| 4699 | |||
| 4700 | Element Documentation: | ||
| 4701 | |||
| 4702 | |**Name**|**Type**|**Documentation** | ||
| 4703 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4704 | |Source|com: LocalConceptReferenc eType|Source provides a local reference (id only) to an item from the source [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) to another item. | ||
| 4705 | |Target|com: LocalConceptReferenc eType|Target provides a local reference (id only) to an item from the target [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) from another item. | ||
| 4706 | |||
| 4707 | **ReportingTaxonomyMapType: **ReportingTaxonomyMapType defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between reporting [[categories>>doc:sdmx:Glossary.Category.WebHome]] in different reporting taxonomies. | ||
| 4708 | |||
| 4709 | Derivation: | ||
| 4710 | //com:AnnotableType// (extension) | ||
| 4711 | //IdentifiableType// (extension) | ||
| 4712 | //NameableType// (restriction) | ||
| 4713 | //ItemSchemeMapBaseType// (extension) | ||
| 4714 | //ItemSchemeMapType// (restriction) | ||
| 4715 | ReportingTaxonomyMapType | ||
| 4716 | |||
| 4717 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4718 | id, urn?, uri? | ||
| 4719 | |||
| 4720 | Content: | ||
| 4721 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Source, Target, ReportingCategoryMap+ | ||
| 4722 | |||
| 4723 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4724 | |||
| 4725 | |**Name**|**Type**|**Documentation** | ||
| 4726 | |id|com:IDType|The id is the identifier for the object. | ||
| 4727 | |urn|xs:anyURI|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). | ||
| 4728 | |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. | ||
| 4729 | |||
| 4730 | Element Documentation: | ||
| 4731 | |||
| 4732 | |**Name**|**Type**|**Documentation** | ||
| 4733 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4734 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4735 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4736 | |Source|com: ReportingTaxonomyRef erenceType|Source provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) from. | ||
| 4737 | |Target|com: ReportingTaxonomyRef erenceType|Target provides a reference to the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] which items are (% style="color:#e74c3c" %)mapped(%%) to. | ||
| 4738 | |ReportingCategoryMap|ReportingCategoryMap Type|ReportingCategoryMap defines the structure of a (% style="color:#e74c3c" %)map(%%) which identifies relationships between reporting [[categories>>doc:sdmx:Glossary.Category.WebHome]] in different reporting taxonomies. | ||
| 4739 | |||
| 4740 | **ReportingCategoryMapType: **ReportingCategoryMapType defines the structure for (% style="color:#e74c3c" %)mapping(%%) two reporting [[categories>>doc:sdmx:Glossary.Category.WebHome]]. A local reference is provided both the source and target [[category>>doc:sdmx:Glossary.Category.WebHome]]. | ||
| 4741 | |||
| 4742 | Derivation: | ||
| 4743 | //com:AnnotableType// (extension) | ||
| 4744 | //ItemAssociationType// (restriction) | ||
| 4745 | ReportingCategoryMapType | ||
| 4746 | |||
| 4747 | Content: | ||
| 4748 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Source, Target | ||
| 4749 | |||
| 4750 | Element Documentation: | ||
| 4751 | |||
| 4752 | |**Name**|**Type**|**Documentation** | ||
| 4753 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4754 | |Source|com: LocalReportingCatego ryReferenceType|Source provides a local reference (id only) to an item from the source [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) to another item. | ||
| 4755 | |Target|com: LocalReportingCatego ryReferenceType|Target provides a local reference (id only) to an item from the target [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] in the [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)map(%%) which is being (% style="color:#e74c3c" %)mapped(%%) from another item. | ||
| 4756 | |||
| 4757 | //**HybridCodelistMapBaseType**//**: **HybridCodelistMapBaseType is an abstract base type which forms the basis for the HybridCodelistMapType. | ||
| 4758 | |||
| 4759 | Derivation: | ||
| 4760 | //com:AnnotableType// (extension) | ||
| 4761 | //IdentifiableType// (extension) | ||
| 4762 | //NameableType// (restriction) | ||
| 4763 | //HybridCodelistMapBaseType// | ||
| 4764 | |||
| 4765 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4766 | id, urn?, uri? | ||
| 4767 | |||
| 4768 | Content: | ||
| 4769 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 4770 | |||
| 4771 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4772 | |||
| 4773 | |**Name**|**Type**|**Documentation** | ||
| 4774 | |id|com:IDType|The id is the identifier for the object. | ||
| 4775 | |urn|xs:anyURI|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). | ||
| 4776 | |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. | ||
| 4777 | |||
| 4778 | Element Documentation: | ||
| 4779 | |||
| 4780 | |**Name**|**Type**|**Documentation** | ||
| 4781 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4782 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4783 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4784 | |||
| 4785 | **HybridCodelistMapType: **HybridCodelistMapType defines the structure of a (% style="color:#e74c3c" %)map(%%) which relates [[codes>>doc:sdmx:Glossary.Code.WebHome]] (possibly hierarchical) from different [[code>>doc:sdmx:Glossary.Code.WebHome]] lists. | ||
| 4786 | |||
| 4787 | Derivation: | ||
| 4788 | //com:AnnotableType// (extension) | ||
| 4789 | //IdentifiableType// (extension) | ||
| 4790 | //NameableType// (restriction) | ||
| 4791 | //HybridCodelistMapBaseType// (extension) | ||
| 4792 | HybridCodelistMapType | ||
| 4793 | |||
| 4794 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4795 | id, urn?, uri? | ||
| 4796 | |||
| 4797 | Content: | ||
| 4798 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Source, Target, HybridCodeMap+ | ||
| 4799 | |||
| 4800 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4801 | |||
| 4802 | |**Name**|**Type**|**Documentation** | ||
| 4803 | |id|com:IDType|The id is the identifier for the object. | ||
| 4804 | |urn|xs:anyURI|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). | ||
| 4805 | |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. | ||
| 4806 | |||
| 4807 | Element Documentation: | ||
| 4808 | |||
| 4809 | |**Name**|**Type**|**Documentation** | ||
| 4810 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4811 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4812 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4813 | |Source|com: AnyCodelistReference Type|Source provides a reference to either a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] or a hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], from which the [[codes>>doc:sdmx:Glossary.Code.WebHome]] are to be (% style="color:#e74c3c" %)mapped(%%). | ||
| 4814 | |Target|com: AnyCodelistReference Type|Target provides a reference to either a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] or a hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], to which the source [[codes>>doc:sdmx:Glossary.Code.WebHome]] are to be (% style="color:#e74c3c" %)mapped(%%). | ||
| 4815 | |HybridCodeMap|HybridCodeMapType|HybridCodeMap defines the relationship of a [[code>>doc:sdmx:Glossary.Code.WebHome]] in the source list to [[code>>doc:sdmx:Glossary.Code.WebHome]] in the target list. | ||
| 4816 | |||
| 4817 | **HybridCodeMapType: **CodeMapType defines the structure for associating a [[code>>doc:sdmx:Glossary.Code.WebHome]] from a source [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] to a [[code>>doc:sdmx:Glossary.Code.WebHome]] in a target [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. Note that either of these may come from a hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. | ||
| 4818 | |||
| 4819 | Derivation: | ||
| 4820 | //com:AnnotableType// (extension) | ||
| 4821 | HybridCodeMapType | ||
| 4822 | |||
| 4823 | Content: | ||
| 4824 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Source, Target | ||
| 4825 | |||
| 4826 | Element Documentation: | ||
| 4827 | |||
| 4828 | |**Name**|**Type**|**Documentation** | ||
| 4829 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4830 | |Source|com: AnyLocalCodeReferenc eType|Source provides a local reference to the [[code>>doc:sdmx:Glossary.Code.WebHome]] which is to be (% style="color:#e74c3c" %)mapped(%%). If this [[code>>doc:sdmx:Glossary.Code.WebHome]] is from a hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], a reference to the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] in which it is defined must also be provided. | ||
| 4831 | |Target|com: AnyLocalCodeReferenc eType|Target provides a local reference to the [[code>>doc:sdmx:Glossary.Code.WebHome]] to which the source [[code>>doc:sdmx:Glossary.Code.WebHome]] is (% style="color:#e74c3c" %)mapped(%%). If this [[code>>doc:sdmx:Glossary.Code.WebHome]] is from a hierarchical [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], a reference to the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] in which it is defined must also be provided. | ||
| 4832 | |||
| 4833 | //**StructureMapBaseType**//**: **StructureMapBaseType is an abstract base type which forms the basis for the StructureMapType. | ||
| 4834 | |||
| 4835 | Derivation: | ||
| 4836 | //com:AnnotableType// (extension) | ||
| 4837 | //IdentifiableType// (extension) | ||
| 4838 | //NameableType// (restriction) | ||
| 4839 | //StructureMapBaseType// | ||
| 4840 | |||
| 4841 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4842 | id, urn?, uri? | ||
| 4843 | |||
| 4844 | Content: | ||
| 4845 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description* | ||
| 4846 | |||
| 4847 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4848 | |||
| 4849 | |**Name**|**Type**|**Documentation** | ||
| 4850 | |id|com:IDType|The id is the identifier for the object. | ||
| 4851 | |urn|xs:anyURI|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). | ||
| 4852 | |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. | ||
| 4853 | |||
| 4854 | Element Documentation: | ||
| 4855 | |||
| 4856 | |**Name**|**Type**|**Documentation** | ||
| 4857 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4858 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4859 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4860 | |||
| 4861 | **StructureMapType: **StructureMapType defines the structure for (% style="color:#e74c3c" %)mapping(%%) [[components>>doc:sdmx:Glossary.Component.WebHome]] of one structure to [[components>>doc:sdmx:Glossary.Component.WebHome]] of another structure. A structure may be referenced directly meaning the (% style="color:#e74c3c" %)map(%%) applies wherever the structure is used, or it may be a reference via a structure usage meaning the (% style="color:#e74c3c" %)map(%%) only applies within the context of that usage. Using the related structures, one can make extrapolations between (% style="color:#e74c3c" %)maps(%%). For example, if key families, A, B, and C, are all grouped in a related structures container, then a (% style="color:#e74c3c" %)map(%%) from key family A to C and a (% style="color:#e74c3c" %)map(%%) from key family B to C could be used to infer a relation between key family A to C. | ||
| 4862 | |||
| 4863 | Derivation: | ||
| 4864 | //com:AnnotableType// (extension) | ||
| 4865 | //IdentifiableType// (extension) | ||
| 4866 | //NameableType// (restriction) | ||
| 4867 | //StructureMapBaseType// (extension) | ||
| 4868 | StructureMapType | ||
| 4869 | |||
| 4870 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4871 | id, urn?, uri?, isExtension? | ||
| 4872 | |||
| 4873 | Content: | ||
| 4874 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Source, Target, ComponentMap+ | ||
| 4875 | |||
| 4876 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4877 | |||
| 4878 | |**Name**|**Type**|**Documentation** | ||
| 4879 | |id|com:IDType|The id is the identifier for the object. | ||
| 4880 | |urn|xs:anyURI|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). | ||
| 4881 | |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. | ||
| 4882 | |isExtension (default: false)|xs:boolean|The isExtension [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], when true, indicates that the target structure definition inherits all properties of the referenced structure definition, and may have additional [[components>>doc:sdmx:Glossary.Component.WebHome]]. Note that this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] may only be set to true if the structure (% style="color:#e74c3c" %)map(%%) has a source structure and a target structure of either two key families or two [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. It is not possible inherit the underlying (% style="color:#e74c3c" %)concepts(%%) of [[components>>doc:sdmx:Glossary.Component.WebHome]] between the two type of structures using this mechanism. | ||
| 4883 | |||
| 4884 | Element Documentation: | ||
| 4885 | |||
| 4886 | |**Name**|**Type**|**Documentation** | ||
| 4887 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4888 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4889 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4890 | |Source|com: StructureOrUsageRefe renceType|Source provides a reference to a structure (data or metadata) or a structure usage ([[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]) from which [[components>>doc:sdmx:Glossary.Component.WebHome]] defined by the actual structure are to (% style="color:#e74c3c" %)mapped(%%). | ||
| 4891 | |Target|com: StructureOrUsageRefe renceType|Target provides a reference to a structure (data or metadata) or a structure usage ([[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]) to which [[components>>doc:sdmx:Glossary.Component.WebHome]] from the source are to (% style="color:#e74c3c" %)mapped(%%). | ||
| 4892 | |ComponentMap|ComponentMapType|ComponentMap defines the relationship between the [[components>>doc:sdmx:Glossary.Component.WebHome]] of the source and target structures, including information on how the value from the source [[component>>doc:sdmx:Glossary.Component.WebHome]] relates to values in the target [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 4893 | |||
| 4894 | **ComponentMapType: **ComponentMapType defines the structure for relating a [[component>>doc:sdmx:Glossary.Component.WebHome]] in a source structure to a [[component>>doc:sdmx:Glossary.Component.WebHome]] in a target structure. | ||
| 4895 | |||
| 4896 | Derivation: | ||
| 4897 | //com:AnnotableType// (extension) | ||
| 4898 | ComponentMapType | ||
| 4899 | |||
| 4900 | Content: | ||
| 4901 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Source, Target, RepresentationMapping? | ||
| 4902 | |||
| 4903 | Element Documentation: | ||
| 4904 | |||
| 4905 | |**Name**|**Type**|**Documentation** | ||
| 4906 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4907 | |Source|com: LocalComponentListCo mponentReferenceType| | ||
| 4908 | |Target|com: LocalComponentListCo mponentReferenceType| | ||
| 4909 | |RepresentationMappin g|RepresentationMapTyp e|RepresentationMapping describes the (% style="color:#e74c3c" %)mapping(%%) rules to (% style="color:#e74c3c" %)map(%%) the value of the source [[component>>doc:sdmx:Glossary.Component.WebHome]] to the target [[component>>doc:sdmx:Glossary.Component.WebHome]]. Note that is a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)mapping(%%) is not supplied, then the value of the source [[component>>doc:sdmx:Glossary.Component.WebHome]] is (% style="color:#e74c3c" %)mapped(%%) directly to the value of the target [[component>>doc:sdmx:Glossary.Component.WebHome]] without any manipulation. | ||
| 4910 | |||
| 4911 | **RepresentationMapType: **RepresentationMapType describes the structure of the (% style="color:#e74c3c" %)mapping(%%) of the value of a source to [[component>>doc:sdmx:Glossary.Component.WebHome]] to a target [[component>>doc:sdmx:Glossary.Component.WebHome]]. Either a reference to another (% style="color:#e74c3c" %)map(%%) defined within the containing [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]] or a description of the source and target text formats must be provided. Note that for key family [[components>>doc:sdmx:Glossary.Component.WebHome]], only a reference to a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] (% style="color:#e74c3c" %)map(%%) is relevant, since that is the only type of coded [[representation>>doc:sdmx:Glossary.Representation.WebHome]] allowed in a key family. | ||
| 4912 | |||
| 4913 | Content: | ||
| 4914 | (CodelistMap | (ToTextFormat, ToValueType) | ValueMap) | ||
| 4915 | |||
| 4916 | Element Documentation: | ||
| 4917 | |||
| 4918 | |**Name**|**Type**|**Documentation** | ||
| 4919 | |CodelistMap|com: LocalCodelistMapRefe renceType|CodelistMap references a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] (% style="color:#e74c3c" %)map(%%) defined in the same [[structure set>>doc:sdmx:Glossary.Structure set.WebHome]] which (% style="color:#e74c3c" %)maps(%%) the enumeration of the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the source [[component>>doc:sdmx:Glossary.Component.WebHome]] to the enumeration of the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target [[component>>doc:sdmx:Glossary.Component.WebHome]]. | ||
| 4920 | |ToTextFormat|TextFormatType|ToTextFormat describes the un-coded [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the target to which the value of the referenced [[component>>doc:sdmx:Glossary.Component.WebHome]] should be transformed. | ||
| 4921 | |ToValueType|ToValueTypeType|ToValueType notes whether the value, name, or description of the source value should be used in the target value. | ||
| 4922 | |ValueMap|ValueMapType|ValueMap provides for a simple (% style="color:#e74c3c" %)mapping(%%) of a source value to a target value without having to define a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] (% style="color:#e74c3c" %)map(%%). This is available to allow mappings in situations such as the source or target is not being formally coded, or the source and/or target being a [[measure>>doc:sdmx:Glossary.Measure.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] in which case its [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is not mappable from a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] (% style="color:#e74c3c" %)map(%%). | ||
| 4923 | |||
| 4924 | **ValueMapType: **ValueMapType contains a collection of value mappings, which give a source and target value. | ||
| 4925 | |||
| 4926 | Content: | ||
| 4927 | ValueMapping+ | ||
| 4928 | |||
| 4929 | Element Documentation: | ||
| 4930 | |||
| 4931 | |**Name**|**Type**|**Documentation** | ||
| 4932 | |ValueMapping|ValueMappingType|ValueMapping provides a source and target value for the purpose of (% style="color:#e74c3c" %)mapping(%%). | ||
| 4933 | |||
| 4934 | **ValueMappingType: **ValueMappingType specifies the relationship between two values as a source and target. | ||
| 4935 | |||
| 4936 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4937 | source, target | ||
| 4938 | |||
| 4939 | Content: | ||
| 4940 | {Empty} | ||
| 4941 | |||
| 4942 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4943 | |||
| 4944 | |**Name**|**Type**|**Documentation** | ||
| 4945 | |source|xs:string| | ||
| 4946 | |target|xs:string| | ||
| 4947 | |||
| 4948 | //**VtlDefinitionSchemeType**//**: **VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] schemes. | ||
| 4949 | |||
| 4950 | Derivation: | ||
| 4951 | //com:AnnotableType// (extension) | ||
| 4952 | //IdentifiableType// (extension) | ||
| 4953 | //NameableType// (extension) | ||
| 4954 | //VersionableType// (restriction) | ||
| 4955 | //MaintainableBaseType// (extension) | ||
| 4956 | //MaintainableType// (extension) | ||
| 4957 | //ItemSchemeType// (extension) | ||
| 4958 | //VtlDefinitionSchemeType// | ||
| 4959 | |||
| 4960 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 4961 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 4962 | |||
| 4963 | Content: | ||
| 4964 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, //Item*// | ||
| 4965 | |||
| 4966 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 4967 | |||
| 4968 | |**Name**|**Type**|**Documentation** | ||
| 4969 | |id|com:IDType|The id is the identifier for the object. | ||
| 4970 | |urn|xs:anyURI|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). | ||
| 4971 | |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. | ||
| 4972 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 4973 | |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(%%). | ||
| 4974 | |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(%%). | ||
| 4975 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 4976 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 4977 | |[[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. | ||
| 4978 | |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. | ||
| 4979 | |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. | ||
| 4980 | |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 key family in the context of a constraint. | ||
| 4981 | |vtlVersion|xs:string|Identifies the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%) to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%). | ||
| 4982 | |||
| 4983 | Element Documentation: | ||
| 4984 | |||
| 4985 | |**Name**|**Type**|**Documentation** | ||
| 4986 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 4987 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4988 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 4989 | |//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. | ||
| 4990 | |||
| 4991 | //**TransformationSchemeBaseType**//**: **TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations. | ||
| 4992 | |||
| 4993 | Derivation: | ||
| 4994 | //com:AnnotableType// (extension) | ||
| 4995 | //IdentifiableType// (extension) | ||
| 4996 | //NameableType// (extension) | ||
| 4997 | //VersionableType// (restriction) | ||
| 4998 | //MaintainableBaseType// (extension) | ||
| 4999 | //MaintainableType// (extension) | ||
| 5000 | //ItemSchemeType// (extension) | ||
| 5001 | //VtlDefinitionSchemeType// (restriction) | ||
| 5002 | //TransformationSchemeBaseType// | ||
| 5003 | |||
| 5004 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 5005 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 5006 | |||
| 5007 | Content: | ||
| 5008 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Transformation* | ||
| 5009 | |||
| 5010 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 5011 | |||
| 5012 | |**Name**|**Type**|**Documentation** | ||
| 5013 | |id|com:IDType|The id is the identifier for the object. | ||
| 5014 | |urn|xs:anyURI|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). | ||
| 5015 | |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. | ||
| 5016 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 5017 | |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(%%). | ||
| 5018 | |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(%%). | ||
| 5019 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 5020 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 5021 | |[[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. | ||
| 5022 | |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. | ||
| 5023 | |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. | ||
| 5024 | |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 key family in the context of a constraint. | ||
| 5025 | |vtlVersion|xs:string|Identifies the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%) to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%). | ||
| 5026 | |||
| 5027 | Element Documentation: | ||
| 5028 | |||
| 5029 | |**Name**|**Type**|**Documentation** | ||
| 5030 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 5031 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5032 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5033 | |Transformation|TransformationType|Transformation describes the details of a single transformation within a transformation scheme. | ||
| 5034 | |||
| 5035 | **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. | ||
| 5036 | |||
| 5037 | Derivation: | ||
| 5038 | //com:AnnotableType// (extension) | ||
| 5039 | //IdentifiableType// (extension) | ||
| 5040 | //NameableType// (extension) | ||
| 5041 | //VersionableType// (restriction) | ||
| 5042 | //MaintainableBaseType// (extension) | ||
| 5043 | //MaintainableType// (extension) | ||
| 5044 | //ItemSchemeType// (extension) | ||
| 5045 | //VtlDefinitionSchemeType// (restriction) | ||
| 5046 | //TransformationSchemeBaseType// (extension) | ||
| 5047 | TransformationSchemeType | ||
| 5048 | |||
| 5049 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 5050 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 5051 | |||
| 5052 | Content: | ||
| 5053 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Transformation*, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme*, UserDefinedOperatorScheme* | ||
| 5054 | |||
| 5055 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 5056 | |||
| 5057 | |**Name**|**Type**|**Documentation** | ||
| 5058 | |id|com:IDType|The id is the identifier for the object. | ||
| 5059 | |urn|xs:anyURI|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). | ||
| 5060 | |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. | ||
| 5061 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 5062 | |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(%%). | ||
| 5063 | |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(%%). | ||
| 5064 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 5065 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 5066 | |[[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. | ||
| 5067 | |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. | ||
| 5068 | |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. | ||
| 5069 | |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 key family in the context of a constraint. | ||
| 5070 | |vtlVersion|xs:string|Identifies the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%) to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)version(%%). | ||
| 5071 | |||
| 5072 | Element Documentation: | ||
| 5073 | |||
| 5074 | |**Name**|**Type**|**Documentation** | ||
| 5075 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 5076 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5077 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5078 | |Transformation|TransformationType|Transformation describes the details of a single transformation within a transformation scheme. | ||
| 5079 | |VtlMappingScheme|com: VtlMappingSchemeRefe renceType|References a [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)mapping(%%) scheme which defines aliases for given [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that are used in the transformations as well as the (% style="color:#e74c3c" %)mapping(%%) methods used when converting between [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] and [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] data structures. All aliases must be defined in the referenced scheme. This also must be used if the basic (% style="color:#e74c3c" %)mapping(%%) methods are not used. | ||
| 5080 | |NamePersonalisationS cheme|com: NamePersonalisationS chemeReferenceType|References a name personalisation scheme, which defines the overriding of some standard [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] names (to be assigned to some [[measures>>doc:sdmx:Glossary.Measure.WebHome]] and/or [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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. | ||
| 5081 | |CustomTypeScheme|com: CustomTypeSchemeRefe renceType|References a custom type scheme which defines custom conversions of [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] scalar types to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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. | ||
| 5082 | |RulesetScheme|com: RulesetSchemeReferen ceType|References a ruleset scheme that defines one or more previously defined rulesets which can be invoked by [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] 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. | ||
| 5083 | |UserDefinedOperatorS cheme|com: UserDefinedOperatorS chemeReferenceType|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. | ||
| 5084 | |||
| 5085 | **TransformationType: **TransformationType defines the structure of a transformation. A transformation is an assignment of a [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] expression to a specific result. | ||
| 5086 | |||
| 5087 | Derivation: | ||
| 5088 | //com:AnnotableType// (extension) | ||
| 5089 | //IdentifiableType// (extension) | ||
| 5090 | //NameableType// (restriction) | ||
| 5091 | //ItemBaseType// (extension) | ||
| 5092 | //ItemType// (restriction) | ||
| 5093 | //UnnestedItemType// (extension) | ||
| 5094 | TransformationType | ||
| 5095 | |||
| 5096 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 5097 | id, urn?, uri?, isPersistent | ||
| 5098 | |||
| 5099 | Content: | ||
| 5100 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, Expression, Result | ||
| 5101 | |||
| 5102 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 5103 | |||
| 5104 | |**Name**|**Type**|**Documentation** | ||
| 5105 | |id|com:IDType|The id is the identifier for the object. | ||
| 5106 | |urn|xs:anyURI|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). | ||
| 5107 | |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. | ||
| 5108 | |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. | ||
| 5109 | |||
| 5110 | Element Documentation: | ||
| 5111 | |||
| 5112 | |**Name**|**Type**|**Documentation** | ||
| 5113 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 5114 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5115 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5116 | |Expression|xs:string|The right-hand side of the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] statement. This is expression that is executed for this transformation. It include references to operands and other [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. The expression may contain references to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] using the reduced URN format; see Section 6 [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards ("[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Technical Notes"), 10.2.3 ("Abbreviation of the URN"). | ||
| 5117 | |Result|xs:string|The left-hand side of the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] statement. This identifies the result [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], which may be used in subsequent transformations. If the result is an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], the is expressed using the alias; see Section 6 [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards ("[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Technical Notes"), 10.2.3 ("Abbreviation of the URN"). | ||
| 5118 | |||
| 5119 | **VtlMappingSchemeType: **VtlMappingSchemeType defines a set of mappings between [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] and [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]]. | ||
| 5120 | |||
| 5121 | Derivation: | ||
| 5122 | //com:AnnotableType// (extension) | ||
| 5123 | //IdentifiableType// (extension) | ||
| 5124 | //NameableType// (extension) | ||
| 5125 | //VersionableType// (restriction) | ||
| 5126 | //MaintainableBaseType// (extension) | ||
| 5127 | //MaintainableType// (extension) | ||
| 5128 | //ItemSchemeType// (restriction) | ||
| 5129 | VtlMappingSchemeType | ||
| 5130 | |||
| 5131 | [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: | ||
| 5132 | id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isFinal?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, isPartial? | ||
| 5133 | |||
| 5134 | Content: | ||
| 5135 | com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, com:Name+, com:Description*, VtlMapping* | ||
| 5136 | |||
| 5137 | [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: | ||
| 5138 | |||
| 5139 | |**Name**|**Type**|**Documentation** | ||
| 5140 | |id|com:IDType|The id is the identifier for the object. | ||
| 5141 | |urn|xs:anyURI|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). | ||
| 5142 | |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. | ||
| 5143 | |(%%)(% style="color:#e74c3c" %)version(%%) (default: 1.0)|com:VersionType|This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the (% style="color:#e74c3c" %)version(%%) number is defaulted to 1.0. | ||
| 5144 | |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(%%). | ||
| 5145 | |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(%%). | ||
| 5146 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object. | ||
| 5147 | |isFinal (default: false)|xs:boolean|The isFinal [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 5148 | |[[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. | ||
| 5149 | |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. | ||
| 5150 | |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. | ||
| 5151 | |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 key family in the context of a constraint. | ||
| 5152 | |||
| 5153 | Element Documentation: | ||
| 5154 | |||
| 5155 | |**Name**|**Type**|**Documentation** | ||
| 5156 | |com:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|com: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. | ||
| 5157 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5158 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5159 | |VtlMapping|VtlMappingType|VtlMapping details a (% style="color:#e74c3c" %)mapping(%%) between [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] and [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] transformation. | ||
| 5160 | |||
| 5161 | **VtlMappingType: **VtlMappingType defines the structure of a single (% style="color:#e74c3c" %)mapping(%%) between the reference to a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] made from [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] transformations, rulesets, user defined operators and the corresponding [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structure identifier. These are used to assign an alternative names to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Codelists>>doc:sdmx:Glossary.Code list.WebHome]], [[Concept Schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], or (% style="color:#e74c3c" %)Concepts(%%). Although are distinct sub-classes in the Information Model, this structure serves to express them all. The references [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] serves to distinguish which type of sub-class (VtlDatflowMapping, VtlCodelistMapping, or VtlConceptSchemeMapping) is being described. When this is used to assign an alias for a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], this can also be used to indicate the methods used to convert the data structure from [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] to [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] and vice-versa. Finally, this can be used to override the deault Basic (% style="color:#e74c3c" %)mapping(%%) methods used for [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] by utilizing the GenericDataflow element in place of a reference to a specific [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]. | ||
| 5162 | |||
| 5163 | Derivation: | ||
| 5164 | //com:AnnotableType// (extension) | ||
| 5165 | //IdentifiableType// (extension) | ||
| 5166 | //NameableType// (restriction) | ||
| 5167 | //ItemBaseType// (extension) | ||
| 5168 | //ItemType// (restriction) | ||
| 5169 | //UnnestedItemType// (extension) | ||
| 5170 | VtlMappingType | ||
| 5171 | |||
| 5172 | Attributes: | ||
| 5173 | id, urn?, uri?, alias | ||
| 5174 | |||
| 5175 | Content: | ||
| 5176 | com:Annotations?, com:Name+, com:Description*, ( ( (Dataflow | GenericDataflow), ToVtlMapping?, FromVtlMapping?) | Codelist | ConceptScheme | Concept) | ||
| 5177 | |||
| 5178 | Attribute Documentation: | ||
| 5179 | |||
| 5180 | |**Name**|**Type**|**Documentation** | ||
| 5181 | |id|com:IDType|The id is the identifier for the object. | ||
| 5182 | |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5183 | |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. | ||
| 5184 | |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. | ||
| 5185 | |||
| 5186 | Element Documentation: | ||
| 5187 | |||
| 5188 | |**Name**|**Type**|**Documentation** | ||
| 5189 | |com:Annotations|com: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. | ||
| 5190 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5191 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5192 | |Dataflow|com: DataflowReferenceTyp e|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. | ||
| 5193 | |GenericDataflow|com: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. | ||
| 5194 | |ToVtlMapping|ToVtlMappingType|Describes the mapping from a SDMX dataflow to a VTL data structure. | ||
| 5195 | |FromVtlMapping|FromVtlMappingType|Describes the mapping to a SDMX dataflow from a VTL data structure. | ||
| 5196 | |Codelist|com: CodelistReferenceTyp e|A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping. | ||
| 5197 | |ConceptScheme|com: ConceptSchemeReferen ceType|A reference to the SDMX Concept Scheme that the mapping is defined for. This is used to create a VtlConceptSchemeMapping. | ||
| 5198 | |Concept|com: ConceptReferenceType|A reference to the SDMX Concept that the mapping is defined for. This is used to create a VtlConceptMapping. | ||
| 5199 | |||
| 5200 | **ToVtlMappingType: **ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL. | ||
| 5201 | |||
| 5202 | Attributes: | ||
| 5203 | method? | ||
| 5204 | |||
| 5205 | Content: | ||
| 5206 | ToVtlSubSpace? | ||
| 5207 | |||
| 5208 | Attribute Documentation: | ||
| 5209 | |||
| 5210 | |**Name**|**Type**|**Documentation** | ||
| 5211 | |method|ToVtlMappingMethodTy pe|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. | ||
| 5212 | |||
| 5213 | Element Documentation: | ||
| 5214 | |||
| 5215 | |**Name**|**Type**|**Documentation** | ||
| 5216 | |ToVtlSubSpace|SpaceKeyType|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. | ||
| 5217 | |||
| 5218 | **FromVtlMappingType: **FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX. | ||
| 5219 | |||
| 5220 | Attributes: | ||
| 5221 | method? | ||
| 5222 | |||
| 5223 | Content: | ||
| 5224 | FromVtlSuperSpace? | ||
| 5225 | |||
| 5226 | Attribute Documentation: | ||
| 5227 | |||
| 5228 | |**Name**|**Type**|**Documentation** | ||
| 5229 | |method|FromVtlMappingMethod Type|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. | ||
| 5230 | |||
| 5231 | Element Documentation: | ||
| 5232 | |||
| 5233 | |**Name**|**Type**|**Documentation** | ||
| 5234 | |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. | ||
| 5235 | |||
| 5236 | **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. | ||
| 5237 | |||
| 5238 | Content: | ||
| 5239 | Key+ | ||
| 5240 | |||
| 5241 | Element Documentation: | ||
| 5242 | |||
| 5243 | |**Name**|**Type**|**Documentation** | ||
| 5244 | |Key|com: SingleNCNameIDType|A reference to a dimension by its identifier. | ||
| 5245 | |||
| 5246 | **NamePersonalisationSchemeType: **NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations. | ||
| 5247 | |||
| 5248 | Derivation: | ||
| 5249 | //com:AnnotableType// (extension) | ||
| 5250 | //IdentifiableType// (extension) | ||
| 5251 | //NameableType// (extension) | ||
| 5252 | //VersionableType// (restriction) | ||
| 5253 | //MaintainableBaseType// (extension) | ||
| 5254 | //MaintainableType// (extension) | ||
| 5255 | //ItemSchemeType// (extension) | ||
| 5256 | //VtlDefinitionSchemeType// (restriction) | ||
| 5257 | NamePersonalisationSchemeType | ||
| 5258 | |||
| 5259 | Attributes: | ||
| 5260 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 5261 | |||
| 5262 | Content: | ||
| 5263 | com:Annotations?, com:Name+, com:Description*, NamePersonalisation* | ||
| 5264 | |||
| 5265 | Attribute Documentation: | ||
| 5266 | |||
| 5267 | |**Name**|**Type**|**Documentation** | ||
| 5268 | |id|com:IDType|The id is the identifier for the object. | ||
| 5269 | |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5270 | |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. | ||
| 5271 | |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. | ||
| 5272 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5273 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5274 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5275 | |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 5276 | |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. | ||
| 5277 | |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. | ||
| 5278 | |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. | ||
| 5279 | |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 key family in the context of a constraint. | ||
| 5280 | |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. | ||
| 5281 | |||
| 5282 | Element Documentation: | ||
| 5283 | |||
| 5284 | |**Name**|**Type**|**Documentation** | ||
| 5285 | |com:Annotations|com: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. | ||
| 5286 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5287 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5288 | |NamePersonalisation|NamePersonalisationT ype|NamePersonalisation details a name personalisation that is used in a transformation. | ||
| 5289 | |||
| 5290 | **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. | ||
| 5291 | |||
| 5292 | Derivation: | ||
| 5293 | //com:AnnotableType// (extension) | ||
| 5294 | //IdentifiableType// (extension) | ||
| 5295 | //NameableType// (restriction) | ||
| 5296 | //ItemBaseType// (extension) | ||
| 5297 | //ItemType// (restriction) | ||
| 5298 | //UnnestedItemType// (extension) | ||
| 5299 | NamePersonalisationType | ||
| 5300 | |||
| 5301 | Attributes: | ||
| 5302 | id, urn?, uri?, vtlArtefact | ||
| 5303 | |||
| 5304 | Content: | ||
| 5305 | com:Annotations?, com:Name+, com:Description*, VtlDefaultName, PersonalisedName | ||
| 5306 | |||
| 5307 | Attribute Documentation: | ||
| 5308 | |||
| 5309 | |**Name**|**Type**|**Documentation** | ||
| 5310 | |id|com:IDType|The id is the identifier for the object. | ||
| 5311 | |urn|xs:anyURI|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 | |vtlArtefact|xs:string|Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable. | ||
| 5314 | |||
| 5315 | Element Documentation: | ||
| 5316 | |||
| 5317 | |**Name**|**Type**|**Documentation** | ||
| 5318 | |com:Annotations|com: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. | ||
| 5319 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5320 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5321 | |VtlDefaultName|xs:string|Provides the VTL standard name that is being personalised. | ||
| 5322 | |PersonalisedName|xs:string|Provides the personalised name that is used in place of the VTL standard name in the transformation expressions. | ||
| 5323 | |||
| 5324 | //**RulesetSchemeBaseType**//**: **RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets. | ||
| 5325 | |||
| 5326 | Derivation: | ||
| 5327 | //com:AnnotableType// (extension) | ||
| 5328 | //IdentifiableType// (extension) | ||
| 5329 | //NameableType// (extension) | ||
| 5330 | //VersionableType// (restriction) | ||
| 5331 | //MaintainableBaseType// (extension) | ||
| 5332 | //MaintainableType// (extension) | ||
| 5333 | //ItemSchemeType// (extension) | ||
| 5334 | //VtlDefinitionSchemeType// (restriction) | ||
| 5335 | //RulesetSchemeBaseType// | ||
| 5336 | |||
| 5337 | Attributes: | ||
| 5338 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 5339 | |||
| 5340 | Content: | ||
| 5341 | com:Annotations?, com:Name+, com:Description*, Ruleset* | ||
| 5342 | |||
| 5343 | Attribute Documentation: | ||
| 5344 | |||
| 5345 | |**Name**|**Type**|**Documentation** | ||
| 5346 | |id|com:IDType|The id is the identifier for the object. | ||
| 5347 | |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5348 | |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. | ||
| 5349 | |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. | ||
| 5350 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5351 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5352 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5353 | |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 5354 | |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. | ||
| 5355 | |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. | ||
| 5356 | |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. | ||
| 5357 | |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 key family in the context of a constraint. | ||
| 5358 | |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. | ||
| 5359 | |||
| 5360 | Element Documentation: | ||
| 5361 | |||
| 5362 | |**Name**|**Type**|**Documentation** | ||
| 5363 | |com:Annotations|com: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. | ||
| 5364 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5365 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5366 | |Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme. | ||
| 5367 | |||
| 5368 | **RulesetSchemeType: **RulesetSchemeType defines a collection of rulesets that are used in transformations. | ||
| 5369 | |||
| 5370 | Derivation: | ||
| 5371 | //com:AnnotableType// (extension) | ||
| 5372 | //IdentifiableType// (extension) | ||
| 5373 | //NameableType// (extension) | ||
| 5374 | //VersionableType// (restriction) | ||
| 5375 | //MaintainableBaseType// (extension) | ||
| 5376 | //MaintainableType// (extension) | ||
| 5377 | //ItemSchemeType// (extension) | ||
| 5378 | //VtlDefinitionSchemeType// (restriction) | ||
| 5379 | //RulesetSchemeBaseType// (extension) | ||
| 5380 | RulesetSchemeType | ||
| 5381 | |||
| 5382 | Attributes: | ||
| 5383 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 5384 | |||
| 5385 | Content: | ||
| 5386 | com:Annotations?, com:Name+, com:Description*, Ruleset*, VtlMappingScheme? | ||
| 5387 | |||
| 5388 | Attribute Documentation: | ||
| 5389 | |||
| 5390 | |**Name**|**Type**|**Documentation** | ||
| 5391 | |id|com:IDType|The id is the identifier for the object. | ||
| 5392 | |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5393 | |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. | ||
| 5394 | |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. | ||
| 5395 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5396 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5397 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5398 | |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 5399 | |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. | ||
| 5400 | |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. | ||
| 5401 | |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. | ||
| 5402 | |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 key family in the context of a constraint. | ||
| 5403 | |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. | ||
| 5404 | |||
| 5405 | Element Documentation: | ||
| 5406 | |||
| 5407 | |**Name**|**Type**|**Documentation** | ||
| 5408 | |com:Annotations|com: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. | ||
| 5409 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5410 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5411 | |Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme. | ||
| 5412 | |VtlMappingScheme|com: VtlMappingSchemeRefe renceType|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. | ||
| 5413 | |||
| 5414 | **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. | ||
| 5415 | |||
| 5416 | Derivation: | ||
| 5417 | //com:AnnotableType// (extension) | ||
| 5418 | //IdentifiableType// (extension) | ||
| 5419 | //NameableType// (restriction) | ||
| 5420 | //ItemBaseType// (extension) | ||
| 5421 | //ItemType// (restriction) | ||
| 5422 | //UnnestedItemType// (extension) | ||
| 5423 | RulesetType | ||
| 5424 | |||
| 5425 | Attributes: | ||
| 5426 | id, urn?, uri?, rulesetType, rulesetScope | ||
| 5427 | |||
| 5428 | Content: | ||
| 5429 | com:Annotations?, com:Name+, com:Description*, RulesetDefinition | ||
| 5430 | |||
| 5431 | Attribute Documentation: | ||
| 5432 | |||
| 5433 | |**Name**|**Type**|**Documentation** | ||
| 5434 | |id|com:IDType|The id is the identifier for the object. | ||
| 5435 | |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5436 | |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. | ||
| 5437 | |rulesetType|xs:string|The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical | ||
| 5438 | |rulesetScope|xs:string|This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable. | ||
| 5439 | |||
| 5440 | Element Documentation: | ||
| 5441 | |||
| 5442 | |**Name**|**Type**|**Documentation** | ||
| 5443 | |com:Annotations|com: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. | ||
| 5444 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5445 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5446 | |RulesetDefinition|xs:string|A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language. | ||
| 5447 | |||
| 5448 | //**UserDefinedOperatorSchemeBaseType**//**: **UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators. | ||
| 5449 | |||
| 5450 | Derivation: | ||
| 5451 | //com:AnnotableType// (extension) | ||
| 5452 | //IdentifiableType// (extension) | ||
| 5453 | //NameableType// (extension) | ||
| 5454 | //VersionableType// (restriction) | ||
| 5455 | //MaintainableBaseType// (extension) | ||
| 5456 | //MaintainableType// (extension) | ||
| 5457 | //ItemSchemeType// (extension) | ||
| 5458 | //VtlDefinitionSchemeType// (restriction) | ||
| 5459 | //UserDefinedOperatorSchemeBaseType// | ||
| 5460 | |||
| 5461 | Attributes: | ||
| 5462 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 5463 | |||
| 5464 | Content: | ||
| 5465 | com:Annotations?, com:Name+, com:Description*, UserDefinedOperator* | ||
| 5466 | |||
| 5467 | Attribute Documentation: | ||
| 5468 | |||
| 5469 | |**Name**|**Type**|**Documentation** | ||
| 5470 | |id|com:IDType|The id is the identifier for the object. | ||
| 5471 | |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5472 | |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. | ||
| 5473 | |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. | ||
| 5474 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5475 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5476 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5477 | |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 5478 | |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. | ||
| 5479 | |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. | ||
| 5480 | |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. | ||
| 5481 | |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 key family in the context of a constraint. | ||
| 5482 | |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. | ||
| 5483 | |||
| 5484 | Element Documentation: | ||
| 5485 | |||
| 5486 | |**Name**|**Type**|**Documentation** | ||
| 5487 | |com:Annotations|com: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 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5489 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5490 | |UserDefinedOperator|UserDefinedOperatorT ype|UserDefinedOperator details a user defined operators within a user defined operator scheme. | ||
| 5491 | |||
| 5492 | **UserDefinedOperatorSchemeType: **UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations. | ||
| 5493 | |||
| 5494 | Derivation: | ||
| 5495 | //com:AnnotableType// (extension) | ||
| 5496 | //IdentifiableType// (extension) | ||
| 5497 | //NameableType// (extension) | ||
| 5498 | //VersionableType// (restriction) | ||
| 5499 | //MaintainableBaseType// (extension) | ||
| 5500 | //MaintainableType// (extension) | ||
| 5501 | //ItemSchemeType// (extension) | ||
| 5502 | //VtlDefinitionSchemeType// (restriction) | ||
| 5503 | //UserDefinedOperatorSchemeBaseType// (extension) | ||
| 5504 | UserDefinedOperatorSchemeType | ||
| 5505 | |||
| 5506 | Attributes: | ||
| 5507 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 5508 | |||
| 5509 | Content: | ||
| 5510 | com:Annotations?, com:Name+, com:Description*, UserDefinedOperator*, VtlMappingScheme?, RulesetScheme* | ||
| 5511 | |||
| 5512 | Attribute Documentation: | ||
| 5513 | |||
| 5514 | |**Name**|**Type**|**Documentation** | ||
| 5515 | |id|com:IDType|The id is the identifier for the object. | ||
| 5516 | |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5517 | |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. | ||
| 5518 | |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. | ||
| 5519 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5520 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5521 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5522 | |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 5523 | |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. | ||
| 5524 | |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. | ||
| 5525 | |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. | ||
| 5526 | |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 key family in the context of a constraint. | ||
| 5527 | |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. | ||
| 5528 | |||
| 5529 | Element Documentation: | ||
| 5530 | |||
| 5531 | |**Name**|**Type**|**Documentation** | ||
| 5532 | |com:Annotations|com: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. | ||
| 5533 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5534 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5535 | |UserDefinedOperator|UserDefinedOperatorT ype|UserDefinedOperator details a user defined operators within a user defined operator scheme. | ||
| 5536 | |VtlMappingScheme|com: VtlMappingSchemeRefe renceType|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. | ||
| 5537 | |RulesetScheme|com: RulesetSchemeReferen ceType|References a ruleset scheme defining rulesets utilized in the user defined operators. | ||
| 5538 | |||
| 5539 | **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. | ||
| 5540 | |||
| 5541 | Derivation: | ||
| 5542 | //com:AnnotableType// (extension) | ||
| 5543 | //IdentifiableType// (extension) | ||
| 5544 | //NameableType// (restriction) | ||
| 5545 | //ItemBaseType// (extension) | ||
| 5546 | //ItemType// (restriction) | ||
| 5547 | //UnnestedItemType// (extension) | ||
| 5548 | UserDefinedOperatorType | ||
| 5549 | |||
| 5550 | Attributes: | ||
| 5551 | id, urn?, uri? | ||
| 5552 | |||
| 5553 | Content: | ||
| 5554 | com:Annotations?, com:Name+, com:Description*, OperatorDefinition | ||
| 5555 | |||
| 5556 | Attribute Documentation: | ||
| 5557 | |||
| 5558 | |**Name**|**Type**|**Documentation** | ||
| 5559 | |id|com:IDType|The id is the identifier for the object. | ||
| 5560 | |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5561 | |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. | ||
| 5562 | |||
| 5563 | Element Documentation: | ||
| 5564 | |||
| 5565 | |**Name**|**Type**|**Documentation** | ||
| 5566 | |com:Annotations|com: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. | ||
| 5567 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5568 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5569 | |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. | ||
| 5570 | |||
| 5571 | **CustomTypeSchemeType: **CustomTypeSchemeType defines a collection of custom types that are used in transformations. | ||
| 5572 | |||
| 5573 | Derivation: | ||
| 5574 | //com:AnnotableType// (extension) | ||
| 5575 | //IdentifiableType// (extension) | ||
| 5576 | //NameableType// (extension) | ||
| 5577 | //VersionableType// (restriction) | ||
| 5578 | //MaintainableBaseType// (extension) | ||
| 5579 | //MaintainableType// (extension) | ||
| 5580 | //ItemSchemeType// (extension) | ||
| 5581 | //VtlDefinitionSchemeType// (restriction) | ||
| 5582 | CustomTypeSchemeType | ||
| 5583 | |||
| 5584 | Attributes: | ||
| 5585 | id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion | ||
| 5586 | |||
| 5587 | Content: | ||
| 5588 | com:Annotations?, com:Name+, com:Description*, CustomType* | ||
| 5589 | |||
| 5590 | Attribute Documentation: | ||
| 5591 | |||
| 5592 | |**Name**|**Type**|**Documentation** | ||
| 5593 | |id|com:IDType|The id is the identifier for the object. | ||
| 5594 | |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5595 | |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. | ||
| 5596 | |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. | ||
| 5597 | |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. | ||
| 5598 | |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. | ||
| 5599 | |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object. | ||
| 5600 | |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. | ||
| 5601 | |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. | ||
| 5602 | |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. | ||
| 5603 | |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. | ||
| 5604 | |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 key family in the context of a constraint. | ||
| 5605 | |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. | ||
| 5606 | |||
| 5607 | Element Documentation: | ||
| 5608 | |||
| 5609 | |**Name**|**Type**|**Documentation** | ||
| 5610 | |com:Annotations|com: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. | ||
| 5611 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5612 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5613 | |CustomType|CustomTypeType|CustomType details a custom type within a custom type scheme. | ||
| 5614 | |||
| 5615 | **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. | ||
| 5616 | |||
| 5617 | Derivation: | ||
| 5618 | //com:AnnotableType// (extension) | ||
| 5619 | //IdentifiableType// (extension) | ||
| 5620 | //NameableType// (restriction) | ||
| 5621 | //ItemBaseType// (extension) | ||
| 5622 | //ItemType// (restriction) | ||
| 5623 | //UnnestedItemType// (extension) | ||
| 5624 | CustomTypeType | ||
| 5625 | |||
| 5626 | Attributes: | ||
| 5627 | id, urn?, uri? | ||
| 5628 | |||
| 5629 | Content: | ||
| 5630 | com:Annotations?, com:Name+, com:Description*, VtlScalarType, DataType, VtlLiteralFormat?, OutputFormat?, NullValue? | ||
| 5631 | |||
| 5632 | Attribute Documentation: | ||
| 5633 | |||
| 5634 | |**Name**|**Type**|**Documentation** | ||
| 5635 | |id|com:IDType|The id is the identifier for the object. | ||
| 5636 | |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). | ||
| 5637 | |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. | ||
| 5638 | |||
| 5639 | Element Documentation: | ||
| 5640 | |||
| 5641 | |**Name**|**Type**|**Documentation** | ||
| 5642 | |com:Annotations|com: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. | ||
| 5643 | |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5644 | |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. | ||
| 5645 | |VtlScalarType|xs:string|Identifies the VTL scalar type that is to be converted to an resulting output data type. | ||
| 5646 | |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. | ||
| 5647 | |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. | ||
| 5648 | |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. | ||
| 5649 | |NullValue|xs:string|The value to be produced in the output of the conversion when a component has a null value. | ||
| 5650 | |||
| 5651 | === 2.1.4 Simple Types === | ||
| 5652 | |||
| 5653 | **UsageStatusType: **UsageStatusType provides a list of enumerated types for indicating whether reporting a given attribute is mandatory or conditional. | ||
| 5654 | |||
| 5655 | Derived by restriction of xs:NMTOKEN . | ||
| 5656 | |||
| 5657 | Enumerations: | ||
| 5658 | |||
| 5659 | |**Value**|**Documentation** | ||
| 5660 | |Mandatory|Reporting the associated attribute is mandatory - a value must be supplied. | ||
| 5661 | |Conditional|Reporting the associated attribute is not mandatory - a value may be supplied, but is not required. | ||
| 5662 | |||
| 5663 | **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. | ||
| 5664 | |||
| 5665 | Derived by restriction of com:SimpleDataType . | ||
| 5666 | |||
| 5667 | Enumerations: | ||
| 5668 | |||
| 5669 | (% style="width:1015.83px" %) | ||
| 5670 | |**Value**|(% style="width:816px" %)**Documentation** | ||
| 5671 | |String|(% style="width:816px" %)A string datatype corresponding to W3C XML Schema's xs:string datatype. | ||
| 5672 | |Alpha|(% style="width:816px" %)A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. | ||
| 5673 | |AlphaNumeric|(% style="width:816px" %)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. | ||
| 5674 | |Numeric|(% style="width:816px" %)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. | ||
| 5675 | |BigInteger|(% style="width:816px" %)An integer datatype corresponding to W3C XML Schema's xs:integer datatype. | ||
| 5676 | |Integer|(% style="width:816px" %)An integer datatype corresponding to W3C XML Schema's xs:int datatype. | ||
| 5677 | |Long|(% style="width:816px" %)A numeric datatype corresponding to W3C XML Schema's xs:long datatype. | ||
| 5678 | |Short|(% style="width:816px" %)A numeric datatype corresponding to W3C XML Schema's xs:short datatype. | ||
| 5679 | |Boolean|(% style="width:816px" %)A datatype corresponding to W3C XML Schema's xs:boolean datatype. | ||
| 5680 | |URI|(% style="width:816px" %)A datatype corresponding to W3C XML Schema's xs:anyURI datatype. | ||
| 5681 | |Count|(% style="width:816px" %)A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1". | ||
| 5682 | |InclusiveValueRange|(% style="width:816px" %)This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal. | ||
| 5683 | |ExclusiveValueRange|(% style="width:816px" %)This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal. | ||
| 5684 | |Incremental|(% style="width:816px" %)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. | ||
| 5685 | |ObservationalTimePeriod|(% style="width:816px" %)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. | ||
| 5686 | |StandardTimePeriod|(% style="width:816px" %)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. | ||
| 5687 | |BasicTimePeriod|(% style="width:816px" %)BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time. | ||
| 5688 | |GregorianTimePeriod|(% style="width:816px" %)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. | ||
| 5689 | |GregorianYear|(% style="width:816px" %)A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601. | ||
| 5690 | |GregorianYearMonth|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601. | ||
| 5691 | |GregorianDay|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601. | ||
| 5692 | |ReportingTimePeriod|(% style="width:816px" %)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. | ||
| 5693 | |ReportingYear|(% style="width:816px" %)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. | ||
| 5694 | |ReportingSemester|(% style="width:816px" %)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. | ||
| 5695 | |ReportingTrimester|(% style="width:816px" %)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. | ||
| 5696 | |ReportingQuarter|(% style="width:816px" %)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. | ||
| 5697 | |ReportingMonth|(% style="width:816px" %)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. | ||
| 5698 | |ReportingWeek|(% style="width:816px" %)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. | ||
| 5699 | |ReportingDay|(% style="width:816px" %)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. | ||
| 5700 | |Month|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gMonth datatype. | ||
| 5701 | |MonthDay|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype. | ||
| 5702 | |Day|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gDay datatype. | ||
| 5703 | |Duration|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:duration datatype. | ||
| 5704 | |||
| 5705 | **SimpleCodeDataType: **SimpleCodeDataType restricts SimpleDataType to specify the allowable data types for a simple code. The possible values are simply Alpha, AlphaNumeric, or Numeric. | ||
| 5706 | |||
| 5707 | Derived by restriction of com:SimpleDataType . | ||
| 5708 | |||
| 5709 | Enumerations: | ||
| 5710 | |||
| 5711 | |**Value**|**Documentation** | ||
| 5712 | |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. | ||
| 5713 | |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. | ||
| 5714 | |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. | ||
| 5715 | |||
| 5716 | **TargetObjectDataType: **TargetObjectDataType restricts DataType to specify the allowable data types for representing a target object value. | ||
| 5717 | |||
| 5718 | Derived by restriction of com:DataType . | ||
| 5719 | |||
| 5720 | Enumerations: | ||
| 5721 | |||
| 5722 | |**Value**|**Documentation** | ||
| 5723 | |KeyValues|This value indicates that the content of the component will be data key (a set of dimension references and values for the dimensions). | ||
| 5724 | |IdentifiableReference|This value indicates that the content of the component will be complete reference (either URN or full set of reference fields) to an Identifiable object in the SDMX Information Model. | ||
| 5725 | |DataSetReference|This value indicates that the content of the component will be reference to a data provider, which is actually a formal reference to a data provider and a data set identifier value. | ||
| 5726 | |AttachmentConstraintReference|This value indicates that the content of the component will be reference to an attachment constraint, which is actually a combination of a collection of full or partial key values and a reference to a data set or data structure, usage, or provision agreement. | ||
| 5727 | |||
| 5728 | **ToValueTypeType: **ToValueTypeType provides an enumeration of available text-equivalents for translation of coded values into textual formats. | ||
| 5729 | |||
| 5730 | Derived by restriction of xs:NMTOKEN . | ||
| 5731 | |||
| 5732 | Enumerations: | ||
| 5733 | |||
| 5734 | |**Value**|**Documentation** | ||
| 5735 | |Value|Code or other tokenized value, as provided in the representation scheme. | ||
| 5736 | |Name|The human-readable name of the Value, as provided in the representation scheme. | ||
| 5737 | |Description|The human-readable description of the Value, as provided in the representation scheme. | ||
| 5738 | |||
| 5739 | **StandardToVtlMappingMethodType: **A simple type enumerating the standard mapping methods when converting from data structures from SDMX to VLT. | ||
| 5740 | |||
| 5741 | Derived by restriction of xs:string. | ||
| 5742 | |||
| 5743 | Enumerations: | ||
| 5744 | |||
| 5745 | |**Value**|**Documentation** | ||
| 5746 | |Basic|The default mapping method. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.1 ("Basic Mapping"). | ||
| 5747 | |Pivot|Method for mapping multi-measure data. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.2 ("Pivot Mapping"). | ||
| 5748 | |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"). | ||
| 5749 | |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"). | ||
| 5750 | |||
| 5751 | **ToVtlMappingMethodType: **A simple type that allows for a standard to VTL mapping method enumeration value or a string value for other mapping methods. | ||
| 5752 | |||
| 5753 | Union of: | ||
| 5754 | StandardToVtlMappingMethodType, xs:string. | ||
| 5755 | |||
| 5756 | **StandardFromVtlMappingMethodType: **A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX. | ||
| 5757 | |||
| 5758 | Derived by restriction of xs:string . | ||
| 5759 | |||
| 5760 | Enumerations: | ||
| 5761 | |||
| 5762 | |**Value**|**Documentation** | ||
| 5763 | |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"). | ||
| 5764 | |Unpivot|The mapping method to be used when the VTL data structure has more than one measure component. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.4.2 ("Unpivot Mapping"). | ||
| 5765 | |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"). | ||
| 5766 | |||
| 5767 | **FromVtlMappingMethodType: **A simple type that allows for standard from VTL mapping method enumeration value or a string value for other mapping methods. | ||
| 5768 | |||
| 5769 | Union of: | ||
| 5770 | StandardFromVtlMappingMethodType, xs:string. | ||
| 5771 | |||
| 5772 | **CustomTypeDataType: **A simple type that allows for a SDMX simple data type enumeration value or a string value for other data types. | ||
| 5773 | |||
| 5774 | Union of: | ||
| 5775 | com:SimpleDataType, xs:string. |