org.sdmxsource.sdmx.api.model.beans.datastructure

Interface DataStructureBean

All Superinterfaces:

AnnotableBean, java.lang.Comparable<MaintainableBean>, ConstrainableBean, IdentifiableBean, MaintainableBean, NameableBean, SDMXBean, SdmxStructureBean, java.io.Serializable

All Known Subinterfaces:

CrossSectionalDataStructureBean

All Known Implementing Classes:

CrossSectionalDataStructureBeanImpl, DataStructureBeanImpl

public interface DataStructureBean
extends MaintainableBean, ConstrainableBean

A Data Structure also known as a Data Structure Definition (DSD) or KeyFamily describes the dimensionality of the data.

A Data Structure contains Dimensions, Attributes, Groups, and a Measure. Each of these components is held in its respective identifiable list container (DimensionList, AttributeList, MeasureList), however the DataStructureBean exposes the methods to obtain the Dimensions, Attributes, Measure, and Groups without having to navigate through the list.

Field Summary

Fields inherited from interface org.sdmxsource.sdmx.api.model.beans.base.MaintainableBean

DEFAULT_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
AttributeBean	getAttribute(java.lang.String id) Returns the attribute with the given id, returns null if no such attribute exists.
AttributeListBean	getAttributeList() Returns the Attribute List.
java.util.List<AttributeBean>	getAttributes() Returns the attributes that belong to this DataStructure.
ComponentBean	getComponent(java.lang.String id) Returns the component with the given id.
java.util.List<ComponentBean>	getComponents() Returns a list of all components that belong to this DSD
java.util.List<AttributeBean>	getDatasetAttributes() Returns a subset of the DataStructure's attributes.
DimensionBean	getDimension(java.lang.String id) Returns the dimension with the given Id.
AttributeBean	getDimensionGroupAttribute(java.lang.String id) Returns the series attribute with the given id, returns null if no such attribute exists.
java.util.List<AttributeBean>	getDimensionGroupAttributes() Returns a subset of the DataStructure's attributes.
DimensionListBean	getDimensionList() Returns the Dimension List.
java.util.List<DimensionBean>	getDimensions(SDMX_STRUCTURE_TYPE... include) Returns the list of dimensions that belong to this DataStructure.
DimensionBean	getFrequencyDimension() Returns the dimension that is playing the role of frequency.
GroupBean	getGroup(java.lang.String groupId) Gets the group with the given id that belongs to this DataStructure.
AttributeBean	getGroupAttribute(java.lang.String id) Returns the group attribute with the given id, returns null if no such attribute exists.
java.util.List<AttributeBean>	getGroupAttributes() Returns a subset of the DataStructure's attributes.
java.util.List<AttributeBean>	getGroupAttributes(java.lang.String groupId, boolean includeDimensionGroups) Returns a subset of the DataStructure's attributes.
java.util.List<GroupBean>	getGroups() Returns the list of groups that belongs to this DataStructure.
MeasureListBean	getMeasureList() Returns the Measure List.
DataStructureMutableBean	getMutableInstance() Returns a representation of itself in a bean which can be modified, modifications to the mutable bean are not reflected in the instance of the MaintainableBean.
AttributeBean	getObservationAttribute(java.lang.String id) Returns the observation attribute with the given id, returns null if no such attribute exists.
java.util.List<AttributeBean>	getObservationAttributes() Returns a subset of the DataStructure's attributes.
java.util.List<AttributeBean>	getObservationAttributes(java.lang.String crossSectionalConcept) Returns a subset of the DataStructure's attributes.
PrimaryMeasureBean	getPrimaryMeasure() Gets the primary measure that belongs to this DataStructure.
java.util.List<AttributeBean>	getSeriesAttributes(java.lang.String crossSectionalConcept) Returns a subset of the DataStructure's attributes.
DataStructureBean	getStub(java.net.URL actualLocation, boolean isServiceUrl) Returns a stub reference of itself.
DimensionBean	getTimeDimension() Gets the time dimension that belongs to this DataStructure.
boolean	hasFrequencyDimension() Returns true if there is a dimension that is playing the role of frequency.
boolean	isCompatible(SDMX_SCHEMA schemaVersion) Returns false if this data structure is not compatible with the target schema version.

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

addAnnotations, getAgencyId, getEndDate, getServiceURL, getStartDate, getStructureURL, getVersion, isExternalReference, isFinal

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

getDescription, getDescriptions, getName, getNames

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

deepEquals, getComposites, getComposites, getCrossReferences, getParent, getStructureType

Methods inherited from interface java.lang.Comparable

compareTo

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

getCrossReferencedConstrainables

Method Detail

isCompatible

boolean isCompatible(SDMX_SCHEMA schemaVersion)

Returns false if this data structure is not compatible with the target schema version.

For SDMX Version 1.0 all dimensions had to be coded.

For SDMX Version 1.0 and 2.0 each components had to reference a concept with a unique id

For EDI ?

Parameters:

schemaVersion -

Returns:

getDimensionList

DimensionListBean getDimensionList()

Returns the Dimension List. The Dimension List is an identifiable container for the DataStructure's dimensions.

Returns:

getAttributeList

AttributeListBean getAttributeList()

Returns the Attribute List. The Attribute List is an identifiable container for the DataStructure's attributes.

Returns:

getMeasureList

MeasureListBean getMeasureList()

Returns the Measure List. The Measure List is an identifiable container for the DataStructure's measure.

Returns:

getDimensions

java.util.List<DimensionBean> 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:

getFrequencyDimension

DimensionBean getFrequencyDimension()

Returns the dimension that is playing the role of frequency. Returns null if no dimension is playing the role of frequency.

Returns:

hasFrequencyDimension

boolean hasFrequencyDimension()

Returns true if there is a dimension that is playing the role of frequency.

Returns:

getDimension

DimensionBean getDimension(java.lang.String id)

Returns the dimension with the given Id.

Parameters:

conceptId -

Returns:

getComponent

ComponentBean getComponent(java.lang.String id)

Returns the component with the given id.

Parameters:

conceptId -

Returns:

getComponents

java.util.List<ComponentBean> getComponents()

Returns a list of all components that belong to this DSD

Returns:

getGroups

java.util.List<GroupBean> getGroups()

Returns the list of groups that belongs to this DataStructure. If there are no groups then an empty list is returned.

Returns:

getGroup

GroupBean getGroup(java.lang.String groupId)

Gets the group with the given id that belongs to this DataStructure.

If there are no groups with the given id then null will be returned.

Parameters:

groupId -

Returns:

getTimeDimension

DimensionBean getTimeDimension()

Gets the time dimension that belongs to this DataStructure.

If there is no time dimension then null is returned

Returns:

getPrimaryMeasure

PrimaryMeasureBean getPrimaryMeasure()

Gets the primary measure that belongs to this DataStructure. A DataStructure must have a primary measure so this method will always return a value.

Returns:

getAttributes

java.util.List<AttributeBean> getAttributes()

Returns the attributes that belong to this DataStructure. If the DataStructure has no attributes then an empty list is returned.

Returns:

getDatasetAttributes

java.util.List<AttributeBean> getDatasetAttributes()

Returns a subset of the DataStructure's attributes. Returns the attributes with Attachment Level of DataSet.

If there are no attributes that match this criteria then an empty list is returned

Returns:

getGroupAttributes

java.util.List<AttributeBean> getGroupAttributes()

Returns a subset of the DataStructure's attributes. Returns the attributes with Attachment Level of Group. If there are no attributes that match this criteria then an empty list is returned.

Returns:

getGroupAttributes

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

Returns a subset of the DataStructure's attributes. Returns the attributes with Attachment Level of Group, that are attached to the group with the given id. If there are no attributes that match this criteria then an empty list is 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

getDimensionGroupAttributes

java.util.List<AttributeBean> getDimensionGroupAttributes()

Returns a subset of the DataStructure's attributes. Returns the attributes with Attachment Level of DimensionGroup. If there are no attributes that match this criteria then an empty list is returned.

Returns:

getSeriesAttributes

java.util.List<AttributeBean> getSeriesAttributes(java.lang.String crossSectionalConcept)

Returns a subset of the DataStructure's attributes. Returns the attributes with Attachment Level of DimensionGroup, where none of the dimensions referenced in the group are the cross sectional attribute. If there are no attributes that match this criteria then an empty list is returned.

Returns:

getObservationAttributes

java.util.List<AttributeBean> getObservationAttributes()

Returns a subset of the DataStructure's attributes. Returns the attributes with Attachment Level of Observation when time is at the observation level. If there are no attributes that match this criteria then an empty list is returned.

Returns:

getObservationAttributes

java.util.List<AttributeBean> getObservationAttributes(java.lang.String crossSectionalConcept)

Returns a subset of the DataStructure's attributes. Returns the attributes with Attachment Level of Observation, or an Attachment level of DimenisonGroup, where one of the dimensions in the group is the one at the cross sectional level. If there are no attributes that match this criteria then an empty list is returned.

Returns:

getAttribute

AttributeBean getAttribute(java.lang.String id)

Returns the attribute with the given id, returns null if no such attribute exists.

Parameters:

id -

Returns:

getGroupAttribute

AttributeBean getGroupAttribute(java.lang.String id)

Returns the group attribute with the given id, returns null if no such attribute exists.

Parameters:

id -

Returns:

getDimensionGroupAttribute

AttributeBean getDimensionGroupAttribute(java.lang.String id)

Returns the series attribute with the given id, returns null if no such attribute exists.

Parameters:

id -

Returns:

getObservationAttribute

AttributeBean getObservationAttribute(java.lang.String id)

Returns the observation attribute with the given id, returns null if no such attribute exists.

Parameters:

id -

Returns:

getStub

DataStructureBean getStub(java.net.URL actualLocation,
                        boolean isServiceUrl)

Returns a stub reference of itself. A stub bean only contains Maintainable and Identifiable Attributes, not the composite Objects that are contained within the Maintainable.

Specified by:

getStub in interface MaintainableBean

Parameters:

actualLocation - the URL indicating where the full structure can be returned from

isServiceUrl - if true this URL will be present on the serviceURL attribute, otherwise it will be treated as a structureURL attribute

Returns:

getMutableInstance

DataStructureMutableBean getMutableInstance()

Returns a representation of itself in a bean which can be modified, modifications to the mutable bean are not reflected in the instance of the MaintainableBean.

Specified by:

getMutableInstance in interface MaintainableBean

Returns: