org.sdmxsource.sdmx.api.manager.retrieval

Interface DataConstraintRetrievalManager

public interface DataConstraintRetrievalManager

The DataConstraintRetrievalManager manages the retrieval of data constraints for a given constrainable artefact

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<KeyValue>	filterKeysUsingCubeRegion(DataQuery dataQuery) The cube region takes into account whether data exists for a concept/code combination based on the selected codes in the data query, the constraint codes are determined from what has been attached to the constrainable artifact if it is given, if the constrainable artifact is null, then the key family from the data query will be used as the constrainable artifact.
java.util.Set<KeyValue>	getAllValidKeyValues(ConstrainableBean constrainable) Returns all the valid key values for this constrainable bean
java.util.Date	getDataEndDate(ConstrainableBean constrainable) Returns the end date for the constrainable bean
java.util.Date	getDataStartDate(ConstrainableBean constrainable) Returns the start date for the constrainable bean
boolean	hasConstraint(ConstrainableBean constrainable) Returns true if there are constraints available for this constrainable bean

Method Detail

hasConstraint

boolean hasConstraint(ConstrainableBean constrainable)

Returns true if there are constraints available for this constrainable bean

Parameters:

keyFamily -

Returns:

filterKeysUsingCubeRegion

java.util.Set<KeyValue> filterKeysUsingCubeRegion(DataQuery dataQuery)

The cube region takes into account whether data exists for a concept/code combination based on the selected codes in the data query, the constraint codes are determined from what has been attached to the constrainable artifact if it is given, if the constrainable artifact is null, then the key family from the data query will be used as the constrainable artifact.

A set of valid keys is returned based on the data query passed in, which contains concept/code selections, in this way the result is `what is still a valid selection based on the selections that have already been made`

getAllValidKeyValues

java.util.Set<KeyValue> getAllValidKeyValues(ConstrainableBean constrainable)

Returns all the valid key values for this constrainable bean

Returns:

getDataStartDate

java.util.Date getDataStartDate(ConstrainableBean constrainable)

Returns the start date for the constrainable bean

Returns:

getDataEndDate

java.util.Date getDataEndDate(ConstrainableBean constrainable)

Returns the end date for the constrainable bean

Returns: