Changes for page 4 General Notes for Implementers

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -10,26 +10,26 @@
10	10
11	11	There are several different representations in SDMX-ML, taken from XML Schemas and common programming languages. The table below describes the various representations, which are found in SDMX-ML, and their equivalents.
12	12
13		-|(% style="width:191px" %)**SDMX-ML Data Type**|(% style="width:232px" %)**XML Schema Data Type**|(% style="width:212px" %)**.NET Framework Type**|(% style="width:980px" %)(((
14		-**Java Data Type**
	13	+|SDMX-ML Data Type|XML Schema Data Type|.NET Framework Type|(((
	14	+Java Data Type
15	15	)))
16		-|(% style="width:191px" %)String|(% style="width:232px" %)xsd:string|(% style="width:212px" %)System.String|(% style="width:980px" %)java.lang.String
17		-|(% style="width:191px" %)Big Integer|(% style="width:232px" %)xsd:integer|(% style="width:212px" %)System.Decimal|(% style="width:980px" %)java.math.BigInteger
18		-|(% style="width:191px" %)Integer|(% style="width:232px" %)xsd:int|(% style="width:212px" %)System.Int32|(% style="width:980px" %)int
19		-|(% style="width:191px" %)Long|(% style="width:232px" %)xsd.long|(% style="width:212px" %)System.Int64|(% style="width:980px" %)long
20		-|(% style="width:191px" %)Short|(% style="width:232px" %)xsd:short|(% style="width:212px" %)System.Int16|(% style="width:980px" %)short
21		-|(% style="width:191px" %)Decimal|(% style="width:232px" %)xsd:decimal|(% style="width:212px" %)System.Decimal|(% style="width:980px" %)java.math.BigDecimal
22		-|(% style="width:191px" %)Float|(% style="width:232px" %)xsd:float|(% style="width:212px" %)System.Single|(% style="width:980px" %)float
23		-|(% style="width:191px" %)Double|(% style="width:232px" %)xsd:double|(% style="width:212px" %)System.Double|(% style="width:980px" %)double
24		-|(% style="width:191px" %)Boolean|(% style="width:232px" %)xsd:boolean|(% style="width:212px" %)System.Boolean|(% style="width:980px" %)boolean
25		-|(% style="width:191px" %)URI|(% style="width:232px" %)xsd:anyURI|(% style="width:212px" %)System.Uri|(% style="width:980px" %)Java.net.URI or java.lang.String
26		-|(% style="width:191px" %)DateTime|(% style="width:232px" %)xsd:dateTime|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
27		-|(% style="width:191px" %)Time|(% style="width:232px" %)xsd:time|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
28		-|(% style="width:191px" %)GregorianYear|(% style="width:232px" %)xsd:gYear|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
29		-|(% style="width:191px" %)GregorianMonth|(% style="width:232px" %)xsd:gYearMonth|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
30		-|(% style="width:191px" %)GregorianDay|(% style="width:232px" %)xsd:date|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
31		-|(% style="width:191px" %)Day, MonthDay, Month|(% style="width:232px" %)xsd:g*|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
32		-|(% style="width:191px" %)Duration|(% style="width:232px" %)xsd:duration|(% style="width:212px" %)System.TimeSpan|(% style="width:980px" %)javax.xml.datatype.Duration
	16	+|**String**|**xsd:string**|**System.String**|**java.lang.String**
	17	+|**Big Integer**|**xsd:integer**|**System.Decimal**|**java.math.BigInteger**
	18	+|**Integer**|**xsd:int**|**System.Int32**|**int**
	19	+|**Long**|**xsd.long**|**System.Int64**|**long**
	20	+|**Short**|**xsd:short**|**System.Int16**|**short**
	21	+|**Decimal**|**xsd:decimal**|**System.Decimal**|**java.math.BigDecimal**
	22	+|**Float**|**xsd:float**|**System.Single**|**float**
	23	+|**Double**|**xsd:double**|**System.Double**|**double**
	24	+|**Boolean**|**xsd:boolean**|**System.Boolean**|**boolean**
	25	+|**URI**|**xsd:anyURI**|**System.Uri**|**Java.net.URI or java.lang.String**
	26	+|**DateTime**|**xsd:dateTime**|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
	27	+|**Time**|**xsd:time**|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
	28	+|**GregorianYear**|**xsd:gYear**|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
	29	+|**GregorianMonth**|**xsd:gYearMonth**|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
	30	+|**GregorianDay**|**xsd:date**|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
	31	+|**Day, MonthDay, Month**|**xsd:g***|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
	32	+|**Duration**|**xsd:duration**|**System.TimeSpan**|**javax.xml.datatype.Dura tion**
33	33
34	34	There are also a number of SDMX-ML data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data type. For most of these, there are simple types which can be referenced from the SDMX schemas, for others a derived simple type will be necessary:
35	35
...	...	@@ -76,7 +76,7 @@
76	76
77	77	Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes.
78	78
79		-=== 4.1.1 Data Types ===
	79	+4.1.1 Data Types
80	80
81	81	XML and JSON schemas support a variety of data types that, although rich, are not mapped one-to-one in all cases. This section provides an explanation of the mapping performed in SDMX 3.0, between such cases.
82	82
...	...	@@ -95,8 +95,8 @@
95	95	The above looks like this, in JSON schema:
96	96
97	97	> "idType": {
98		-> "type": "string",
99		-> "pattern": "^[A-Za-z0-9_@$-]+$"
	98	+> "type": "string",
	99	+> "pattern": "^[A-Za-z0-9_@$-]+$"
100	100	> }
101	101
102	102	There are also cases, though, that data types cannot be mapped like above. One such case is the array data type, which was introduced in SDMX 3.0 as a new representation. In JSON schema an array is already natively foreseen, while in the XML schema, this has to be defined as a complex type, with an SDMX specific definition (i.e., specific element/attribute names for SDMX). Beyond that, the minimum and/or maximum number of items within an array is possible in both cases.
...	...	@@ -103,28 +103,47 @@
103	103
104	104	Further to the above, the mapping between the non-native data types is presented in the table below:
105	105
106		-(% style="width:1005.83px" %)
107		-|(% style="width:198px" %)**SDMX Facet**|(% style="width:241px" %)**XML Schema**|(% style="width:563px" %)**JSON schema **"**pattern**"{{footnote}}Regular expressions, as specified in W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes.{{/footnote}} **for "string" type**
108		-|(% style="width:198px" %)GregorianYear|(% style="width:241px" %)xsd:gYear|(% style="width:563px" %)(((
109		-"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
	106	+|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"[[(% class="wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]](%%) **for "string" type**
	107	+|GregorianYear|xsd:gYear|(((
	108	+"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0-
	109	+
	110	+9]|1[0-3]):[0-5][0-9]|14:00))?$"
110	110	)))
111		-|(% style="width:198px" %)GregorianMonth|(% style="width:241px" %)xsd:gYearMonth|(% style="width:563px" %)(((
112		-"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
	112	+|GregorianMonth|xsd:gYearMonth|(((
	113	+"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-
	114	+
	115	+2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-
	116	+
	117	+9]|14:00))?$"
113	113	)))
114		-|(% style="width:198px" %)GregorianDay|(% style="width:241px" %)xsd:date|(% style="width:563px" %)(((
115		-"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
	119	+|GregorianDay|xsd:date|(((
	120	+"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-
	121	+
	122	+(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-
	123	+
	124	+3]):[0-5][0-9]|14:00))?$"
116	116	)))
117		-|(% style="width:198px" %)Day|(% style="width:241px" %)xsd:gDay|(% style="width:563px" %)(((
118		-"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
	126	+|Day|xsd:gDay|(((
	127	+"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|-
	128	+
	129	+)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
119	119	)))
120		-|(% style="width:198px" %)MonthDay|(% style="width:241px" %)xsd:gMonthDay|(% style="width:563px" %)(((
121		-"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
	131	+|MonthDay|xsd:gMonthDay|(((
	132	+"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0-
	133	+
	134	+9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-
	135	+
	136	+9]|14:00))?$"
122	122	)))
123		-|(% style="width:198px" %)Month|(% style="width:241px" %)xsd:Month|(% style="width:563px" %)(((
124		-"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
	138	+|Month|xsd:Month|(((
	139	+"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-
	140	+
	141	+3]):[0-5][0-9]|14:00))?$"
125	125	)))
126		-|(% style="width:198px" %)Duration|(% style="width:241px" %)xsd:duration|(% style="width:563px" %)(((
127		-"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$"
	143	+|Duration|xsd:duration|(((
	144	+"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0-
	145	+
	146	+9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$"
128	128	)))
129	129
130	130	== 4.2 Time and Time Format ==
...	...	@@ -139,14 +139,15 @@
139	139
140	140	The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format):
141	141
142		-* **Observational Time Period**
143		-** **Standard Time Period**
144		-*** **Basic Time Period**
145		-**** **Gregorian Time Period**
146		-**** //Date Time//
147		-*** **Reporting Time Period**
148		-** //Time Range//
	161	+* **Observational Time Period **o **Standard Time Period**
149	149
	163	+ § **Basic Time Period**
	164	+
	165	+* **Gregorian Time Period**
	166	+* //Date Time//
	167	+
	168	+§ **Reporting Time Period **o //Time Range//
	169	+
150	150	The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow.
151	151
152	152	=== 4.2.2 Observational Time Period ===
...	...	@@ -162,12 +162,11 @@
162	162	A Gregorian time period is always represented by a Gregorian year, year-month, or day. These are all based on ISO 8601 dates. The representation in SDMX-ML messages and the period covered by each of the Gregorian time periods are as follows:
163	163
164	164	**Gregorian Year:**
	185	+
165	165	Representation: xs:gYear (YYYY)
166		-Period: the start of January 1 to the end of December 31
167		-**Gregorian Year Month**:
	187	+Period: the start of January 1 to the end of December 31 **Gregorian Year Month**:
168	168	Representation: xs:gYearMonth (YYYY-MM)
169		-Period: the start of the first day of the month to end of the last day of the month
170		-**Gregorian Day**:
	189	+Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**:
171	171	Representation: xs:date (YYYY-MM-DD)
172	172	Period: the start of the day (00:00:00) to the end of the day (23:59:59)
173	173
...	...	@@ -175,7 +175,7 @@
175	175
176	176	This is used to unambiguously state that a date-time represents an observation at a single point in time. Therefore, if one wants to use SDMX for data which is measured at a distinct point in time rather than being reported over a period, the date-time representation can be used.
177	177
178		-Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}
	197	+Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[(% class="wikiinternallink wikiinternallink" %)^^~[2~]^^>>path:#_ftn2]]
179	179
180	180	=== 4.2.6 Standard Reporting Period ===
181	181
...	...	@@ -191,46 +191,77 @@
191	191	The following section details each of the standard reporting periods defined in SDMX:
192	192
193	193	**Reporting Year**:
194		-Period Indicator: A
	213	+
	214	+ Period Indicator: A
	215	+
195	195	Period Duration: P1Y (one year)
	217	+
196	196	Limit per year: 1
197		-Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
198		-**Reporting Semester:**
199		-Period Indicator: S
	219	+
	220	+Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**
	221	+
	222	+ Period Indicator: S
	223	+
200	200	Period Duration: P6M (six months)
	225	+
201	201	Limit per year: 2
	227	+
202	202	Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
	229	+
203	203	**Reporting Trimester:**
204		-Period Indicator: T
	231	+
	232	+ Period Indicator: T
	233	+
205	205	Period Duration: P4M (four months)
	235	+
206	206	Limit per year: 3
207		-Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
208		-**Reporting Quarter:**
209		-Period Indicator: Q
	237	+
	238	+Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**
	239	+
	240	+ Period Indicator: Q
	241	+
210	210	Period Duration: P3M (three months)
	243	+
211	211	Limit per year: 4
212		-Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
213		-**Reporting Month**:
	245	+
	246	+Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:
	247	+
214	214	Period Indicator: M
	249	+
215	215	Period Duration: P1M (one month)
	251	+
216	216	Limit per year: 1
	253	+
217	217	Representation: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12) Notes: The reporting month is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
	255	+
218	218	**Reporting Week**:
	257	+
219	219	Period Indicator: W
	259	+
220	220	Period Duration: P7D (seven days)
	261	+
221	221	Limit per year: 53
	263	+
222	222	Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
223		-Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.{{footnote}}ISO 8601 defines alternative definitions for the first week, all of which produce equivalent results. Any of these definitions could be substituted so long as they are in
224		-relation to the reporting year start day.{{/footnote}} The reporting week is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
	265	+
	266	+Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.[[(% class="wikiinternallink wikiinternallink" %)^^~[3~]^^>>path:#_ftn3]](%%) The reporting week is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
	267	+
225	225	**Reporting Day**:
	269	+
226	226	Period Indicator: D
	271	+
227	227	Period Duration: P1D (one day)
	273	+
228	228	Limit per year: 366
	275	+
229	229	Representation: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366) Notes: There are either 365 or 366 days in a reporting year, depending on whether the reporting year includes leap day (February 29). The reporting day is always represented as three digits, therefore 1-99 are 0 padded (e.g. 001). This allows the values to be sorted chronologically using textual sorting methods.
	277	+
230	230	The meaning of a reporting year is always based on the start day of the year and requires that the reporting year is expressed as the year at the start of the period. This start day is always the same for a reporting year, and is expressed as a day and a month (e.g. July 1). Therefore, the reporting year 2000 with a start day of July 1 begins on July 1, 2000.
231	231
232		-A specialized attribute (reporting year start day) exists for the purpose of communicating the reporting year start day. This attribute has a fixed identifier (REPORTING_YEAR_START_DAY) and a fixed representation (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this attribute exists in specialized sub-class, it functions the same as any other attribute outside of its identification and representation. It must takes its identity from a concept and state its relationship with other components of the data structure definition. The ability to state this relationship allows this reporting year start day attribute to exist at the appropriate levels of a data message. In the absence of this attribute, the reporting year start date is assumed to be January 1; therefore if the reporting year coincides with the calendar year, this Attribute is not necessary.
	280	+A specialized attribute (reporting year start day) exists for the purpose of communicating the reporting year start day. This attribute has a fixed identifier
233	233
	282	+(REPORTING_YEAR_START_DAY) and a fixed representation (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this attribute exists in specialized sub-class, it functions the same as any other attribute outside of its identification and representation. It must takes its identity from a concept and state its relationship with other components of the data structure definition. The ability to state this relationship allows this reporting year start day attribute to exist at the appropriate levels of a data message. In the absence of this attribute, the reporting year start date is assumed to be January 1; therefore if the reporting year coincides with the calendar year, this Attribute is not necessary.
	283	+
234	234	Since the duration and the reporting year start day are known for any reporting period, it is possible to relate any reporting period to a distinct calendar period. The actual Gregorian calendar period covered by the reporting period can be computed as follows (based on the standard format of [REPROTING_YEAR]-
235	235
236	236	[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]):
...	...	@@ -245,7 +245,7 @@
245	245	11. **If the [PERIOD_INDICATOR] is W:**
246	246	111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
247	247
248		-Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
	298	+Add[[(% class="wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
249	249
250	250	1.
251	251	11.
...	...	@@ -546,5 +546,4 @@
546	546
547	547	[[~[4~]>>path:#_ftnref4]] The rules for adding durations to a date time are described in the W3C XML Schema specification. See [[http:~~/~~/www.w3.org/TR/xmlschema>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[2/#adding>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[durations>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[to>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[dateTimes>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[ >>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]]for further details.
548	548
549		-
550		-{{putFootnotes/}}
	599	+