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

Interface CrossSectionalDataStructureBean

All Superinterfaces:

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

All Known Implementing Classes:

CrossSectionalDataStructureBeanImpl

public interface CrossSectionalDataStructureBean
extends DataStructureBean

A Cross Sectional Data Structure extends DataStructure by adding cross sectional information as it was modelled in SDMX Version 2.0

Author:

Matt Nelson

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
java.util.List<CrossSectionalMeasureBean>	getAttachmentMeasures(AttributeBean attribute) Get the cross sectional measures that the attribute is linked to, returns an empty list if there is no cross sectional measures defined by the attribute.
CrossReferenceBean	getCodelistForMeasureDimension(java.lang.String dimensionId) Returns the codelist reference for the dimension with the given id
java.util.List<ComponentBean>	getCrossSectionalAttachDataSet(boolean returnOnlyIfLowestLevel, SDMX_STRUCTURE_TYPE... returnTypes) Returns a list of components that are cross sectional attach dataset.
java.util.List<ComponentBean>	getCrossSectionalAttachGroup(boolean returnOnlyIfLowestLevel, SDMX_STRUCTURE_TYPE... returnTypes) Returns a list of components that are cross sectional attach group.
java.util.List<ComponentBean>	getCrossSectionalAttachObservation(SDMX_STRUCTURE_TYPE... returnTypes) Returns a list of components that are cross sectional attach group.
java.util.List<ComponentBean>	getCrossSectionalAttachSection(boolean returnOnlyIfLowestLevel, SDMX_STRUCTURE_TYPE... returnTypes) Returns a list of components that are cross sectional attach section.
CrossSectionalMeasureBean	getCrossSectionalMeasure(java.lang.String id) Returns the cross sectional measure with the given id.
java.util.List<CrossSectionalMeasureBean>	getCrossSectionalMeasures() Returns a list of the cross sectional measures
CrossSectionalDataStructureMutableBean	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.
boolean	isMeasureDimension(DimensionBean dim) Returns true if the given dimension is to be treated as the measure dimension

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.datastructure.DataStructureBean

getAttribute, getAttributeList, getAttributes, getComponent, getComponents, getDatasetAttributes, getDimension, getDimensionGroupAttribute, getDimensionGroupAttributes, getDimensionList, getDimensions, getFrequencyDimension, getGroup, getGroupAttribute, getGroupAttributes, getGroupAttributes, getGroups, getMeasureList, getObservationAttribute, getObservationAttributes, getObservationAttributes, getPrimaryMeasure, getSeriesAttributes, getStub, getTimeDimension, hasFrequencyDimension, isCompatible

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

getCrossSectionalMeasure

CrossSectionalMeasureBean getCrossSectionalMeasure(java.lang.String id)

Returns the cross sectional measure with the given id.

Returns null if no measure is found with the id.

Parameters:

id -

Returns:

isMeasureDimension

boolean isMeasureDimension(DimensionBean dim)

Returns true if the given dimension is to be treated as the measure dimension

Parameters:

dim -

Returns:

getCrossSectionalMeasures

java.util.List<CrossSectionalMeasureBean> getCrossSectionalMeasures()

Returns a list of the cross sectional measures

Returns:

getCodelistForMeasureDimension

CrossReferenceBean getCodelistForMeasureDimension(java.lang.String dimensionId)

Returns the codelist reference for the dimension with the given id

Parameters:

dimensionId -

Returns:

getCrossSectionalAttachDataSet

java.util.List<ComponentBean> getCrossSectionalAttachDataSet(boolean returnOnlyIfLowestLevel,
                                                           SDMX_STRUCTURE_TYPE... returnTypes)

Returns a list of components that are cross sectional attach dataset.

Returns an empty list if no dimensions's are marked as cross sectional attach dataset.

Parameters:

returnOnlyIfLowestLevel - if true only return the components that do not have an attachment to a lower level (i.e observation)

returnTypes - optional filter on return types example SDMX_STRUCTURE_TYPE.DIMENSION, SDMX_STRUCTURE_TYPE.DATA_ATTRIBUTE, SDMX_STRUCTURE_TYPE.GROUP, SDMX_STRUCTURE_TYPE.TIME_DIMENSION)

Returns:

getCrossSectionalAttachGroup

java.util.List<ComponentBean> getCrossSectionalAttachGroup(boolean returnOnlyIfLowestLevel,
                                                         SDMX_STRUCTURE_TYPE... returnTypes)

Returns a list of components that are cross sectional attach group.

Returns an empty list if no dimensions's are marked as cross sectional attach group.

Parameters:

returnOnlyIfLowestLevel - if true only return the components that do not have an attachment to a lower level (i.e observation)

returnTypes - optional filter on return types example SDMX_STRUCTURE_TYPE.DIMENSION, SDMX_STRUCTURE_TYPE.DATA_ATTRIBUTE, SDMX_STRUCTURE_TYPE.GROUP, SDMX_STRUCTURE_TYPE.TIME_DIMENSION)

Returns:

getCrossSectionalAttachSection

java.util.List<ComponentBean> getCrossSectionalAttachSection(boolean returnOnlyIfLowestLevel,
                                                           SDMX_STRUCTURE_TYPE... returnTypes)

Returns a list of components that are cross sectional attach section.

Returns an empty list if no dimensions's are marked as cross sectional attach section.

Parameters:

returnOnlyIfLowestLevel - if true only return the components that do not have an attachment to a lower level (i.e observation)

returnTypes - optional filter on return types example SDMX_STRUCTURE_TYPE.DIMENSION, SDMX_STRUCTURE_TYPE.DATA_ATTRIBUTE, SDMX_STRUCTURE_TYPE.GROUP, SDMX_STRUCTURE_TYPE.TIME_DIMENSION)

Returns:

getCrossSectionalAttachObservation

java.util.List<ComponentBean> getCrossSectionalAttachObservation(SDMX_STRUCTURE_TYPE... returnTypes)

Returns a list of components that are cross sectional attach group.

Returns an empty list if no dimensions's are marked as cross sectional attach group.

Parameters:

returnTypes - optional filter on return types example SDMX_STRUCTURE_TYPE.DIMENSION, SDMX_STRUCTURE_TYPE.DATA_ATTRIBUTE, SDMX_STRUCTURE_TYPE.GROUP, SDMX_STRUCTURE_TYPE.TIME_DIMENSION)

Returns:

getAttachmentMeasures

java.util.List<CrossSectionalMeasureBean> getAttachmentMeasures(AttributeBean attribute)

Get the cross sectional measures that the attribute is linked to, returns an empty list if there is no cross sectional measures defined by the attribute.

Parameters:

attribute -

Returns:

getMutableInstance

CrossSectionalDataStructureMutableBean 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 DataStructureBean

Specified by:

getMutableInstance in interface MaintainableBean

Returns: