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

Interface DataStructureSuperBean

All Superinterfaces:

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

All Known Implementing Classes:

DataStructureSuperBeanImpl

public interface DataStructureSuperBean
extends MaintainableSuperBean

A DataStructure identifies the dimensionality of a dataset in terms of the codelists and concepts used. It also specifies the attributes, measures and groups that can be used in the dataset.

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 componentId) Returns a referenced codelist from a component with the given id.
ComponentSuperBean	getComponentById(java.lang.String componentId) Returns a component from an id.
java.util.Set<ComponentSuperBean>	getComponents() Returns a set of all the components used within this DataStructure.
java.util.List<AttributeSuperBean>	getDatasetAttributes() Returns a subset of the key family attributes.
DimensionSuperBean	getDimensionById(java.lang.String dimensionId) 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... include) 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 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

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

getCompositeBeans

Method Detail

getBuiltFrom

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

Returns:

getComponents

java.util.Set<ComponentSuperBean> getComponents()

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

Returns:

getReferencedConcepts

java.util.Set<ConceptSuperBean> getReferencedConcepts()

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

Returns:

getReferencedCodelists

java.util.Set<CodelistSuperBean> getReferencedCodelists()

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

Returns:

getGroup

GroupSuperBean getGroup(java.lang.String id)

Returns the group with the given id.

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

Parameters:

id -

Returns:

GroupSuperBean

getGroups

java.util.List<GroupSuperBean> getGroups()

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

Returns:

GroupSuperBean

getDimensions

java.util.List<DimensionSuperBean> getDimensions()

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.

Returns:

DimensionSuperBean

getDimensions

java.util.List<DimensionSuperBean> getDimensions(SDMX_STRUCTURE_TYPE... include)

Returns the list of dimensions that belong to this DataStructure.

Parameters:

include - 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:

getTimeDimension

DimensionSuperBean getTimeDimension()

Returns the time dimension from this DataStructure.

Returns:

The time dimension bean

getDimensionById

DimensionSuperBean getDimensionById(java.lang.String dimensionId)

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

Parameters:

dimensionId - the id that the dimension has reference to

Returns:

the dimension which references the specified id.

getComponentById

ComponentSuperBean getComponentById(java.lang.String componentId)

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

Parameters:

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

Returns:

the component which references the specified id.

getCodelistByComponentId

CodelistSuperBean getCodelistByComponentId(java.lang.String componentId)

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.

Parameters:

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

Returns:

the codelist referred to by the component id.

getPrimaryMeasure

PrimaryMeasureSuperBean getPrimaryMeasure()

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

Returns:

list of PrimaryMeasureSuperBean

getAttributes

java.util.List<AttributeSuperBean> getAttributes()

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

Returns:

list of attributes

getDatasetAttributes

java.util.List<AttributeSuperBean> getDatasetAttributes()

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.

Returns:

list of attributes

getGroupAttributes

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

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.

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:

Throws:

java.lang.IllegalArgumentException - if the groupId does not match any groups for this Data Structure

getGroupAttributes

java.util.Set<AttributeSuperBean> getGroupAttributes()

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.

Returns:

list of attributes

getSeriesAttributes

java.util.List<AttributeSuperBean> getSeriesAttributes()

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

Returns:

list of attributes

getObservationAttributes

java.util.List<AttributeSuperBean> getObservationAttributes()

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.

Returns:

list of attributes

getAttributeAttachmentGroup

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

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

Parameters:

id - id of the attribute

Returns:

the attachment group

getGroupId

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

Returns the group identifier that matches the dimensions set supplied .

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