GroupType (sdmx-model-2_0 1.0.0-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sdmx.resources.sdmxml.schemas.v2_0.structure
Class GroupType

java.lang.Object
  org.sdmx.resources.sdmxml.schemas.v2_0.structure.GroupType

public class GroupType
extends Object
extends Object

GroupType declares any useful groupings of data, based on a selection of the declared (non-Time) dimensions (indicated with the DimensionRef element) which form partial keys to which attributes may be attached. The value of the DimensionRef element is the concept of the dimension - that is, the value of the dimension's concept attribute. Thus, if data is to be presented as a set of time series which vary only according to their differing frequencies, a "sibling group" would be declared, with all dimensions except the frequency dimension in it. If data is commonly grouped as a set of all countries, then a "Country Group" could be declared, with all dimensions except the country dimension forming part of the partial key. Any dimension which is not part of a group has a value which varies at the series level (for time series formats). There is no requirement to have only a single dimension ommitted from a partial key - it can be any subset of the set of ordered dimensions (that is, all dimensions except the time dimension, which may never be declared as belonging to a group partial key). All groups declared in the key family must be unique - that is, you may not have duplicate partial keys. All groups must also be given unique names (id attributes). Although it is conventional to declare dimensions in the same order as they are declared in the ordered key, there is no requirement to do so - the ordering of the values of the key are taken from the order in which the dimensions are declared. The Description element provides a human-readable description (potentially in multiple, parallel languages) of the group. Note that for cross-sectional formats, the named group mechanism is not used, but is instead replaced by a generic group which carries time and frequency values with it, and allows for any available group-level attributes to be specified if desired.

Java class for GroupType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="GroupType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <element name="DimensionRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" maxOccurs="unbounded"/>
           <element name="AttachmentConstraintRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType"/>
         </choice>
         <element name="Description" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TextType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Annotations" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}AnnotationsType" minOccurs="0"/>
       </sequence>
       <attribute name="id" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary
`protected AnnotationsType`	`annotations`
`protected String`	`attachmentConstraintRef`
`protected List<TextType>`	`description`
`protected List<String>`	`dimensionRef`
`protected String`	`id`

Constructor Summary
`GroupType()`

Method Summary
`AnnotationsType`	`getAnnotations()` Gets the value of the annotations property.
`String`	`getAttachmentConstraintRef()` Gets the value of the attachmentConstraintRef property.
`List<TextType>`	`getDescription()` Gets the value of the description property.
`List<String>`	`getDimensionRef()` Gets the value of the dimensionRef property.
`String`	`getId()` Gets the value of the id property.
`void`	`setAnnotations(AnnotationsType value)` Sets the value of the annotations property.
`void`	`setAttachmentConstraintRef(String value)` Sets the value of the attachmentConstraintRef property.
`void`	`setId(String value)` Sets the value of the id property.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

dimensionRef

protected List<String> dimensionRef

attachmentConstraintRef

protected String attachmentConstraintRef

description

protected List<TextType> description

annotations

protected AnnotationsType annotations

id

protected String id

Constructor Detail

GroupType

public GroupType()

Method Detail

getDimensionRef

public List<String> getDimensionRef()

Gets the value of the dimensionRef property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the dimensionRef property.

For example, to add a new item, do as follows:

    getDimensionRef().add(newItem);

Objects of the following type(s) are allowed in the list String

getAttachmentConstraintRef

public String getAttachmentConstraintRef()

Gets the value of the attachmentConstraintRef property.

Returns:: possible object is String

setAttachmentConstraintRef

public void setAttachmentConstraintRef(String value)

Sets the value of the attachmentConstraintRef property.

Parameters:: value - allowed object is String

getDescription

public List<TextType> getDescription()

Gets the value of the description property.