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

Class DataStructureBeanImpl

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CrossSectionalDataStructureBeanImpl

public class DataStructureBeanImpl
extends MaintainableBeanImpl
implements DataStructureBean

See Also:

Serialized Form

Field Summary

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

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
DataStructureBeanImpl(DataStructureMutableBean bean)
DataStructureBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.structure.DataStructureType bean)
DataStructureBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.structure.KeyFamilyType bean)
DataStructureBeanImpl(org.sdmx.resources.sdmxml.schemas.v10.xmlbeans.structure.KeyFamilyType bean)

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.
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 conceptId) 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<CrossReferenceBean>	getCrossReferencedConstrainables() Returns a reference to any referenced structures that can also be constrained, examples are: Registration would return reference to a provision agreement Provision Agreement would return a reference to a dataflow and a Data Provider Dataflow would return a reference to a data structure Data Structure would return null (example a provision agreement would return a reference to a dataflow)
java.util.List<AttributeBean>	getDatasetAttributes() Returns a subset of the DataStructure's attributes.
DimensionBean	getDimension(java.lang.String conceptId) Returns the dimension with the given Id.
AttributeBean	getDimensionGroupAttribute(java.lang.String conceptId) 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... includeTypes) 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 conceptId) 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 conceptId) 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 class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.MaintainableBeanImpl

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

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

getAllTextTypes, getDescription, getDescriptions, getName, getNames

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

asReference, equals, getFullIdPath, getId, 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.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

getComposites, getComposites, getCrossReferences, getParent, getStructureType

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

DataStructureBeanImpl

public DataStructureBeanImpl(DataStructureMutableBean bean)

DataStructureBeanImpl

public DataStructureBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.structure.DataStructureType bean)

DataStructureBeanImpl

public DataStructureBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.structure.KeyFamilyType bean)

DataStructureBeanImpl

public DataStructureBeanImpl(org.sdmx.resources.sdmxml.schemas.v10.xmlbeans.structure.KeyFamilyType bean)

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:

isCompatible

public boolean isCompatible(SDMX_SCHEMA schemaVersion)

Description copied from interface: DataStructureBean

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 ?

Specified by:

isCompatible in interface DataStructureBean

Returns:

getStub

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

Description copied from interface: DataStructureBean

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

Specified by:

getStub in interface DataStructureBean

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:

getCrossReferencedConstrainables

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

Description copied from interface: ConstrainableBean

Returns a reference to any referenced structures that can also be constrained, examples are:

• Registration would return reference to a provision agreement
• Provision Agreement would return a reference to a dataflow and a Data Provider
• Dataflow would return a reference to a data structure
• Data Structure would return null
(example a provision agreement would return a reference to a dataflow)

Specified by:

getCrossReferencedConstrainables in interface ConstrainableBean

Returns:

getMutableInstance

public DataStructureMutableBean getMutableInstance()

Description copied from interface: DataStructureBean

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

Specified by:

getMutableInstance in interface DataStructureBean

Returns:

getDimensionList

public DimensionListBean getDimensionList()

Description copied from interface: DataStructureBean

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

Specified by:

getDimensionList in interface DataStructureBean

Returns:

getAttributeList

public AttributeListBean getAttributeList()

Description copied from interface: DataStructureBean

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

Specified by:

getAttributeList in interface DataStructureBean

Returns:

getMeasureList

public MeasureListBean getMeasureList()

Description copied from interface: DataStructureBean

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

Specified by:

getMeasureList in interface DataStructureBean

Returns:

getComponents

public java.util.List<ComponentBean> getComponents()

Description copied from interface: DataStructureBean

Returns a list of all components that belong to this DSD

Specified by:

getComponents in interface DataStructureBean

Returns:

getAttribute

public AttributeBean getAttribute(java.lang.String id)

Description copied from interface: DataStructureBean

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

Specified by:

getAttribute in interface DataStructureBean

Returns:

getSeriesAttributes

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

Description copied from interface: DataStructureBean

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.

Specified by:

getSeriesAttributes in interface DataStructureBean

Returns:

getObservationAttributes

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

Description copied from interface: DataStructureBean

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.

Specified by:

getObservationAttributes in interface DataStructureBean

Returns:

getDimensions

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

Description copied from interface: DataStructureBean

Returns the list of dimensions that belong to this DataStructure.

Specified by:

getDimensions in interface DataStructureBean

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:

getDimension

public DimensionBean getDimension(java.lang.String conceptId)

Description copied from interface: DataStructureBean

Returns the dimension with the given Id.

Specified by:

getDimension in interface DataStructureBean

Returns:

getFrequencyDimension

public DimensionBean getFrequencyDimension()

Description copied from interface: DataStructureBean

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

Specified by:

getFrequencyDimension in interface DataStructureBean

Returns:

hasFrequencyDimension

public boolean hasFrequencyDimension()

Description copied from interface: DataStructureBean

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

Specified by:

hasFrequencyDimension in interface DataStructureBean

Returns:

getComponent

public ComponentBean getComponent(java.lang.String conceptId)

Description copied from interface: DataStructureBean

Returns the component with the given id.

Specified by:

getComponent in interface DataStructureBean

Returns:

getGroups

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

Description copied from interface: DataStructureBean

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

Specified by:

getGroups in interface DataStructureBean

Returns:

getGroup

public GroupBean getGroup(java.lang.String groupId)

Description copied from interface: DataStructureBean

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.

Specified by:

getGroup in interface DataStructureBean

Returns:

getTimeDimension

public DimensionBean getTimeDimension()

Description copied from interface: DataStructureBean

Gets the time dimension that belongs to this DataStructure.

If there is no time dimension then null is returned

Specified by:

getTimeDimension in interface DataStructureBean

Returns:

getPrimaryMeasure

public PrimaryMeasureBean getPrimaryMeasure()

Description copied from interface: DataStructureBean

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

Specified by:

getPrimaryMeasure in interface DataStructureBean

Returns:

getAttributes

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

Description copied from interface: DataStructureBean

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

Specified by:

getAttributes in interface DataStructureBean

Returns:

getDatasetAttributes

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

Description copied from interface: DataStructureBean

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

Specified by:

getDatasetAttributes in interface DataStructureBean

Returns:

getGroupAttributes

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

Description copied from interface: DataStructureBean

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.

Specified by:

getGroupAttributes in interface DataStructureBean

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:

getGroupAttributes

public java.util.List<AttributeBean> getGroupAttributes()

Description copied from interface: DataStructureBean

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.

Specified by:

getGroupAttributes in interface DataStructureBean

Returns:

getDimensionGroupAttributes

public java.util.List<AttributeBean> getDimensionGroupAttributes()

Description copied from interface: DataStructureBean

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.

Specified by:

getDimensionGroupAttributes in interface DataStructureBean

Returns:

getObservationAttributes

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

Description copied from interface: DataStructureBean

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.

Specified by:

getObservationAttributes in interface DataStructureBean

Returns:

getGroupAttribute

public AttributeBean getGroupAttribute(java.lang.String conceptId)

Description copied from interface: DataStructureBean

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

Specified by:

getGroupAttribute in interface DataStructureBean

Returns:

getDimensionGroupAttribute

public AttributeBean getDimensionGroupAttribute(java.lang.String conceptId)

Description copied from interface: DataStructureBean

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

Specified by:

getDimensionGroupAttribute in interface DataStructureBean

Returns:

getObservationAttribute

public AttributeBean getObservationAttribute(java.lang.String conceptId)

Description copied from interface: DataStructureBean

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

Specified by:

getObservationAttribute in interface DataStructureBean

Returns: