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

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

public class DimensionType
extends Object

DimensionType describes the structure of non-Time dimensions. The order of their declaration is significant: it is used to describe the order in which they will appear in data formats for which key values are supplied in an ordered fashion (exclusive of the Time dimension, which is not represented as a member of the ordered key). Some types of non-Time dimensions have un-coded values: the TextFormat element must be provided, to indicate what type of values are permissible. The attributes isFrequencyDimension and isEntityDimension may have a "true" value for any instance of the Dimension element, indicating that it is a dimension of the stated type. The attributes isCountDimension, isNonObservationalTimeDimension, isMeasureDimension, and is IdentityDimension may occur multiple times, and take a true value to indicate that the diemsnion in question is of that type. Note that only one dimension in the key family may be of the following types: Frequency dimension and Entity dimension, and only if there is not also an attribute in the key family of the same type. Any given dimension may only have a true value for one of the set of attributes isFrequencyDimension, isCountDimension, is measureDimension, isEntityDimension, isNonObservationalTimeDimension, and is IdentityDimension. The definitions and limits on representation of each dimension type are as follows: Frequency dimension describes the period between observations, and is coded; Count dimensions are represented by values which are sequential, incrementing numbers - representations are always of the Increment or Count type; measureType dimensions are always coded, and they enumerate the set of possible measures declared for the key family; Entity dimensions describe the subject of the data set (ie, a country) - they can be coded or represented in any other form; Non-Observational Time dimensions must have a representation which contains a time; Identity dimensions may be coded or uncoded, but must be represented by a scheme which refers to the identifiers of external entites. (Conventionally, it is the first dimension in the ordered set of dimensions - the key.) If a key family describes cross-sectional data, then for each dimension, the crossSectionalAttachDataSet, crossSectionalAttachGroup, crossSectionalAttachSection, and crossSectionalAttachObservation attributes must be given values. A value of "true" for any of these attributes indicates that the dimension may be provided a value at the indicated level within the cross-sectional structure. Note that these attributes do not need to be provided for any dimension with the isFrequencyDimension set to "true", as these dimensions are always attached only at the group level, as is time. A key family designed for cross-sectional use must be structured such that any observation's complete key can be unambiguously described by taking each dimension value from its observation level, section level, group level, and data set level, and ordered according to the sequence given in the key family. For any dimension, the id of the referenced concept must be unique acrss the entire key family, including all dimensions, attributes and measures.

Java class for DimensionType complex type.

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

 <complexType name="DimensionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="TextFormat" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}TextFormatType" minOccurs="0"/>
         <element name="Annotations" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}AnnotationsType" minOccurs="0"/>
       </sequence>
       <attribute name="conceptRef" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="conceptVersion" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="conceptAgency" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="conceptSchemeRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="conceptSchemeAgency" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="codelist" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="codelistVersion" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="codelistAgency" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="isMeasureDimension" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="isFrequencyDimension" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="isEntityDimension" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="isCountDimension" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="isNonObservationTimeDimension" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="isIdentityDimension" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="crossSectionalAttachDataSet" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="crossSectionalAttachGroup" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="crossSectionalAttachSection" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="crossSectionalAttachObservation" type="{http://www.w3.org/2001/XMLSchema}boolean" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected AnnotationsType	annotations
protected String	codelist
protected String	codelistAgency
protected String	codelistVersion
protected String	conceptAgency
protected String	conceptRef
protected String	conceptSchemeAgency
protected String	conceptSchemeRef
protected String	conceptVersion
protected Boolean	crossSectionalAttachDataSet
protected Boolean	crossSectionalAttachGroup
protected Boolean	crossSectionalAttachObservation
protected Boolean	crossSectionalAttachSection
protected Boolean	isCountDimension
protected Boolean	isEntityDimension
protected Boolean	isFrequencyDimension
protected Boolean	isIdentityDimension
protected Boolean	isMeasureDimension
protected Boolean	isNonObservationTimeDimension
protected TextFormatType	textFormat

Constructor Summary

DimensionType()

Method Summary

AnnotationsType	getAnnotations() Gets the value of the annotations property.
String	getCodelist() Gets the value of the codelist property.
String	getCodelistAgency() Gets the value of the codelistAgency property.
String	getCodelistVersion() Gets the value of the codelistVersion property.
String	getConceptAgency() Gets the value of the conceptAgency property.
String	getConceptRef() Gets the value of the conceptRef property.
String	getConceptSchemeAgency() Gets the value of the conceptSchemeAgency property.
String	getConceptSchemeRef() Gets the value of the conceptSchemeRef property.
String	getConceptVersion() Gets the value of the conceptVersion property.
TextFormatType	getTextFormat() Gets the value of the textFormat property.
Boolean	isCrossSectionalAttachDataSet() Gets the value of the crossSectionalAttachDataSet property.
Boolean	isCrossSectionalAttachGroup() Gets the value of the crossSectionalAttachGroup property.
Boolean	isCrossSectionalAttachObservation() Gets the value of the crossSectionalAttachObservation property.
Boolean	isCrossSectionalAttachSection() Gets the value of the crossSectionalAttachSection property.
boolean	isIsCountDimension() Gets the value of the isCountDimension property.
boolean	isIsEntityDimension() Gets the value of the isEntityDimension property.
boolean	isIsFrequencyDimension() Gets the value of the isFrequencyDimension property.
boolean	isIsIdentityDimension() Gets the value of the isIdentityDimension property.
boolean	isIsMeasureDimension() Gets the value of the isMeasureDimension property.
boolean	isIsNonObservationTimeDimension() Gets the value of the isNonObservationTimeDimension property.
void	setAnnotations(AnnotationsType value) Sets the value of the annotations property.
void	setCodelist(String value) Sets the value of the codelist property.
void	setCodelistAgency(String value) Sets the value of the codelistAgency property.
void	setCodelistVersion(String value) Sets the value of the codelistVersion property.
void	setConceptAgency(String value) Sets the value of the conceptAgency property.
void	setConceptRef(String value) Sets the value of the conceptRef property.
void	setConceptSchemeAgency(String value) Sets the value of the conceptSchemeAgency property.
void	setConceptSchemeRef(String value) Sets the value of the conceptSchemeRef property.
void	setConceptVersion(String value) Sets the value of the conceptVersion property.
void	setCrossSectionalAttachDataSet(Boolean value) Sets the value of the crossSectionalAttachDataSet property.
void	setCrossSectionalAttachGroup(Boolean value) Sets the value of the crossSectionalAttachGroup property.
void	setCrossSectionalAttachObservation(Boolean value) Sets the value of the crossSectionalAttachObservation property.
void	setCrossSectionalAttachSection(Boolean value) Sets the value of the crossSectionalAttachSection property.
void	setIsCountDimension(Boolean value) Sets the value of the isCountDimension property.
void	setIsEntityDimension(Boolean value) Sets the value of the isEntityDimension property.
void	setIsFrequencyDimension(Boolean value) Sets the value of the isFrequencyDimension property.
void	setIsIdentityDimension(Boolean value) Sets the value of the isIdentityDimension property.
void	setIsMeasureDimension(Boolean value) Sets the value of the isMeasureDimension property.
void	setIsNonObservationTimeDimension(Boolean value) Sets the value of the isNonObservationTimeDimension property.
void	setTextFormat(TextFormatType value) Sets the value of the textFormat property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

textFormat

protected TextFormatType textFormat

annotations

protected AnnotationsType annotations

conceptRef

protected String conceptRef

conceptVersion

protected String conceptVersion

conceptAgency

protected String conceptAgency

conceptSchemeRef

protected String conceptSchemeRef

conceptSchemeAgency

protected String conceptSchemeAgency

codelist

protected String codelist

codelistVersion

protected String codelistVersion

codelistAgency

protected String codelistAgency

isMeasureDimension

protected Boolean isMeasureDimension

isFrequencyDimension

protected Boolean isFrequencyDimension

isEntityDimension

protected Boolean isEntityDimension

isCountDimension

protected Boolean isCountDimension

isNonObservationTimeDimension

protected Boolean isNonObservationTimeDimension

isIdentityDimension

protected Boolean isIdentityDimension

crossSectionalAttachDataSet

protected Boolean crossSectionalAttachDataSet

crossSectionalAttachGroup

protected Boolean crossSectionalAttachGroup

crossSectionalAttachSection

protected Boolean crossSectionalAttachSection

crossSectionalAttachObservation

protected Boolean crossSectionalAttachObservation

Constructor Detail

DimensionType

public DimensionType()

Method Detail

getTextFormat

public TextFormatType getTextFormat()

Gets the value of the textFormat property.

Returns:

possible object is TextFormatType

setTextFormat

public void setTextFormat(TextFormatType value)

Sets the value of the textFormat property.

Parameters:

value - allowed object is TextFormatType

getAnnotations

public AnnotationsType getAnnotations()

Gets the value of the annotations property.

Returns:

possible object is AnnotationsType

setAnnotations

public void setAnnotations(AnnotationsType value)

Sets the value of the annotations property.

Parameters:

value - allowed object is AnnotationsType

getConceptRef

public String getConceptRef()

Gets the value of the conceptRef property.

Returns:

possible object is String

setConceptRef

public void setConceptRef(String value)

Sets the value of the conceptRef property.

Parameters:

value - allowed object is String

getConceptVersion

public String getConceptVersion()

Gets the value of the conceptVersion property.

Returns:

possible object is String

setConceptVersion

public void setConceptVersion(String value)

Sets the value of the conceptVersion property.

Parameters:

value - allowed object is String

getConceptAgency

public String getConceptAgency()

Gets the value of the conceptAgency property.

Returns:

possible object is String

setConceptAgency

public void setConceptAgency(String value)

Sets the value of the conceptAgency property.

Parameters:

value - allowed object is String

getConceptSchemeRef

public String getConceptSchemeRef()

Gets the value of the conceptSchemeRef property.

Returns:

possible object is String

setConceptSchemeRef

public void setConceptSchemeRef(String value)

Sets the value of the conceptSchemeRef property.

Parameters:

value - allowed object is String

getConceptSchemeAgency

public String getConceptSchemeAgency()

Gets the value of the conceptSchemeAgency property.

Returns:

possible object is String

setConceptSchemeAgency

public void setConceptSchemeAgency(String value)

Sets the value of the conceptSchemeAgency property.

Parameters:

value - allowed object is String

getCodelist

public String getCodelist()

Gets the value of the codelist property.

Returns:

possible object is String

setCodelist

public void setCodelist(String value)

Sets the value of the codelist property.

Parameters:

value - allowed object is String

getCodelistVersion

public String getCodelistVersion()

Gets the value of the codelistVersion property.

Returns:

possible object is String

setCodelistVersion

public void setCodelistVersion(String value)

Sets the value of the codelistVersion property.

Parameters:

value - allowed object is String

getCodelistAgency

public String getCodelistAgency()

Gets the value of the codelistAgency property.

Returns:

possible object is String

setCodelistAgency

public void setCodelistAgency(String value)

Sets the value of the codelistAgency property.

Parameters:

value - allowed object is String

isIsMeasureDimension

public boolean isIsMeasureDimension()

Gets the value of the isMeasureDimension property.

Returns:

possible object is Boolean

setIsMeasureDimension

public void setIsMeasureDimension(Boolean value)

Sets the value of the isMeasureDimension property.

Parameters:

value - allowed object is Boolean

isIsFrequencyDimension

public boolean isIsFrequencyDimension()

Gets the value of the isFrequencyDimension property.

Returns:

possible object is Boolean

setIsFrequencyDimension

public void setIsFrequencyDimension(Boolean value)

Sets the value of the isFrequencyDimension property.

Parameters:

value - allowed object is Boolean

isIsEntityDimension

public boolean isIsEntityDimension()

Gets the value of the isEntityDimension property.

Returns:

possible object is Boolean

setIsEntityDimension

public void setIsEntityDimension(Boolean value)

Sets the value of the isEntityDimension property.

Parameters:

value - allowed object is Boolean

isIsCountDimension

public boolean isIsCountDimension()

Gets the value of the isCountDimension property.

Returns:

possible object is Boolean

setIsCountDimension

public void setIsCountDimension(Boolean value)

Sets the value of the isCountDimension property.

Parameters:

value - allowed object is Boolean

isIsNonObservationTimeDimension

public boolean isIsNonObservationTimeDimension()

Gets the value of the isNonObservationTimeDimension property.

Returns:

possible object is Boolean

setIsNonObservationTimeDimension

public void setIsNonObservationTimeDimension(Boolean value)

Sets the value of the isNonObservationTimeDimension property.

Parameters:

value - allowed object is Boolean

isIsIdentityDimension

public boolean isIsIdentityDimension()

Gets the value of the isIdentityDimension property.

Returns:

possible object is Boolean

setIsIdentityDimension

public void setIsIdentityDimension(Boolean value)

Sets the value of the isIdentityDimension property.

Parameters:

value - allowed object is Boolean

isCrossSectionalAttachDataSet

public Boolean isCrossSectionalAttachDataSet()

Gets the value of the crossSectionalAttachDataSet property.

Returns:

possible object is Boolean

setCrossSectionalAttachDataSet

public void setCrossSectionalAttachDataSet(Boolean value)

Sets the value of the crossSectionalAttachDataSet property.

Parameters:

value - allowed object is Boolean

isCrossSectionalAttachGroup

public Boolean isCrossSectionalAttachGroup()

Gets the value of the crossSectionalAttachGroup property.

Returns:

possible object is Boolean

setCrossSectionalAttachGroup

public void setCrossSectionalAttachGroup(Boolean value)

Sets the value of the crossSectionalAttachGroup property.

Parameters:

value - allowed object is Boolean

isCrossSectionalAttachSection

public Boolean isCrossSectionalAttachSection()

Gets the value of the crossSectionalAttachSection property.

Returns:

possible object is Boolean

setCrossSectionalAttachSection

public void setCrossSectionalAttachSection(Boolean value)

Sets the value of the crossSectionalAttachSection property.

Parameters:

value - allowed object is Boolean

isCrossSectionalAttachObservation

public Boolean isCrossSectionalAttachObservation()

Gets the value of the crossSectionalAttachObservation property.

Returns:

possible object is Boolean

setCrossSectionalAttachObservation

public void setCrossSectionalAttachObservation(Boolean value)

Sets the value of the crossSectionalAttachObservation property.

Parameters:

value - allowed object is Boolean