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

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

public class TimeDimensionType
extends Object

TimeDimensionType describes the special Time dimension. Any key family which will be used for time-series formats (GenericData, CompactData, and UtilityData) must include the time dimension. Any key family which uses the time dimension must also declare a frequency dimension, conventionally the first dimension in the key (the set of ordered non-time dimensions). A TextFormat element may be included for indicating the representation of time. The concept attribute must contain the concept name of the time concept. The codelist attribute may provide the value of the concept name of a codelist if needed. 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.

Java class for TimeDimensionType complex type.

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

 <complexType name="TimeDimensionType">
   <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="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 TextFormatType	textFormat

Constructor Summary

TimeDimensionType()

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

crossSectionalAttachDataSet

protected Boolean crossSectionalAttachDataSet

crossSectionalAttachGroup

protected Boolean crossSectionalAttachGroup

crossSectionalAttachSection

protected Boolean crossSectionalAttachSection

crossSectionalAttachObservation

protected Boolean crossSectionalAttachObservation

Constructor Detail

TimeDimensionType

public TimeDimensionType()

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

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