org.sdmxsource.sdmx.structureretrieval.manager

Class RESTSdmxBeanRetrievalManager

java.lang.Object

org.sdmxsource.sdmx.structureretrieval.manager.IdentifiableRetrievalManagerImpl

org.sdmxsource.sdmx.structureretrieval.manager.BaseSdmxBeanRetrievalManager

org.sdmxsource.sdmx.structureretrieval.manager.RESTSdmxBeanRetrievalManager

All Implemented Interfaces:

IdentifiableRetrievalManager, SdmxBeanRetrievalManager, org.springframework.beans.factory.InitializingBean

public class RESTSdmxBeanRetrievalManager
extends BaseSdmxBeanRetrievalManager

Constructor Summary

Constructors

Constructor and Description
RESTSdmxBeanRetrievalManager(java.lang.String restURL)

Method Summary

Methods

Modifier and Type	Method and Description
<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 sQuery) 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 class org.sdmxsource.sdmx.structureretrieval.manager.BaseSdmxBeanRetrievalManager

afterPropertiesSet, getAgency, getMaintainableBean, getMaintainableBean, getMaintainableBean, getMaintainableBean, getMaintainableBeans, getMaintainableBeans, setCrossReferenceRetrievalManager, setCrossReferencingRetrievalManager, setExternalReferenceRetrievalManager, setHeaderRetrievalManager, setProxy, setRegistrationRetrievalManager, setServiceRetrievalManager

Methods inherited from class org.sdmxsource.sdmx.structureretrieval.manager.IdentifiableRetrievalManagerImpl

getIdentifiableBean, getIdentifiableBean, getIdentifiableBean, getIdentifiableBean, getIdentifiableBeans

Methods inherited from class java.lang.Object

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

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

getIdentifiableBean, getIdentifiableBean, getIdentifiableBean, getIdentifiableBeans

Constructor Detail

RESTSdmxBeanRetrievalManager

public RESTSdmxBeanRetrievalManager(java.lang.String restURL)

Method Detail

getMaintainables

public SdmxBeans getMaintainables(RESTStructureQuery sQuery)

Description copied from interface: SdmxBeanRetrievalManager

Get all the maintainables that match the RESTStructureQuery

Specified by:

getMaintainables in interface SdmxBeanRetrievalManager

Overrides:

getMaintainables in class BaseSdmxBeanRetrievalManager

Returns:

getSdmxBeans

public SdmxBeans getSdmxBeans(StructureReferenceBean sRef,
                     ResolutionSettings.RESOLVE_CROSS_REFERENCES resolveCrossReferences)

Description copied from interface: SdmxBeanRetrievalManager

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

Specified by:

getSdmxBeans in interface SdmxBeanRetrievalManager

Overrides:

getSdmxBeans in class BaseSdmxBeanRetrievalManager

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.

getMaintainableBeans

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

Description copied from interface: SdmxBeanRetrievalManager

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

Specified by:

getMaintainableBeans in interface SdmxBeanRetrievalManager

Overrides:

getMaintainableBeans in class BaseSdmxBeanRetrievalManager

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: