org.sdmxsource.sdmx.sdmxbeans.model.superbeans.datastructure

Class DataStructureSuperBeanImpl

java.lang.Object

org.sdmxsource.sdmx.sdmxbeans.model.superbeans.base.SuperBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.superbeans.base.AnnotableSuperBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.superbeans.base.IdentifiableSuperBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.superbeans.base.NameableSuperBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.superbeans.base.MaintainableSuperBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.superbeans.datastructure.DataStructureSuperBeanImpl

All Implemented Interfaces:

java.io.Serializable, AnnotableSuperBean, IdentifiableSuperBean, MaintainableSuperBean, NameableSuperBean, SuperBean, DataStructureSuperBean

public class DataStructureSuperBeanImpl
extends MaintainableSuperBeanImpl
implements DataStructureSuperBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataStructureSuperBeanImpl(DataStructureBean dataStructure, java.util.List<DimensionSuperBean> dimensions, java.util.List<AttributeSuperBean> attributes, PrimaryMeasureSuperBean primaryMeasure)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAttributeAttachmentGroup(java.lang.String id) Returns the attribute attachment group for the specified attribute.
java.util.List<AttributeSuperBean>	getAttributes() Returns a list of all the attributes in this DataStructure.
DataStructureBean	getBuiltFrom() Returns the bean that was used to build this superBean
CodelistSuperBean	getCodelistByComponentId(java.lang.String conceptId) Returns a referenced codelist from a component with the given id.
ComponentSuperBean	getComponentById(java.lang.String conceptId) Returns a component from an id.
java.util.Set<ComponentSuperBean>	getComponents() Returns a set of all the components used within this DataStructure.
java.util.Set<MaintainableBean>	getCompositeBeans() Returns a set of beans that were used to build this superBean
java.util.List<AttributeSuperBean>	getDatasetAttributes() Returns a subset of the key family attributes.
DimensionSuperBean	getDimensionById(java.lang.String conceptId) Returns a dimension, that is referenced by the specified id.
java.util.List<DimensionSuperBean>	getDimensions() Returns a list of all the dimensions in the DataStructure.
java.util.List<DimensionSuperBean>	getDimensions(SDMX_STRUCTURE_TYPE... includeTypes) Returns the list of dimensions that belong to this DataStructure.
GroupSuperBean	getGroup(java.lang.String id) Returns the group with the given id.
java.util.Set<AttributeSuperBean>	getGroupAttributes() Returns a set of all the attributes attached to any group in the DataStructure.
java.util.List<AttributeSuperBean>	getGroupAttributes(java.lang.String groupId, boolean includeDimensionGroups) Returns a subset of the DataStructure attributes.
java.lang.String	getGroupId(java.util.Set<java.lang.String> dimensions) Returns the group identifier that matches the dimensions set supplied .
java.util.List<GroupSuperBean>	getGroups() Returns all the groups in the DataStructure.
java.util.List<AttributeSuperBean>	getObservationAttributes() Returns a subset of the DataStructure attributes.
PrimaryMeasureSuperBean	getPrimaryMeasure() Returns the primary measure for this DataStructure.
java.util.Set<CodelistSuperBean>	getReferencedCodelists() Returns a set of all the codelists referenced within this DataStructure.
java.util.Set<ConceptSuperBean>	getReferencedConcepts() Returns a set of all the concepts referenced within this DataStructure.
java.util.List<AttributeSuperBean>	getSeriesAttributes() Returns a subset of the DataStructure attributes.
DimensionSuperBean	getTimeDimension() Returns the time dimension from this DataStructure.

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.superbeans.base.MaintainableSuperBeanImpl

getAgencyId, getVersion, isFinal

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.superbeans.base.NameableSuperBeanImpl

getDescription, getDescription, getDescriptions, getName, getName, getNames

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.superbeans.base.IdentifiableSuperBeanImpl

equals, getId, getUrn, hashCode, toString

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.superbeans.base.AnnotableSuperBeanImpl

getAnnotationByTitle, getAnnotationByType, getAnnotationByUrl, getAnnotations, hasAnnotations

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getAgencyId, getVersion, isFinal

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

getDescription, getDescription, getDescriptions, getName, getName, getNames

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

Constructor Detail

DataStructureSuperBeanImpl

public DataStructureSuperBeanImpl(DataStructureBean dataStructure,
                          java.util.List<DimensionSuperBean> dimensions,
                          java.util.List<AttributeSuperBean> attributes,
                          PrimaryMeasureSuperBean primaryMeasure)

Method Detail

getBuiltFrom

public DataStructureBean getBuiltFrom()

Description copied from interface: SuperBean

Returns the bean that was used to build this superBean

Specified by:

getBuiltFrom in interface MaintainableSuperBean

Specified by:

getBuiltFrom in interface SuperBean

Specified by:

getBuiltFrom in interface DataStructureSuperBean

Overrides:

getBuiltFrom in class MaintainableSuperBeanImpl

Returns:

getReferencedCodelists

public java.util.Set<CodelistSuperBean> getReferencedCodelists()

Description copied from interface: DataStructureSuperBean

Returns a set of all the codelists referenced within this DataStructure.

Specified by:

getReferencedCodelists in interface DataStructureSuperBean

Returns:

getComponents

public java.util.Set<ComponentSuperBean> getComponents()

Description copied from interface: DataStructureSuperBean

Returns a set of all the components used within this DataStructure.

Specified by:

getComponents in interface DataStructureSuperBean

Returns:

getReferencedConcepts

public java.util.Set<ConceptSuperBean> getReferencedConcepts()

Description copied from interface: DataStructureSuperBean

Returns a set of all the concepts referenced within this DataStructure.

Specified by:

getReferencedConcepts in interface DataStructureSuperBean

Returns:

getCodelistByComponentId

public CodelistSuperBean getCodelistByComponentId(java.lang.String conceptId)

Description copied from interface: DataStructureSuperBean

Returns a referenced codelist from a component with the given id. If there are no components in the key family that have reference to the given concept id or if the referenced component is uncoded then null will be returned.

Specified by:

getCodelistByComponentId in interface DataStructureSuperBean

Parameters:

conceptId - the id by which to refer to the codelist.

Returns:

the codelist referred to by the component id.

getComponentById

public ComponentSuperBean getComponentById(java.lang.String conceptId)

Description copied from interface: DataStructureSuperBean

Returns a component from an id. If no such concept exists, null will be returned.

Specified by:

getComponentById in interface DataStructureSuperBean

Parameters:

conceptId - the id by which to refer to the component.

Returns:

the component which references the specified id.

getTimeDimension

public DimensionSuperBean getTimeDimension()

Description copied from interface: DataStructureSuperBean

Returns the time dimension from this DataStructure.

Specified by:

getTimeDimension in interface DataStructureSuperBean

Returns:

The time dimension bean

getDimensionById

public DimensionSuperBean getDimensionById(java.lang.String conceptId)

Description copied from interface: DataStructureSuperBean

Returns a dimension, that is referenced by the specified id. If no such dimension exists for this DataStructure then null will be returned.

Specified by:

getDimensionById in interface DataStructureSuperBean

Parameters:

conceptId - the id that the dimension has reference to

Returns:

the dimension which references the specified id.

getDimensions

public java.util.List<DimensionSuperBean> getDimensions()

Description copied from interface: DataStructureSuperBean

Returns a list of all the dimensions in the DataStructure. This does not include the primary measure dimension. If there are no dimensions then an empty list will be returned.

Specified by:

getDimensions in interface DataStructureSuperBean

Returns:

DimensionSuperBean

getDimensions

public java.util.List<DimensionSuperBean> getDimensions(SDMX_STRUCTURE_TYPE... includeTypes)

Description copied from interface: DataStructureSuperBean

Returns the list of dimensions that belong to this DataStructure.

Specified by:

getDimensions in interface DataStructureSuperBean

Parameters:

includeTypes - an optional parameter of dimension types to include, types not specified will be excluded - the list must be from one of the following:

• DIMENSION - referring to a normal dimension, not measure or time
• MEASURE_DIMENSION
• TIME_DIMENSION

Returns:

getAttributes

public java.util.List<AttributeSuperBean> getAttributes()

Description copied from interface: DataStructureSuperBean

Returns a list of all the attributes in this DataStructure. If there are no attributes then an empty list will be returned.

Specified by:

getAttributes in interface DataStructureSuperBean

Returns:

list of attributes

getPrimaryMeasure

public PrimaryMeasureSuperBean getPrimaryMeasure()

Description copied from interface: DataStructureSuperBean

Returns the primary measure for this DataStructure. If there is no primary measure then null will be returned.

Specified by:

getPrimaryMeasure in interface DataStructureSuperBean

Returns:

list of PrimaryMeasureSuperBean

getDatasetAttributes

public java.util.List<AttributeSuperBean> getDatasetAttributes()

Description copied from interface: DataStructureSuperBean

Returns a subset of the key family attributes. Returns the attributes with Attachment Level of DataSet. If no such attributes exist then an empty list will be returned.

Specified by:

getDatasetAttributes in interface DataStructureSuperBean

Returns:

list of attributes

getGroupAttributes

public java.util.Set<AttributeSuperBean> getGroupAttributes()

Description copied from interface: DataStructureSuperBean

Returns a set of all the attributes attached to any group in the DataStructure. If no such attributes exist then an empty list will be returned.

Specified by:

getGroupAttributes in interface DataStructureSuperBean

Returns:

list of attributes

getGroupAttributes

public java.util.List<AttributeSuperBean> getGroupAttributes(java.lang.String groupId,
                                                    boolean includeDimensionGroups)

Description copied from interface: DataStructureSuperBean

Returns a subset of the DataStructure attributes. Returns the attributes with Attachment Level of Group, where the group id is the id given. If no such attributes exist then an empty list will be returned.

Specified by:

getGroupAttributes in interface DataStructureSuperBean

Parameters:

groupId - the group id of the group to return the attributes for

includeDimensionGroups - if true, this will include attributes which are attached to a dimension group, which group the same dimensions as the group with the given id

Returns:

getGroups

public java.util.List<GroupSuperBean> getGroups()

Description copied from interface: DataStructureSuperBean

Returns all the groups in the DataStructure. If there are no groups an empty list will be returned.

Specified by:

getGroups in interface DataStructureSuperBean

Returns:

GroupSuperBean

getGroup

public GroupSuperBean getGroup(java.lang.String id)

Description copied from interface: DataStructureSuperBean

Returns the group with the given id.

If no groups exist or no groups have the id, then null will be returned.

Specified by:

getGroup in interface DataStructureSuperBean

Returns:

GroupSuperBean

getObservationAttributes

public java.util.List<AttributeSuperBean> getObservationAttributes()

Description copied from interface: DataStructureSuperBean

Returns a subset of the DataStructure attributes. Returns the attributes with Attachment Level of Observation. If no such attributes exist then an empty list will be returned.

Specified by:

getObservationAttributes in interface DataStructureSuperBean

Returns:

list of attributes

getSeriesAttributes

public java.util.List<AttributeSuperBean> getSeriesAttributes()

Description copied from interface: DataStructureSuperBean

Returns a subset of the DataStructure attributes. Returns the attributes with Attachment Level of Series.

Specified by:

getSeriesAttributes in interface DataStructureSuperBean

Returns:

list of attributes

getAttributeAttachmentGroup

public java.lang.String getAttributeAttachmentGroup(java.lang.String id)

Description copied from interface: DataStructureSuperBean

Returns the attribute attachment group for the specified attribute. a list of group identifiers, to which a group level attribute attaches.

Specified by:

getAttributeAttachmentGroup in interface DataStructureSuperBean

Parameters:

id - id of the attribute

Returns:

the attachment group

getCompositeBeans

public java.util.Set<MaintainableBean> getCompositeBeans()

Description copied from interface: SuperBean

Returns a set of beans that were used to build this superBean

Specified by:

getCompositeBeans in interface SuperBean

Overrides:

getCompositeBeans in class SuperBeanImpl

Returns:

getGroupId

public java.lang.String getGroupId(java.util.Set<java.lang.String> dimensions)

Description copied from interface: DataStructureSuperBean

Returns the group identifier that matches the dimensions set supplied .

Specified by:

getGroupId in interface DataStructureSuperBean

Parameters:

dimensions - a set containing the complete collection of dimensions to be matched with a group

Returns:

the identification of the group which has the same dimensions as the supplied set