org.sdmxsource.sdmx.api.model.superbeans.datastructure

Interface AttributeSuperBean

All Superinterfaces:

AnnotableSuperBean, ComponentSuperBean, IdentifiableSuperBean, java.io.Serializable, SuperBean

All Known Implementing Classes:

AttributeSuperBeanImpl

public interface AttributeSuperBean
extends ComponentSuperBean

An Attribute is a item of information used to add additional metadata to a key or observation or group.

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
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()
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).
AttributeBean	getBuiltFrom() Returns the bean that was used to build this superBean
java.util.List<java.lang.String>	getDimensionReferences()
java.lang.String	getPrimaryMeasureReference()
boolean	isMandatory() Returns true if getAssignmentStatus()==MANDATORY

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

getCodelist, getConcept, getTextFormat

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

getId, getUrn

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

getAnnotationByTitle, getAnnotationByType, getAnnotationByUrl, getAnnotations, hasAnnotations

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

getCompositeBeans

Method Detail

getDimensionReferences

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

getAttachmentGroup

java.lang.String getAttachmentGroup()

getPrimaryMeasureReference

java.lang.String getPrimaryMeasureReference()

getAttachmentLevel

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). 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.

Returns:

getAssignmentStatus

java.lang.String getAssignmentStatus()

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

Returns:

isMandatory

boolean isMandatory()

Returns true if getAssignmentStatus()==MANDATORY

Returns:

getBuiltFrom

AttributeBean getBuiltFrom()

Description copied from interface: SuperBean

Returns the bean that was used to build this superBean

Specified by:

getBuiltFrom in interface ComponentSuperBean

Specified by:

getBuiltFrom in interface SuperBean

Returns: