org.sdmxsource.sdmx.api.model.query

Interface RESTDataQuery

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

RESTDataQueryImpl

public interface RESTDataQuery
extends java.io.Serializable

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDimensionAtObservation() Returns the dimension to , or null if undefined
SdmxDate	getEndPeriod() Returns the end date to get the data from, or null if undefined
java.lang.Integer	getFirstNObservations() Returns the last 'n' observations, for each series key, to return as a result of a data query
StructureReferenceBean	getFlowRef() Returns the dataflow reference
java.lang.Integer	getlastNObsertations() Returns the first 'n' observations, for each series key, to return as a result of a data query.
StructureReferenceBean	getProviderRef() Returns the data provider reference, or null if ALL
DATA_QUERY_DETAIL	getQueryDetail() Returns the level of detail for the returne data, or null if undefined
java.util.List<java.util.Set<java.lang.String>>	getQueryList() Returns the list of dimension codeid filters, in the same order as the dimensions are defined by the DataStructure
java.lang.String	getRestQuery() Returns a String representation of this query, in SDMX REST format starting from Data/.
SdmxDate	getStartPeriod() Returns the start date to get the data from, or null if undefined
SdmxDate	getUpdatedAfter() Returns the updated after date to get the data from, or null if undefined
boolean	includeHistory() If true then the response message will contain previous versions of the data as they were disseminated in the past past ("history" or "timeline" functionality)

Method Detail

getRestQuery

java.lang.String getRestQuery()

Returns a String representation of this query, in SDMX REST format starting from Data/.

Example Data/ACY,FLOW,1.0/M.Q+P....L/ALL?detail=seriesKeysOnly

Returns:

includeHistory

boolean includeHistory()

If true then the response message will contain previous versions of the data as they were disseminated in the past past ("history" or "timeline" functionality)

Returns:

getFlowRef

StructureReferenceBean getFlowRef()

Returns the dataflow reference

Returns:

getProviderRef

StructureReferenceBean getProviderRef()

Returns the data provider reference, or null if ALL

getStartPeriod

SdmxDate getStartPeriod()

Returns the start date to get the data from, or null if undefined

Returns:

getEndPeriod

SdmxDate getEndPeriod()

Returns the end date to get the data from, or null if undefined

Returns:

getUpdatedAfter

SdmxDate getUpdatedAfter()

Returns the updated after date to get the data from, or null if undefined

Returns:

getlastNObsertations

java.lang.Integer getlastNObsertations()

Returns the first 'n' observations, for each series key, to return as a result of a data query.

Returns:

last 'n' observations or null if unspecified

getFirstNObservations

java.lang.Integer getFirstNObservations()

Returns the last 'n' observations, for each series key, to return as a result of a data query

Returns:

first 'n' observations or null if unspecified

getQueryDetail

DATA_QUERY_DETAIL getQueryDetail()

Returns the level of detail for the returne data, or null if undefined

Returns:

getDimensionAtObservation

java.lang.String getDimensionAtObservation()

Returns the dimension to , or null if undefined

Returns:

getQueryList

java.util.List<java.util.Set<java.lang.String>> getQueryList()

Returns the list of dimension codeid filters, in the same order as the dimensions are defined by the DataStructure

Returns: