org.sdmxsource.sdmx.sdmxbeans.model.data.query.complex

Class ComplexDataQueryImpl

java.lang.Object

org.sdmxsource.sdmx.sdmxbeans.model.data.query.BaseDataQuery

org.sdmxsource.sdmx.sdmxbeans.model.data.query.complex.ComplexDataQueryImpl

All Implemented Interfaces:

java.io.Serializable, BaseDataQuery, ComplexDataQuery

public class ComplexDataQueryImpl
extends BaseDataQuery
implements ComplexDataQuery

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComplexDataQueryImpl(java.lang.String datasetId, TEXT_SEARCH datasetIdOperator, java.util.Set<DataProviderBean> dataProviders, DataStructureBean dataStructure, DataflowBean dataFlow, ProvisionAgreementBean provisionAgreement, java.util.List<TimeRange> lastUpdatedDate, java.lang.Integer maxObs, boolean orderAsc, java.lang.Integer defaultLimit, OBSERVATION_ACTION obsAction, java.lang.String dimensionAtObservation, boolean hasExplicitMeasures, DATA_QUERY_DETAIL queryDetail, ComplexDataQuerySelectionGroup... complexDataQuerySelectionGroup)
ComplexDataQueryImpl(java.lang.String datasetId, TEXT_SEARCH datasetIdOperator, java.util.Set<DataProviderBean> dataProviders, DataStructureBean dataStructure, DataflowBean dataFlow, ProvisionAgreementBean provisionAgreement, java.util.List<TimeRange> lastUpdatedDate, java.lang.Integer maxObs, boolean orderAsc, java.lang.Integer defaultLimit, OBSERVATION_ACTION obsAction, java.lang.String dimensionAtObservation, boolean hasExplicitMeasures, DATA_QUERY_DETAIL queryDetail, java.util.Set<ComplexDataQuerySelection> complexSelections, java.util.Date dateFrom, ORDERED_OPERATOR dateFromOperator, java.util.Date dateTo, ORDERED_OPERATOR dateToOperator, java.util.Set<ComplexComponentValue> primaryMeasureValues)
ComplexDataQueryImpl(java.lang.String datasetId, TEXT_SEARCH datasetIdOperator, java.util.Set<DataProviderBean> dataProviders, DataStructureBean dataStructure, DataflowBean dataFlow, ProvisionAgreementBean provisionAgreement, java.util.List<TimeRange> lastUpdatedDate, java.lang.Integer maxObs, java.lang.Integer defaultLimit, boolean orderAsc, OBSERVATION_ACTION obsAction, java.lang.String dimensionAtObservation, boolean hasExplicitMeasures, DATA_QUERY_DETAIL queryDetail, java.util.Collection<ComplexDataQuerySelectionGroup> complexDataQuerySelectionGroup)
ComplexDataQueryImpl(java.lang.String datasetId, TEXT_SEARCH datasetIdOperator, java.util.Set<DataProviderBean> dataProviders, DataStructureBean dataStructure, DataflowBean dataFlow, ProvisionAgreementBean provisionAgreement, java.util.List<TimeRange> lastUpdatedDate, java.lang.Integer firstNObs, java.lang.Integer lastNObs, java.lang.Integer defaultLimit, OBSERVATION_ACTION obsAction, java.lang.String dimensionAtObservation, boolean hasExplicitMeasures, DATA_QUERY_DETAIL queryDetail, java.util.Collection<ComplexDataQuerySelectionGroup> complexDataQuerySelectionGroup)
ComplexDataQueryImpl(java.lang.String datasetId, TEXT_SEARCH datasetIdOperator, java.util.Set<DataProviderBean> dataProviders, DataStructureBean dataStructure, DataflowBean dataFlow, ProvisionAgreementBean provisionAgreement, java.util.List<TimeRange> lastUpdatedDate, java.lang.Integer firstNObs, java.lang.Integer lastNObs, java.lang.Integer defaultLimit, OBSERVATION_ACTION obsAction, java.lang.String dimensionAtObservation, boolean hasExplicitMeasures, DATA_QUERY_DETAIL queryDetail, java.util.Set<ComplexDataQuerySelection> complexSelections, java.util.Date dateFrom, ORDERED_OPERATOR dateFromOperator, java.util.Date dateTo, ORDERED_OPERATOR dateToOperator, java.util.Set<ComplexComponentValue> primaryMeasureValues)

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.
java.lang.String	getDatasetId() Returns the id of the dataset from which data will be returned or null if unspecified
TEXT_SEARCH	getDatasetIdOperator() The id of the dataset requested should satisfy the condition implied by the operator this method returns.
DataStructureBean	getDataStructure() Returns the Key Family (Data Structure Definition) that this query is returning data for.
java.lang.Integer	getDefaultLimit() Returns the suggested maximum response size or null if unspecified
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.
java.util.List<TimeRange>	getLastUpdatedDateTimeRange() This method accomplishes the following criteria :match data based on when they were last updated The date points to the start date or the range that the queried date must occur within and/ or to the end period of the range It returns null if unspecified.
OBSERVATION_ACTION	getObservationAction() Returns the type of observations to be returned. Defaults to ACTIVE
ProvisionAgreementBean	getProvisionAgreement() Returns the Provision Agreement that the query is returning data for or null if unspecified
java.util.List<ComplexDataQuerySelectionGroup>	getSelectionGroups() Returns a list of selection groups.
boolean	hasExplicitMeasures() Returns true or false depending on the existence of explicit measures Defaults to false
boolean	hasSelections() Returns true if this query has one or more selection groups on it, false means the query is a query for all.

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.data.query.BaseDataQuery

