org.sdmxsource.sdmx.api.manager.retrieval

Interface SdmxBeanRetrievalManager

All Superinterfaces:

IdentifiableRetrievalManager

All Known Implementing Classes:

BaseSdmxBeanRetrievalManager, InMemoryRetrievalManager, RESTSdmxBeanRetrievalManager

public interface SdmxBeanRetrievalManager
extends IdentifiableRetrievalManager

Manages the retrieval of structures.

The SdmxBeanRetrievalManager contains the means to return beans by simple search criteria, based on a reference structure,

Method Summary

Methods

Modifier and Type	Method and Description
<T extends MaintainableBean> T	getMaintainableBean(java.lang.Class<T> structureType, MaintainableRefBean ref) Returns the Maintainable that is of the given type, determined by T, and matches the reference parameters in the MaintainableRef.
<T extends MaintainableBean> T	getMaintainableBean(java.lang.Class<T> structureType, MaintainableRefBean ref, boolean returnStub, boolean returnLatest) Returns the Maintainable that is of the given type, determined by T, and matches the reference parameters in the MaintainableRef.
MaintainableBean	getMaintainableBean(StructureReferenceBean sRef) Obtains a MaintainableBean identified by the StructureReferenceBean.
MaintainableBean	getMaintainableBean(StructureReferenceBean sRef, boolean returnStub, boolean returnLatest) Obtains a MaintainableBean identified by the StructureReferenceBean.
<T extends MaintainableBean> java.util.Set<T>	getMaintainableBeans(java.lang.Class<T> structureType) Obtains a set of all MaintainableBeans of type T An empty Set will be returned if there are no matches to the query
<T extends MaintainableBean> java.util.Set<T>	getMaintainableBeans(java.lang.Class<T> structureType, MaintainableRefBean ref) Obtains a set of MaintainableBeans of type T that match the reference parameters in the MaintainableRef argument.
<T extends MaintainableBean> java.util.Set<T>	getMaintainableBeans(java.lang.Class<T> structureType, MaintainableRefBean ref, boolean returnLatest, boolean returnStub) Obtains a set of MaintainableBeans of type T that match the reference parameters in the MaintainableRef argument.
SdmxBeans	getMaintainables(RESTStructureQuery restquery) Get all the maintainables that match the RESTStructureQuery
SdmxBeans	getSdmxBeans(StructureReferenceBean sRef, ResolutionSettings.RESOLVE_CROSS_REFERENCES resolveCrossReferences) Returns a SdmxBeans container containing all the MaintainableBeans that match the query parameters as defined by the StructureReferenceBean.

Methods inherited from interface org.sdmxsource.sdmx.api.manager.retrieval.IdentifiableRetrievalManager

getAgency, getIdentifiableBean, getIdentifiableBean, getIdentifiableBean, getIdentifiableBeans

Method Detail

getMaintainables

SdmxBeans getMaintainables(RESTStructureQuery restquery)

Get all the maintainables that match the RESTStructureQuery

Parameters:

restquery -

Returns:

getSdmxBeans

SdmxBeans getSdmxBeans(StructureReferenceBean sRef,
                     ResolutionSettings.RESOLVE_CROSS_REFERENCES resolveCrossReferences)

Returns a SdmxBeans container containing all the MaintainableBeans that match the query parameters as defined by the StructureReferenceBean.

Parameters:

sRef - The StructureReferenceBean which must not be null

resolveCrossReferences - either 'do not resolve', 'resolve all' or 'resolve all excluding agencies'. If not set to 'do not resolve' then all the structures that are referenced by the resulting structures are also returned (and also their children). This will be equivalent to descendants for a RESTful query.

Returns:

An SdmxBeans containing the appropriate Maintainable Beans.

Throws:

java.lang.IllegalArgumentException - if the StructureReferenceBean is null

getMaintainableBean

MaintainableBean getMaintainableBean(StructureReferenceBean sRef)

Obtains a MaintainableBean identified by the StructureReferenceBean. This is expected to only return a single MaintainableBean and will throw and Exception if more then one are returned.

Null will be returned if there are no matches to the query

Parameters:

sRef - identifies the structure type, and the identifiers of the structure, can include widcarded values (null indicates a wildcard). If version information is missing, then latest version is assumed

Returns:

Throws:

SdmxException - if more then one structure matches the query

getMaintainableBean

MaintainableBean getMaintainableBean(StructureReferenceBean sRef,
                                   boolean returnStub,
                                   boolean returnLatest)

Obtains a MaintainableBean identified by the StructureReferenceBean. This is expected to only return a single MaintainableBean and will throw and Exception if more then one are returned.

Null will be returned if there are no matches to the query

Parameters:

sRef - identifies the structure type, and the identifiers of the structure, can include widcarded values (null indicates a wildcard). If version information is missing, then latest version is assumed

returnStub - if true then the stub bean will be returned instead of the full structure

returnLatest - if true then the latest version is returned, regardless of whether version information is supplied

Returns:

Throws:

SdmxException - if more then one structure matches the query

getMaintainableBean

<T extends MaintainableBean> T getMaintainableBean(java.lang.Class<T> structureType,
                                                 MaintainableRefBean ref)

Returns the Maintainable that is of the given type, determined by T, and matches the reference parameters in the MaintainableRef.

Parameters:

structureType - identifying the Class type to return

ref - contains the parameters that must match on the returned structure. If version information is missing, then latest version is assumed

Returns:

Throws:

SdmxException - if more then one structure matches the query

getMaintainableBean

<T extends MaintainableBean> T getMaintainableBean(java.lang.Class<T> structureType,
                                                 MaintainableRefBean ref,
                                                 boolean returnStub,
                                                 boolean returnLatest)

Returns the Maintainable that is of the given type, determined by T, and matches the reference parameters in the MaintainableRef.

Parameters:

structureType - identifying the Class type to return

ref - contains the parameters that must match on the returned structure. If version information is missing, then latest version is assumed

returnStub - if true then the stub bean will be returned instead of the full structure

returnLatest - if true then the latest version is returned, regardless of whether version information is supplied

Returns:

Throws:

SdmxException - if more then one structure matches the query

getMaintainableBeans

<T extends MaintainableBean> java.util.Set<T> getMaintainableBeans(java.lang.Class<T> structureType)

Obtains a set of all MaintainableBeans of type T

An empty Set will be returned if there are no matches to the query

Parameters:

structureType - identifies the structure of type to return, if argument is null or Maintainable.class then all maintainables will be returned

Returns:

getMaintainableBeans

<T extends MaintainableBean> java.util.Set<T> getMaintainableBeans(java.lang.Class<T> structureType,
                                                                 MaintainableRefBean ref)

Obtains a set of MaintainableBeans of type T that match the reference parameters in the MaintainableRef argument.

An empty Set will be returned if there are no matches to the query

Parameters:

structureType - identifies the structure type

ref - contains the identifiers of the structures to returns, can include widcarded values (null indicates a wildcard).

Returns:

getMaintainableBeans

<T extends MaintainableBean> java.util.Set<T> getMaintainableBeans(java.lang.Class<T> structureType,
                                                                 MaintainableRefBean ref,
                                                                 boolean returnLatest,
                                                                 boolean returnStub)

Obtains a set of MaintainableBeans of type T that match the reference parameters in the MaintainableRef argument.

An empty Set will be returned if there are no matches to the query

Parameters:

structureType - identifies the structure type

ref - contains the identifiers of the structures to returns, can include widcarded values (null indicates a wildcard).

returnLatest - if true then the latest version is returned, regardless of whether version information is supplied

returnStub - if true then the stub bean will be returned instead of the full structure

Returns: