org.sdmxsource.sdmx.api.model.data.query

Interface BaseDataQuery

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ComplexDataQuery, DataQuery

All Known Implementing Classes:

ComplexDataQueryImpl, DataQueryImpl

public interface BaseDataQuery
extends java.io.Serializable

Base interface for both standard and complex data queries

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	dimensionAtObservation() Returns the id of the dimension to be attached at the observation level, if not specified the returned data will be time series.
DataflowBean	getDataflow() Returns the Dataflow that the query is returning data for.
java.util.Set<DataProviderBean>	getDataProvider() Returns the data provider(s) that the query is for, an empty list represents ALL.
DATA_QUERY_DETAIL	getDataQueryDetail() Returns the detail of the query.
DataStructureBean	getDataStructure() Returns the Key Family (Data Structure Definition) that this query is returning data for.
java.lang.Integer	getFirstNObservations() Returns the first 'n' observations, for each series key, to return as a result of a data query.
java.lang.Integer	getLastNObservations() Returns the last 'n' observations, for each series key, to return as a result of a data query.
boolean	hasSelections() Returns true if this query has one or more selection groups on it, false means the query is a query for all.

Method Detail

dimensionAtObservation

java.lang.String dimensionAtObservation()

Returns the id of the dimension to be attached at the observation level, if not specified the returned data will be time series.

Returns:

hasSelections

boolean hasSelections()

Returns true if this query has one or more selection groups on it, false means the query is a query for all.

Returns:

getDataStructure

DataStructureBean getDataStructure()

Returns the Key Family (Data Structure Definition) that this query is returning data for.

Returns:

getDataflow

DataflowBean getDataflow()

Returns the Dataflow that the query is returning data for.

Returns:

getDataProvider

java.util.Set<DataProviderBean> getDataProvider()

Returns the data provider(s) that the query is for, an empty list represents ALL.

Returns:

getLastNObservations

java.lang.Integer getLastNObservations()

Returns the last '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 first 'n' observations, for each series key, to return as a result of a data query.

Returns:

first 'n' observations or null if unspecified

getDataQueryDetail

DATA_QUERY_DETAIL getDataQueryDetail()

Returns the detail of the query. The detail specifies whether to return just the series keys, just the data or everything.

Defaults to FULL (everything)

Returns: