org.sdmxsource.sdmx.api.model.superbeans.metadata

Interface ReferenceValueSuperBean

All Superinterfaces:

java.io.Serializable, SuperBean

All Known Implementing Classes:

ReferenceValueSuperBeanImpl

public interface ReferenceValueSuperBean
extends SuperBean

ReferenceValue contains a value for a target reference object reference.

When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period.

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
ReferenceValueBean	getBuiltFrom() Override from parent - returns the ReferenceValueBean that was used to build this SuperBean
ContentConstraintBean	getContentConstraintReference() Returns the content constraint that this structure references, returns null if there is no reference
java.util.List<DataKeyBean>	getDataKeys() Returns a list of data keys, will return an empty list if isDatasetReference() is false
java.lang.String	getDatasetId() Returns the id of the dataset this bean is referencing, returns null if this is not a dataset reference.
java.lang.String	getId() Returns the id of this reference value
IdentifiableBean	getIdentifiableReference() Returns the identifiable structure that this reference value is using, if this is a dataset reference this will return a reference to a data provider.
boolean	isContentConstriantReference() Returns true if this is a content constraint reference, if true getContentConstraintReference() will return a not null value
boolean	isDatakeyReference() Returns true if this is a datakey reference, if true getDataKeys() will return 1 or more items
boolean	isDatasetReference() Returns true if this is a dataset reference, if true getIdentifiableReference() AND getDatasetId() will NOT be null
boolean	isIdentifiableReference() Returns true if this is an identifiable structure reference, if true getIdentifiableReference() will NOT be null

Methods inherited from interface org.sdmxsource.sdmx.api.model.superbeans.base.SuperBean

getCompositeBeans

Method Detail

getId

java.lang.String getId()

Returns the id of this reference value

Returns:

getDatasetId

java.lang.String getDatasetId()

Returns the id of the dataset this bean is referencing, returns null if this is not a dataset reference.

NOTE : This is to be used in conjunction with the getIdentifiableReference() which will return the data provider reference

Returns:

getIdentifiableReference

IdentifiableBean getIdentifiableReference()

Returns the identifiable structure that this reference value is using, if this is a dataset reference this will return a reference to a data provider.

Returns null if there is no reference to an identifiable structure

Returns:

getContentConstraintReference

ContentConstraintBean getContentConstraintReference()

Returns the content constraint that this structure references, returns null if there is no reference

Returns:

getDataKeys

java.util.List<DataKeyBean> getDataKeys()

Returns a list of data keys, will return an empty list if isDatasetReference() is false

Returns:

isDatasetReference

boolean isDatasetReference()

Returns true if this is a dataset reference, if true getIdentifiableReference() AND getDatasetId() will NOT be null

Returns:

isIdentifiableReference

boolean isIdentifiableReference()

Returns true if this is an identifiable structure reference, if true getIdentifiableReference() will NOT be null

Returns:

isDatakeyReference

boolean isDatakeyReference()

Returns true if this is a datakey reference, if true getDataKeys() will return 1 or more items

Returns:

isContentConstriantReference

boolean isContentConstriantReference()

Returns true if this is a content constraint reference, if true getContentConstraintReference() will return a not null value

Returns:

getBuiltFrom

ReferenceValueBean getBuiltFrom()

Override from parent - returns the ReferenceValueBean that was used to build this SuperBean

Specified by:

getBuiltFrom in interface SuperBean

Returns: