org.sdmxsource.sdmx.sdmxbeans.model.metadata

Class ReferenceValueBeanImpl

java.lang.Object

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.SDMXBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.metadata.ReferenceValueBeanImpl

All Implemented Interfaces:

java.io.Serializable, SDMXBean, ReferenceValueBean

public class ReferenceValueBeanImpl
extends SDMXBeanImpl
implements ReferenceValueBean

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.sdmxsource.sdmx.api.model.metadata.ReferenceValueBean

ReferenceValueBean.TARGET_TYPE

Constructor Summary

Constructors

Constructor and Description
ReferenceValueBeanImpl(TargetBean parent, org.sdmx.resources.sdmxml.schemas.v21.metadata.generic.ReferenceValueType type)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deepEquals(SDMXBean bean, boolean includeFinalProperties) Returns true if this SdmxBean equals the given bean in every respect (except for the validTo property of a maintainable artefact, this is not taken into consideration) This method calls deepEquals on any SdmxBean composites.
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
java.lang.String	toString()

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.SDMXBeanImpl

getComposites, getComposites, getCrossReferences, getParent, getParent, getStructureType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.SDMXBean

getComposites, getComposites, getCrossReferences, getParent, getParent, getStructureType

Constructor Detail

ReferenceValueBeanImpl

public ReferenceValueBeanImpl(TargetBean parent,
                      org.sdmx.resources.sdmxml.schemas.v21.metadata.generic.ReferenceValueType type)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: ReferenceValueBean

Returns the id of this reference value

Specified by:

getId in interface ReferenceValueBean

Returns:

getTargetType

public ReferenceValueBean.TARGET_TYPE getTargetType()

Description copied from interface: ReferenceValueBean

Returns an enum defining what this reference value is referencing

Specified by:

getTargetType in interface ReferenceValueBean

Returns:

getDatasetId

public java.lang.String getDatasetId()

Description copied from interface: ReferenceValueBean

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

Specified by:

getDatasetId in interface ReferenceValueBean

Returns:

getReportPeriod

public SdmxDate getReportPeriod()

Description copied from interface: ReferenceValueBean

Returns the date for which this report is relevant

Specified by:

getReportPeriod in interface ReferenceValueBean

Returns:

getIdentifiableReference

public CrossReferenceBean getIdentifiableReference()

Description copied from interface: ReferenceValueBean

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

Specified by:

getIdentifiableReference in interface ReferenceValueBean

Returns:

getContentConstraintReference

public CrossReferenceBean getContentConstraintReference()

Description copied from interface: ReferenceValueBean

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

Specified by:

getContentConstraintReference in interface ReferenceValueBean

Returns:

isDatakeyReference

public boolean isDatakeyReference()

Description copied from interface: ReferenceValueBean

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

Specified by:

isDatakeyReference in interface ReferenceValueBean

Returns:

isContentConstriantReference

public boolean isContentConstriantReference()

Description copied from interface: ReferenceValueBean

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

Specified by:

isContentConstriantReference in interface ReferenceValueBean

Returns:

getDataKeys

public java.util.List<DataKeyBean> getDataKeys()

Description copied from interface: ReferenceValueBean

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

Specified by:

getDataKeys in interface ReferenceValueBean

Returns:

isDatasetReference

public boolean isDatasetReference()

Description copied from interface: ReferenceValueBean

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

Specified by:

isDatasetReference in interface ReferenceValueBean

Returns:

isIdentifiableReference

public boolean isIdentifiableReference()

Description copied from interface: ReferenceValueBean

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

Specified by:

isIdentifiableReference in interface ReferenceValueBean

Returns:

deepEquals

public boolean deepEquals(SDMXBean bean,
                 boolean includeFinalProperties)

Description copied from interface: SDMXBean

Returns true if this SdmxBean equals the given bean in every respect (except for the validTo property of a maintainable artefact, this is not taken into consideration)

This method calls deepEquals on any SdmxBean composites.

Specified by:

deepEquals in interface SDMXBean

Overrides:

deepEquals in class SDMXBeanImpl

Parameters:

bean - if null, then false will be returned

includeFinalProperties - - if true, then this method will check every single property from this bean is equal to the passed in bean. If false, then this method will ignore the following properties:

• Name
• Description
• Annotation
• Valid From (Start Date)
• Valid To (End Date)
• Structure URL
• Service URL
• URI
• Is External Reference

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object