org.sdmxsource.sdmx.api.model.beans.reference

Interface StructureReferenceBean

All Superinterfaces:

MaintainableRefBean, java.io.Serializable

All Known Subinterfaces:

CrossReferenceBean

All Known Implementing Classes:

CrossReferenceBeanImpl, StructureReferenceBeanImpl

public interface StructureReferenceBean
extends java.io.Serializable, MaintainableRefBean

A StructureReferenceBean is used to reference an identifiable artifact using a combination of reference parameters.

If all reference parameters are present then the reference is for a single identifiable item, if any are missing, then this represents a wildcard parameter / or ALL.

SDMX_STRUCTURE_TYPE is a mandatory reference parameter, all others are optional

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
StructureReferenceBean	createCopy() Creates a copy of this bean
java.lang.String	getAgencyId() Returns the maintainable id attribute
IdentifiableRefBean	getChildReference() Returns the child artifact that is being referenced, returns null if there is no child artifact
java.lang.String	getFullId() Returns the full id of the identifiable reference.
java.lang.String[]	getIdentifiableIds() Returns a string array of any child ids (obtained from getChildReference()), returns null if getChildReference() is null
java.lang.String	getMaintainableId() Returns the maintainable id attribute
MaintainableRefBean	getMaintainableReference() Returns the reference parameters as a maintainable reference
SDMX_STRUCTURE_TYPE	getMaintainableStructureType() Returns the SDMX Structure that is being referenced at the top level (maintainable level) by this reference bean.
java.lang.String	getMaintainableUrn() Returns the URN of the maintainable structure that is being referenced, returns null if there is no URN available
IdentifiableBean	getMatch(MaintainableBean maintainbleBean) Returns the matched Identifiable Bean from this reference, returns the original Maintainable if this is a Maintainable reference that matches the maintainable.
SDMX_STRUCTURE_TYPE	getTargetReference() Returns the SDMX Structure that is being referenced by this reference bean.
java.lang.String	getTargetUrn() Returns the URN of the target structure that is being referenced, returns null if there is no URN available
java.lang.String	getVersion() Returns the version attribute
boolean	hasAgencyId() Returns true if there is an agency Id set
boolean	hasChildReference() Returns true if getChildReference returns a value
boolean	hasMaintainableId() Returns true if there is a maintainable id set
boolean	hasMaintainableUrn() Returns true if getMaintainableUrn returns a value
boolean	hasTargetUrn() Returns true if getTargetUrn returns a value
boolean	hasVersion() Returns true if there is a value for version set
boolean	isMatch(MaintainableBean reference) Returns true if this reference matches the MaintainableBean, or one of its indentifiable composites.

Method Detail

createCopy

StructureReferenceBean createCopy()

Creates a copy of this bean

Returns:

getMaintainableStructureType

SDMX_STRUCTURE_TYPE getMaintainableStructureType()

Returns the SDMX Structure that is being referenced at the top level (maintainable level) by this reference bean.

Any child references will further refine the structure type that is being referenced.

Returns:

getTargetReference

SDMX_STRUCTURE_TYPE getTargetReference()

Returns the SDMX Structure that is being referenced by this reference bean.

Returns:

getChildReference

IdentifiableRefBean getChildReference()

Returns the child artifact that is being referenced, returns null if there is no child artifact

Returns:

getIdentifiableIds

java.lang.String[] getIdentifiableIds()

Returns a string array of any child ids (obtained from getChildReference()), returns null if getChildReference() is null

Returns:

getFullId

java.lang.String getFullId()

Returns the full id of the identifiable reference. This is a dot '.' separated id which consists of the parent identifiable ids and the target. If the referenced structure is a Sub-Agency then this will include the parent Agency ids, and the id of the target agency. If this reference is referencing a maintainable then null will be returned. If there is only one child identifiable, then the id of that identifable will be returned, with no '.' seperators.

Returns:

getMaintainableReference

MaintainableRefBean getMaintainableReference()

Returns the reference parameters as a maintainable reference

Returns:

getAgencyId

java.lang.String getAgencyId()

Returns the maintainable id attribute

Specified by:

getAgencyId in interface MaintainableRefBean

Returns:

hasAgencyId

boolean hasAgencyId()

Returns true if there is an agency Id set

Specified by:

hasAgencyId in interface MaintainableRefBean

Returns:

getMaintainableId

java.lang.String getMaintainableId()

Returns the maintainable id attribute

Specified by:

getMaintainableId in interface MaintainableRefBean

Returns:

hasMaintainableId

boolean hasMaintainableId()

Returns true if there is a maintainable id set

Specified by:

hasMaintainableId in interface MaintainableRefBean

Returns:

getVersion

java.lang.String getVersion()

Returns the version attribute

Specified by:

getVersion in interface MaintainableRefBean

Returns:

hasVersion

boolean hasVersion()

Returns true if there is a value for version set

Specified by:

hasVersion in interface MaintainableRefBean

Returns:

hasChildReference

boolean hasChildReference()

Returns true if getChildReference returns a value

Returns:

getTargetUrn

java.lang.String getTargetUrn()

Returns the URN of the target structure that is being referenced, returns null if there is no URN available

hasTargetUrn

boolean hasTargetUrn()

Returns true if getTargetUrn returns a value

Returns:

getMaintainableUrn

java.lang.String getMaintainableUrn()

Returns the URN of the maintainable structure that is being referenced, returns null if there is no URN available

hasMaintainableUrn

boolean hasMaintainableUrn()

Returns true if getMaintainableUrn returns a value

Returns:

isMatch

boolean isMatch(MaintainableBean reference)

Returns true if this reference matches the MaintainableBean, or one of its indentifiable composites.

This bean does not require all reference parameters to be set, this method will return true if all the parameters that are set match the bean passed in. If this reference is referencing an Identifiable composite, then the maintainable's identifiable composites will also be checked to determine if this is a match.

Parameters:

reference -

Returns:

getMatch

IdentifiableBean getMatch(MaintainableBean maintainbleBean)

Returns the matched Identifiable Bean from this reference, returns the original Maintainable if this is a Maintainable reference that matches the maintainable. Returns null if no match is found

Parameters:

maintainbleBean -

Returns: