xsd.1_0.SDMXQuery.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of SdmxSourceUtil Show documentation
Show all versions of SdmxSourceUtil Show documentation
Open source reference implementation of SDMX
The newest version!
The Query message allows standard querying of SDMX-compliant databases and web services.
It allows queries to retrieve data, key families, codelists, and concepts.
The Query element is a top-level element for this namespace, which is referenced by the SDMX message envelope, or could be put inside another envelope, such as SOAP. It contains a query. The defaultLimit attribute is the suggested maximum response size in kilobytes.
The DataWhere element representes a query for data. It contains all of the clauses in that query, represented by its child elements.
For the And element, each of its immediate child elements represent clauses all of which represent conditions which must be satisfied. If children are A, B, and C, then any legitimate response will meet conditions A, B, and C.
The Or element's immediate children represent clauses in the query any one of which is sufficient to satisfy the query. If these children are A, B, and C, then any result which meets condition A, or condition B, or condition C is a match for that query.
Dimension elements contain the (single) value being searched on within the key of data set. The name attribute holds the agency-qualified ID of the dimension. If the content is empty, then the query is for any dimension with the given name. If the name attribute is not supplied, then the query is for the given key value within any dimension.
Attribute elements contain the (single) value of an attribute being queried for. The name attribute contains the agency-qualified name of the attribute. The attachmentLevel attribute specifies the attachment level of the attribute. If the content of Attribute is empty, then the search is for the specified attribute (and attachment level). If the name attribute is not specified, then the search is on any attribute. If the attachmentLevel attribute is not specified, then the query is for an attribute at any attachment level, as the value defaults to "Any".
This type supplies an enumeration of attachment levels corresponding to those in the SDMX Information Model, plus a value of "Any" where the search is wildcarded.
Attached at the Data Set level
Attached at the Group level
Attached at the Series level
Attached at the Observation level
Attached at any attachment level
The Codelist element allows queries to specify a (single) value found within a codelist as the element content, and the agency-qualified name of the codelist being queried for in the name attribute. If no content is supplied, then the query is for the named codelist. If the name attribute is left empty, then the value is searched for in any codelist.
The Category element allows for a search to be made on the values within a specific category, which is specified (in agency-qualified form) with the name attribute. If there is no element content, then the search is for the named Category; if the name is not supplied, then the category value supplied as content should be sought-for in all available categories.
The KeyFamilyWhere element representes a query for a key family or key families. It contains all of the clauses in that query, represented by its child elements.
The CodelistWhere element representes a query for a codelist or codelists. It contains all of the clauses in that query, represented by its child elements.
The ConceptWhere element representes a query for a concept or concepts. It contains all of the clauses in that query, represented by its child elements.
The AgencyWhere element representes a query for details for an Agency. It contains all of the clauses in that query, represented by its child elements.
TimeType contains the time point or period for which results should be supplied. When StartTime and EndTime are used, these must be understood as inclusive.