getDimensionAtObservation

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplexDataQueryImpl

public ComplexDataQueryImpl(java.lang.String datasetId,
                    TEXT_SEARCH datasetIdOperator,
                    java.util.Set<DataProviderBean> dataProviders,
                    DataStructureBean dataStructure,
                    DataflowBean dataFlow,
                    ProvisionAgreementBean provisionAgreement,
                    java.util.List<TimeRange> lastUpdatedDate,
                    java.lang.Integer maxObs,
                    java.lang.Integer defaultLimit,
                    boolean orderAsc,
                    OBSERVATION_ACTION obsAction,
                    java.lang.String dimensionAtObservation,
                    boolean hasExplicitMeasures,
                    DATA_QUERY_DETAIL queryDetail,
                    java.util.Collection<ComplexDataQuerySelectionGroup> complexDataQuerySelectionGroup)

ComplexDataQueryImpl

public ComplexDataQueryImpl(java.lang.String datasetId,
                    TEXT_SEARCH datasetIdOperator,
                    java.util.Set<DataProviderBean> dataProviders,
                    DataStructureBean dataStructure,
                    DataflowBean dataFlow,
                    ProvisionAgreementBean provisionAgreement,
                    java.util.List<TimeRange> lastUpdatedDate,
                    java.lang.Integer firstNObs,
                    java.lang.Integer lastNObs,
                    java.lang.Integer defaultLimit,
                    OBSERVATION_ACTION obsAction,
                    java.lang.String dimensionAtObservation,
                    boolean hasExplicitMeasures,
                    DATA_QUERY_DETAIL queryDetail,
                    java.util.Collection<ComplexDataQuerySelectionGroup> complexDataQuerySelectionGroup)

ComplexDataQueryImpl

public ComplexDataQueryImpl(java.lang.String datasetId,
                    TEXT_SEARCH datasetIdOperator,
                    java.util.Set<DataProviderBean> dataProviders,
                    DataStructureBean dataStructure,
                    DataflowBean dataFlow,
                    ProvisionAgreementBean provisionAgreement,
                    java.util.List<TimeRange> lastUpdatedDate,
                    java.lang.Integer maxObs,
                    boolean orderAsc,
                    java.lang.Integer defaultLimit,
                    OBSERVATION_ACTION obsAction,
                    java.lang.String dimensionAtObservation,
                    boolean hasExplicitMeasures,
                    DATA_QUERY_DETAIL queryDetail,
                    ComplexDataQuerySelectionGroup... complexDataQuerySelectionGroup)

ComplexDataQueryImpl

public ComplexDataQueryImpl(java.lang.String datasetId,
                    TEXT_SEARCH datasetIdOperator,
                    java.util.Set<DataProviderBean> dataProviders,
                    DataStructureBean dataStructure,
                    DataflowBean dataFlow,
                    ProvisionAgreementBean provisionAgreement,
                    java.util.List<TimeRange> lastUpdatedDate,
                    java.lang.Integer maxObs,
                    boolean orderAsc,
                    java.lang.Integer defaultLimit,
                    OBSERVATION_ACTION obsAction,
                    java.lang.String dimensionAtObservation,
                    boolean hasExplicitMeasures,
                    DATA_QUERY_DETAIL queryDetail,
                    java.util.Set<ComplexDataQuerySelection> complexSelections,
                    java.util.Date dateFrom,
                    ORDERED_OPERATOR dateFromOperator,
                    java.util.Date dateTo,
                    ORDERED_OPERATOR dateToOperator,
                    java.util.Set<ComplexComponentValue> primaryMeasureValues)

ComplexDataQueryImpl

public ComplexDataQueryImpl(java.lang.String datasetId,
                    TEXT_SEARCH datasetIdOperator,
                    java.util.Set<DataProviderBean> dataProviders,
                    DataStructureBean dataStructure,
                    DataflowBean dataFlow,
                    ProvisionAgreementBean provisionAgreement,
                    java.util.List<TimeRange> lastUpdatedDate,
                    java.lang.Integer firstNObs,
                    java.lang.Integer lastNObs,
                    java.lang.Integer defaultLimit,
                    OBSERVATION_ACTION obsAction,
                    java.lang.String dimensionAtObservation,
                    boolean hasExplicitMeasures,
                    DATA_QUERY_DETAIL queryDetail,
                    java.util.Set<ComplexDataQuerySelection> complexSelections,
                    java.util.Date dateFrom,
                    ORDERED_OPERATOR dateFromOperator,
                    java.util.Date dateTo,
                    ORDERED_OPERATOR dateToOperator,
                    java.util.Set<ComplexComponentValue> primaryMeasureValues)

Method Detail

getObservationAction

public OBSERVATION_ACTION getObservationAction()

Description copied from interface: ComplexDataQuery

Returns the type of observations to be returned.
Defaults to ACTIVE

Specified by:

getObservationAction in interface ComplexDataQuery

Returns:

dimensionAtObservation

public java.lang.String dimensionAtObservation()

Description copied from interface: BaseDataQuery

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

Specified by:

dimensionAtObservation in interface BaseDataQuery

Returns:

hasExplicitMeasures

public boolean hasExplicitMeasures()

Description copied from interface: ComplexDataQuery

Returns true or false depending on the existence of explicit measures Defaults to false

Specified by:

hasExplicitMeasures in interface ComplexDataQuery

Returns:

getDataQueryDetail

public DATA_QUERY_DETAIL getDataQueryDetail()

Description copied from interface: BaseDataQuery

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)

Specified by:

getDataQueryDetail in interface BaseDataQuery

Returns:

getDatasetId

public java.lang.String getDatasetId()

Description copied from interface: ComplexDataQuery

Returns the id of the dataset from which data will be returned or null if unspecified

Specified by:

getDatasetId in interface ComplexDataQuery

Returns:

getDatasetIdOperator

public TEXT_SEARCH getDatasetIdOperator()

Description copied from interface: ComplexDataQuery

The id of the dataset requested should satisfy the condition implied by the operator this method returns.
For instance if the operator is starts_with then data from a dataset with id that starts with the getDatasetId() result should be returned. Defaults to EQUAL

Specified by:

getDatasetIdOperator in interface ComplexDataQuery

getLastUpdatedDateTimeRange

public java.util.List<TimeRange> getLastUpdatedDateTimeRange()

Description copied from interface: ComplexDataQuery

This method accomplishes the following criteria :match data based on when they were last updated
The date points to the start date or the range that the queried date must occur within and/ or to the end period of the range
It returns null if unspecified.

Specified by:

getLastUpdatedDateTimeRange in interface ComplexDataQuery

Returns:

getDataProvider

public java.util.Set<DataProviderBean> getDataProvider()

Description copied from interface: BaseDataQuery

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

Specified by:

getDataProvider in interface BaseDataQuery

Returns:

getDataStructure

public DataStructureBean getDataStructure()

Description copied from interface: BaseDataQuery

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

Specified by:

getDataStructure in interface BaseDataQuery

Returns:

getDataflow

public DataflowBean getDataflow()

Description copied from interface: BaseDataQuery

Returns the Dataflow that the query is returning data for.

Specified by:

getDataflow in interface BaseDataQuery

Returns:

getProvisionAgreement

public ProvisionAgreementBean getProvisionAgreement()

Description copied from interface: ComplexDataQuery

Returns the Provision Agreement that the query is returning data for or null if unspecified

Specified by:

getProvisionAgreement in interface ComplexDataQuery

Returns:

getSelectionGroups

public java.util.List<ComplexDataQuerySelectionGroup> getSelectionGroups()

Description copied from interface: ComplexDataQuery

Returns a list of selection groups. The list is empty if no selection groups have been added.

Specified by:

getSelectionGroups in interface ComplexDataQuery

Returns:

hasSelections

public boolean hasSelections()

Description copied from interface: BaseDataQuery

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

Specified by:

hasSelections in interface BaseDataQuery

Returns:

getFirstNObservations

public java.lang.Integer getFirstNObservations()

Description copied from interface: BaseDataQuery

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

Specified by:

getFirstNObservations in interface BaseDataQuery

Returns:

first 'n' observations or null if unspecified

getLastNObservations

public java.lang.Integer getLastNObservations()

Description copied from interface: BaseDataQuery

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

Specified by:

getLastNObservations in interface BaseDataQuery

Returns:

last 'n' observations or null if unspecified

getDefaultLimit

public java.lang.Integer getDefaultLimit()

Description copied from interface: ComplexDataQuery

Returns the suggested maximum response size or null if unspecified

Specified by:

getDefaultLimit in interface ComplexDataQuery

Returns: