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

Interface GroupBean

All Superinterfaces:

AnnotableBean, IdentifiableBean, SDMXBean, SdmxStructureBean, java.io.Serializable

All Known Implementing Classes:

GroupBeanImpl

public interface GroupBean
extends IdentifiableBean

A Group is responsible for grouping a subset of the Dimensions in a Data Structure and giving the group an id.

A group then contains its own unique id, which can then be referenced when reporting metadata attributes.

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
CrossReferenceBean	getAttachmentConstraintRef() Returns a reference to an attachment constraint which defines the cube to which the metadata can be attached.
java.util.List<java.lang.String>	getDimensionRefs() Returns the list of dimensions that this group is referencing - the list is in the order that the dimensions appear in the KeyFamilyBean.

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

Method Detail

getDimensionRefs

java.util.List<java.lang.String> getDimensionRefs()

Returns the list of dimensions that this group is referencing - the list is in the order that the dimensions appear in the KeyFamilyBean. The list is mutually exclusive with getAttachmentConstraintRef(), and will have a size of 1 or more only if getAttachmentConstraintRef() is null. If getAttachmentConstraintRef() is not null then this method will return an empty list.

NOTE: The list is a copy so modifying the returned set will not be reflected in the GroupBean instance.

Returns:

getAttachmentConstraintRef

CrossReferenceBean getAttachmentConstraintRef()

Returns a reference to an attachment constraint which defines the cube to which the metadata can be attached.

Returns: