org.sdmxsource.sdmx.api.model.metadata

Interface ReferenceValueBean

All Superinterfaces:

SDMXBean, java.io.Serializable

All Known Implementing Classes:

ReferenceValueBeanImpl

public interface ReferenceValueBean
extends SDMXBean

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReferenceValueBean.TARGET_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
CrossReferenceBean	getContentConstraintReference() Returns the reference to the content constraint, if there is one
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
CrossReferenceBean	getIdentifiableReference() Returns a reference to any identifiable structure, if this is a dataset reference this will return a reference to a data provider.
SdmxDate	getReportPeriod() Returns the date for which this report is relevant
ReferenceValueBean.TARGET_TYPE	getTargetType() Returns an enum defining what this reference value is referencing
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.beans.base.SDMXBean

deepEquals, getComposites, getComposites, getCrossReferences, getParent, getParent, getStructureType

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:

getReportPeriod

SdmxDate getReportPeriod()

Returns the date for which this report is relevant

Returns:

getIdentifiableReference

CrossReferenceBean getIdentifiableReference()

Returns a reference to any identifiable structure, 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

CrossReferenceBean getContentConstraintReference()

Returns the reference to the content constraint, if there is one

Returns:

getDataKeys

java.util.List<DataKeyBean> getDataKeys()

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

Returns:

getTargetType

ReferenceValueBean.TARGET_TYPE getTargetType()

Returns an enum defining what this reference value is referencing

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: