org.sdmxsource.sdmx.api.manager.retrieval.mutable

Interface CrossReferenceMutableRetrievalManager

public interface CrossReferenceMutableRetrievalManager

The CrossReferenceRetrievalMutableManager is used to retrieve mutable structures that cross reference or are cross referenced by the given structures.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<MaintainableMutableBean>	getCrossReferencedStructures(IdentifiableMutableBean identifiable, boolean returnStub, SDMX_STRUCTURE_TYPE... structures) Returns a list of MaintainableBean that are cross referenced by the given identifiable structure
java.util.List<MaintainableMutableBean>	getCrossReferencedStructures(StructureReferenceBean structureReference, boolean returnStub, SDMX_STRUCTURE_TYPE... structures) Returns a list of MaintainableBean that cross reference the structure(s) that match the reference parameter
MutableCrossReferencingTree	getCrossReferenceTree(MaintainableMutableBean maintainableBean) Returns a tree structure representing the identifiable and all the structures that cross reference it, and the structures that reference them, and so on.
java.util.List<MaintainableMutableBean>	getCrossReferencingStructures(IdentifiableMutableBean identifiable, boolean returnStub, SDMX_STRUCTURE_TYPE... structures) Returns a list of MaintainableBean that cross reference the given identifiable structure
java.util.List<MaintainableMutableBean>	getCrossReferencingStructures(StructureReferenceBean structureReference, boolean returnStub, SDMX_STRUCTURE_TYPE... structures) Returns a list of MaintainableBean that cross reference the structure(s) that match the reference parameter

Method Detail

getCrossReferenceTree

MutableCrossReferencingTree getCrossReferenceTree(MaintainableMutableBean maintainableBean)

Returns a tree structure representing the identifiable and all the structures that cross reference it, and the structures that reference them, and so on.

Returns:

getCrossReferencingStructures

java.util.List<MaintainableMutableBean> getCrossReferencingStructures(StructureReferenceBean structureReference,
                                                                    boolean returnStub,
                                                                    SDMX_STRUCTURE_TYPE... structures)

Returns a list of MaintainableBean that cross reference the structure(s) that match the reference parameter

Parameters:

structureReference - Who References Me?

returnStub - if true, then will return the stubs that reference the structure

structures - an optional parameter to further filter the list by structure type

Returns:

getCrossReferencingStructures

java.util.List<MaintainableMutableBean> getCrossReferencingStructures(IdentifiableMutableBean identifiable,
                                                                    boolean returnStub,
                                                                    SDMX_STRUCTURE_TYPE... structures)

Returns a list of MaintainableBean that cross reference the given identifiable structure

Parameters:

identifiable - the identifiable bean to retrieve the references for - Who References Me?

returnStub - if true, then will return the stubs that reference the structure

structures - an optional parameter to further filter the list by structure type

Returns:

getCrossReferencedStructures

java.util.List<MaintainableMutableBean> getCrossReferencedStructures(StructureReferenceBean structureReference,
                                                                   boolean returnStub,
                                                                   SDMX_STRUCTURE_TYPE... structures)

Returns a list of MaintainableBean that cross reference the structure(s) that match the reference parameter

Parameters:

structureReference - - What Do I Reference?

returnStub - if true, then will return the stubs that reference the structure

structures - an optional parameter to further filter the list by structure type

Returns:

getCrossReferencedStructures

java.util.List<MaintainableMutableBean> getCrossReferencedStructures(IdentifiableMutableBean identifiable,
                                                                   boolean returnStub,
                                                                   SDMX_STRUCTURE_TYPE... structures)

Returns a list of MaintainableBean that are cross referenced by the given identifiable structure

Parameters:

identifiable - the identifiable bean to retrieve the references for - What Do I Reference?

returnStub - if true, then will return the stubs that reference the structure

structures - an optional parameter to further filter the list by structure type

Returns: