org.sdmxsource.sdmx.structureretrieval.engine.impl

Class CrossReferenceResolverEngineImpl

java.lang.Object

org.sdmxsource.sdmx.structureretrieval.engine.impl.CrossReferenceResolverEngineImpl

All Implemented Interfaces:

CrossReferenceResolverEngine

@Configurable
public class CrossReferenceResolverEngineImpl
extends java.lang.Object
implements CrossReferenceResolverEngine

Constructor Summary

Constructors

Constructor and Description
CrossReferenceResolverEngineImpl() Default Constructor
CrossReferenceResolverEngineImpl(SdmxBeans beans) Constructor which pre-populates cache

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Set<MaintainableBean>>	getMissingAgencies(SdmxBeans beans, IdentifiableRetrievalManager retrievalManager) For the included beans, returns a map of agency URN to maintainable Bean that references the agency
java.util.Map<IdentifiableBean,java.util.Set<CrossReferenceBean>>	getMissingCrossReferences(SdmxBeans beans, int numberLevelsDeep, IdentifiableRetrievalManager retrievalManager) Returns a Map of Identifiable Beans alongside any cross references they declare that could not be found in the set of SdmxBeans provided, and the SdmxBeanRetrievalManager (if given).
IdentifiableBean	resolveCrossReference(CrossReferenceBean crossReference, IdentifiableRetrievalManager structRetrievalManager) Resolves a reference from a cross reference bean
java.util.Set<IdentifiableBean>	resolveReferences(MaintainableBean bean, boolean resolveAgencies, int numberLevelsDeep, IdentifiableRetrievalManager retrievalManager) Returns a set of IdentifiableBeans that the MaintainableBean cross references
java.util.Set<IdentifiableBean>	resolveReferences(ProvisionAgreementBean provision, IdentifiableRetrievalManager structRetrievalManager) Returns a set of structures that are directly referenced from this provision
java.util.Set<IdentifiableBean>	resolveReferences(RegistrationBean registation, ProvisionBeanRetrievalManager provRetrievalManager) Returns a set of IdentifiableBeans that are directly referenced from this registration
java.util.Map<IdentifiableBean,java.util.Set<IdentifiableBean>>	resolveReferences(SdmxBeans beans, boolean resolveAgencies, int numberLevelsDeep, IdentifiableRetrievalManager retrievalManager) Resolves all references and returns a Map containing all the input beans and the beans that are cross referenced, the Map's keyset contains the Identifiable that is the referencer and the Map's value collection contains the referenced artifacts.

Methods inherited from class java.lang.Object

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

Constructor Detail

CrossReferenceResolverEngineImpl

public CrossReferenceResolverEngineImpl()

Default Constructor

CrossReferenceResolverEngineImpl

public CrossReferenceResolverEngineImpl(SdmxBeans beans)

Constructor which pre-populates cache

Method Detail

getMissingCrossReferences

public java.util.Map<IdentifiableBean,java.util.Set<CrossReferenceBean>> getMissingCrossReferences(SdmxBeans beans,
                                                                                          int numberLevelsDeep,
                                                                                          IdentifiableRetrievalManager retrievalManager)

Description copied from interface: CrossReferenceResolverEngine

Returns a Map of Identifiable Beans alongside any cross references they declare that could not be found in the set of SdmxBeans provided, and the SdmxBeanRetrievalManager (if given).

NOTE : An empty Map is returned if all cross references are present.

Specified by:

getMissingCrossReferences in interface CrossReferenceResolverEngine

Parameters:

beans - - the beans to return the Map of missing references for

numberLevelsDeep - - the number of times to recurse down the reference stack. An example is a dataflow directly references a DSD (numberLevelsDeep=1), the DSD may in turn reference a Codelist (numberLevelsDeep=2). The numberLevelsDeep argument can be a positive integer specifying how deeply to resolve the references, an argument of 0 (zero) implies there is no limit, and the resolver engine will continue recursing until it has found every directly and indirectly referenced

Returns:

Map of IdentifiableBean vs Set of CrossReferences that could not be resolved for the IdentifiableBean - an empty Map is returned if all cross references are present

resolveReferences

public java.util.Set<IdentifiableBean> resolveReferences(ProvisionAgreementBean provision,
                                                IdentifiableRetrievalManager structRetrievalManager)

Description copied from interface: CrossReferenceResolverEngine

Returns a set of structures that are directly referenced from this provision

Specified by:

resolveReferences in interface CrossReferenceResolverEngine

Parameters:

provision - - the provision to resolve the references for

structRetrievalManager - - must not be null as this will be used to resolve the references

Returns:

getMissingAgencies

public java.util.Map<java.lang.String,java.util.Set<MaintainableBean>> getMissingAgencies(SdmxBeans beans,
                                                                                 IdentifiableRetrievalManager retrievalManager)

Description copied from interface: CrossReferenceResolverEngine

For the included beans, returns a map of agency URN to maintainable Bean that references the agency

Specified by:

getMissingAgencies in interface CrossReferenceResolverEngine

Returns:

resolveReferences

public java.util.Set<IdentifiableBean> resolveReferences(RegistrationBean registation,
                                                ProvisionBeanRetrievalManager provRetrievalManager)

Description copied from interface: CrossReferenceResolverEngine

Returns a set of IdentifiableBeans that are directly referenced from this registration

Specified by:

resolveReferences in interface CrossReferenceResolverEngine

Parameters:

registation - - the registration to resolve the references for

provRetrievalManager - - Used to resolve the provision references. Can be null if registration is not linked to a provision

Returns:

resolveReferences

public java.util.Map<IdentifiableBean,java.util.Set<IdentifiableBean>> resolveReferences(SdmxBeans beans,
                                                                                boolean resolveAgencies,
                                                                                int numberLevelsDeep,
                                                                                IdentifiableRetrievalManager retrievalManager)
                                                                                  throws CrossReferenceException

Description copied from interface: CrossReferenceResolverEngine

Resolves all references and returns a Map containing all the input beans and the beans that are cross referenced, the Map's keyset contains the Identifiable that is the referencer and the Map's value collection contains the referenced artifacts.

Specified by:

resolveReferences in interface CrossReferenceResolverEngine

Parameters:

beans - - the SdmxBeans container, containing all the beans to check references for

resolveAgencies - - if true the resolver engine will also attempt to resolve referenced agencies

numberLevelsDeep - - the number of times to recurse down the reference stack. An example is a dataflow directly references a DSD (numberLevelsDeep=1), the DSD may in turn reference a Codelist (numberLevelsDeep=2). The numberLevelsDeep argument can be a positive integer specifying how deeply to resolve the references, an argument of 0 (zero) implies there is no limit, and the resolver engine will continue recursing until it has found every directly and indirectly referenced artifact. Note that there is no risk of infinite recursion in calling this.

Returns:

Map of referencers vs referencees

Throws:

CrossReferenceException - - if any of the references could not be resolved

resolveReferences

public java.util.Set<IdentifiableBean> resolveReferences(MaintainableBean bean,
                                                boolean resolveAgencies,
                                                int numberLevelsDeep,
                                                IdentifiableRetrievalManager retrievalManager)
                                                  throws CrossReferenceException

Description copied from interface: CrossReferenceResolverEngine

Returns a set of IdentifiableBeans that the MaintainableBean cross references

Specified by:

resolveReferences in interface CrossReferenceResolverEngine

resolveAgencies - - if true will also resolve the agencies

numberLevelsDeep - - the number of times to recurse down the reference stack. An example is a dataflow directly references a DSD (numberLevelsDeep=1), the DSD may in turn reference a Codelist (numberLevelsDeep=2). The numberLevelsDeep argument can be a positive integer specifying how deeply to resolve the references, an argument of 0 (zero) implies there is no limit, and the resolver engine will continue recursing until it has found every directly and indirectly referenced artifact. Note that there is no risk of infinite recursion in calling this.

Throws:

CrossReferenceException - - if any of the references could not be resolved

resolveCrossReference

public IdentifiableBean resolveCrossReference(CrossReferenceBean crossReference,
                                     IdentifiableRetrievalManager structRetrievalManager)
                                       throws CrossReferenceException

Description copied from interface: CrossReferenceResolverEngine

Resolves a reference from a cross reference bean

Specified by:

resolveCrossReference in interface CrossReferenceResolverEngine

Returns:

Throws:

CrossReferenceException