org.sdmxsource.sdmx.sdmxbeans.model.beans.reference

Class RESTDataQueryImpl

java.lang.Object

org.sdmxsource.sdmx.sdmxbeans.model.beans.reference.RESTDataQueryImpl

All Implemented Interfaces:

java.io.Serializable, RESTDataQuery

public class RESTDataQueryImpl
extends java.lang.Object
implements RESTDataQuery

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RESTDataQueryImpl(java.lang.String restString) Constructs a data query off a full or partial REST URL - the URL must start before the Data segment and be complete, example input: /data/IMF,PGI,1.0/156.BCA.BOP.L_B.Q?detail=full
RESTDataQueryImpl(java.lang.String[] queryString, java.util.Map<java.lang.String,java.lang.String> queryParameters)
RESTDataQueryImpl(java.lang.String restString, java.util.Map<java.lang.String,java.lang.String> queryParameters) Constructs a data query off a full or partial REST URL - the URL must start before the Data segment and be complete, example input: /data/IMF,PGI,1.0/156.BCA.BOP.L_B.Q?detail=full

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)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RESTDataQueryImpl

public RESTDataQueryImpl(java.lang.String restString)

Constructs a data query off a full or partial REST URL - the URL must start before the Data segment and be complete, example input: /data/IMF,PGI,1.0/156.BCA.BOP.L_B.Q?detail=full

Parameters:

restString -

RESTDataQueryImpl

public RESTDataQueryImpl(java.lang.String restString,
                 java.util.Map<java.lang.String,java.lang.String> queryParameters)

Constructs a data query off a full or partial REST URL - the URL must start before the Data segment and be complete, example input: /data/IMF,PGI,1.0/156.BCA.BOP.L_B.Q?detail=full

Parameters:

restString -

RESTDataQueryImpl

public RESTDataQueryImpl(java.lang.String[] queryString,
                 java.util.Map<java.lang.String,java.lang.String> queryParameters)

Method Detail

getRestQuery

public java.lang.String getRestQuery()

Description copied from interface: RESTDataQuery

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

Specified by:

getRestQuery in interface RESTDataQuery

Returns:

getFlowRef

public StructureReferenceBean getFlowRef()

Description copied from interface: RESTDataQuery

Returns the dataflow reference

Specified by:

getFlowRef in interface RESTDataQuery

Returns:

getProviderRef

public StructureReferenceBean getProviderRef()

Description copied from interface: RESTDataQuery

Returns the data provider reference, or null if ALL

Specified by:

getProviderRef in interface RESTDataQuery

includeHistory

public boolean includeHistory()

Description copied from interface: RESTDataQuery

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)

Specified by:

includeHistory in interface RESTDataQuery

Returns:

getStartPeriod

public SdmxDate getStartPeriod()

Description copied from interface: RESTDataQuery

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

Specified by:

getStartPeriod in interface RESTDataQuery

Returns:

getEndPeriod

public SdmxDate getEndPeriod()

Description copied from interface: RESTDataQuery

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

Specified by:

getEndPeriod in interface RESTDataQuery

Returns:

getUpdatedAfter

public SdmxDate getUpdatedAfter()

Description copied from interface: RESTDataQuery

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

Specified by:

getUpdatedAfter in interface RESTDataQuery

Returns:

getlastNObsertations

public java.lang.Integer getlastNObsertations()

Description copied from interface: RESTDataQuery

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

Specified by:

getlastNObsertations in interface RESTDataQuery

Returns:

last 'n' observations or null if unspecified

getFirstNObservations

public java.lang.Integer getFirstNObservations()

Description copied from interface: RESTDataQuery

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

Specified by:

getFirstNObservations in interface RESTDataQuery

Returns:

first 'n' observations or null if unspecified

getQueryDetail

public DATA_QUERY_DETAIL getQueryDetail()

Description copied from interface: RESTDataQuery

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

Specified by:

getQueryDetail in interface RESTDataQuery

Returns:

getDimensionAtObservation

public java.lang.String getDimensionAtObservation()

Description copied from interface: RESTDataQuery

Returns the dimension to , or null if undefined

Specified by:

getDimensionAtObservation in interface RESTDataQuery

Returns:

getQueryList

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

Description copied from interface: RESTDataQuery

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

Specified by:

getQueryList in interface RESTDataQuery

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object