org.sdmxsource.sdmx.sdmxbeans.model.beans.datastructure

Class AttributeBeanImpl

java.lang.Object

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

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

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

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

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

org.sdmxsource.sdmx.sdmxbeans.model.beans.datastructure.AttributeBeanImpl

All Implemented Interfaces:

java.io.Serializable, AnnotableBean, ComponentBean, IdentifiableBean, SDMXBean, SdmxStructureBean, AttributeBean

public class AttributeBeanImpl
extends ComponentBeanImpl
implements AttributeBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeBeanImpl(AttributeMutableBean attribute, AttributeListBean parent)
AttributeBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.structure.AttributeType attribute, AttributeListBean parent)
AttributeBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.structure.AttributeType attribute, AttributeListBean parent)
AttributeBeanImpl(org.sdmx.resources.sdmxml.schemas.v10.xmlbeans.structure.AttributeType attribute, AttributeListBean parent)

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.
java.lang.String	getAssignmentStatus() The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data.
java.lang.String	getAttachmentGroup() If ATTRIBUTE_ATTACHMENT_LEVEL is GROUP then returns a reference to the Group id that this attribute is attached to.
ATTRIBUTE_ATTACHMENT_LEVEL	getAttachmentLevel() Returns the ATTRIBUTE_ATTACHMENT_LEVEL attribute indicating the level to which the attribute is attached in time-series formats (generic, compact, utility data formats).
java.util.List<CrossReferenceBean>	getConceptRoles() Returns a list of cross references to concepts that are used to define the role(s) of this attribute.
java.util.List<java.lang.String>	getDimensionReferences() Returns the list of dimension ids that this attribute references, this is only relevant if ATTRIBUTE_ATTACHMENT_LEVEL is DIMENSION_GROUP.
java.lang.String	getPrimaryMeasureReference() If ATTRIBUTE_ATTACHMENT_LEVEL is OBSERVATION then returns a reference to the Primary Measure id that this attribute is attached to.
boolean	isMandatory() Returns true if getAssignmentStatus()==MANDATORY
boolean	isTimeFormat() Returns true IF the Id = TIME_FORMAT

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

getConceptRef, getId, getRepresentation, hasCodedRepresentation

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

asReference, equals, getAllTextTypes, getFullIdPath, getUri, getUrn, hashCode, toString

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

getAnnotations, getAnnotationsByTitle, getAnnotationsByType, hasAnnotationType

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

getIdentifiableComposites, getIdentifiableParent, getMaintainableParent, getParent, getStructureType

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

getComposites, getComposites, getCrossReferences, getParent

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getConceptRef, getRepresentation, hasCodedRepresentation

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

asReference, getAllTextTypes, getFullIdPath, getId, getUri, getUrn

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

getAnnotations, getAnnotationsByTitle, getAnnotationsByType, hasAnnotationType

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

getIdentifiableComposites, getIdentifiableParent, getMaintainableParent, getParent

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

getComposites, getComposites, getCrossReferences, getParent, getStructureType

Constructor Detail

AttributeBeanImpl

public AttributeBeanImpl(AttributeMutableBean attribute,
                 AttributeListBean parent)

AttributeBeanImpl

public AttributeBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.structure.AttributeType attribute,
                 AttributeListBean parent)

AttributeBeanImpl

public AttributeBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.structure.AttributeType attribute,
                 AttributeListBean parent)

AttributeBeanImpl

public AttributeBeanImpl(org.sdmx.resources.sdmxml.schemas.v10.xmlbeans.structure.AttributeType attribute,
                 AttributeListBean parent)

Method Detail

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:

getAttachmentGroup

public java.lang.String getAttachmentGroup()

Description copied from interface: AttributeBean

If ATTRIBUTE_ATTACHMENT_LEVEL is GROUP then returns a reference to the Group id that this attribute is attached to. Returns null if ATTRIBUTE_ATTACHMENT_LEVEL is not GROUP

Specified by:

getAttachmentGroup in interface AttributeBean

Returns:

getConceptRoles

public java.util.List<CrossReferenceBean> getConceptRoles()

Description copied from interface: AttributeBean

Returns a list of cross references to concepts that are used to define the role(s) of this attribute. The returned list is a copy of the underlying list

Returns an empty list if this attribute does not reference any concept roles

Specified by:

getConceptRoles in interface AttributeBean

Returns:

isTimeFormat

public boolean isTimeFormat()

Description copied from interface: AttributeBean

Returns true IF the Id = TIME_FORMAT

Specified by:

isTimeFormat in interface AttributeBean

Returns:

getAttachmentLevel

public ATTRIBUTE_ATTACHMENT_LEVEL getAttachmentLevel()

Description copied from interface: AttributeBean

Returns the ATTRIBUTE_ATTACHMENT_LEVEL attribute indicating the level to which the attribute is attached in time-series formats (generic, compact, utility data formats). Attributes with an attachment level of Group are only available if the data is organised in groups, and should be used appropriately, as the values may not be communicated if the data is not grouped.

Specified by:

getAttachmentLevel in interface AttributeBean

Returns:

getAssignmentStatus

public java.lang.String getAssignmentStatus()

Description copied from interface: AttributeBean

The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data.

Specified by:

getAssignmentStatus in interface AttributeBean

Returns:

getDimensionReferences

public java.util.List<java.lang.String> getDimensionReferences()

Description copied from interface: AttributeBean

Returns the list of dimension ids that this attribute references, this is only relevant if ATTRIBUTE_ATTACHMENT_LEVEL is DIMENSION_GROUP. The returned list is a copy of the underlying list

Returns an empty list if this attribute does not reference any dimensions

Specified by:

getDimensionReferences in interface AttributeBean

Returns:

getPrimaryMeasureReference

public java.lang.String getPrimaryMeasureReference()

Description copied from interface: AttributeBean

If ATTRIBUTE_ATTACHMENT_LEVEL is OBSERVATION then returns a reference to the Primary Measure id that this attribute is attached to. Returns null if ATTRIBUTE_ATTACHMENT_LEVEL is not GROUP

Specified by:

getPrimaryMeasureReference in interface AttributeBean

Returns:

isMandatory

public boolean isMandatory()

Description copied from interface: AttributeBean

Returns true if getAssignmentStatus()==MANDATORY

Specified by:

isMandatory in interface AttributeBean

Returns: