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

java.lang.Object
  org.sdmx.resources.sdmxml.schemas.v2_1.common.AnnotableType
      org.sdmx.resources.sdmxml.schemas.v2_1.structure.IdentifiableType
          org.sdmx.resources.sdmxml.schemas.v2_1.structure.ComponentBaseType
              org.sdmx.resources.sdmxml.schemas.v2_1.structure.ComponentType
                  org.sdmx.resources.sdmxml.schemas.v2_1.structure.BaseDimensionBaseType
                      org.sdmx.resources.sdmxml.schemas.v2_1.structure.BaseDimensionType
                          org.sdmx.resources.sdmxml.schemas.v2_1.structure.TimeDimensionType

public class TimeDimensionType
extends BaseDimensionType

TimeDimensionType describes the structure of a time dimension. The time dimension takes its semantic from its concept identity (usually the TIME_PERIOD concept), yet is always has a fixed identifier (TIME_PERIOD). The time dimension always has a fixed text format, which specifies that its format is always the in the value set of the observational time period (see common:ObservationalTimePeriodType). It is possible that the format may be a sub-set of the observational time period value set. For example, it is possible to state that the representation might always be a calendar year. See the enumerations of the textType attribute in the LocalRepresentation/TextFormat for more details of the possible sub-sets. It is also possible to facet this representation with start and end dates. The purpose of such facts is to restrict the value of the time dimension to occur within the specified range. If the time dimension is expected to allow for the standard reporting periods (see common:ReportingTimePeriodType) to be used, then it is strongly recommended that the reporting year start day attribute also be included in the data structure definition. When the reporting year start day attribute is used, any standard reporting period values will be assumed to be based on the start day contained in this attribute. If the reporting year start day attribute is not included and standard reporting periods are used, these values will be assumed to be based on a reporting year which begins January 1.

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.sdmx.org/resources/sdmxml/schemas/v2_1/structure}BaseDimensionType">
       <sequence>
         <element ref="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}Annotations" minOccurs="0"/>
         <element name="ConceptIdentity" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}ConceptReferenceType"/>
         <element name="LocalRepresentation" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/structure}TimeDimensionRepresentationType"/>
       </sequence>
       <attribute name="id" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}NCNameIDType" fixed="TIME_PERIOD" />
       <attribute name="type" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}DimensionTypeType" fixed="TimeDimension" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.structure.BaseDimensionType

conceptRole, position, type

Fields inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.structure.ComponentType

conceptIdentity, localRepresentation

Fields inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.structure.IdentifiableType

id, uri, urn

Fields inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.common.AnnotableType

annotations

Constructor Summary

TimeDimensionType()

Method Summary

Methods inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.structure.BaseDimensionType

getConceptRole, getPosition, getType, setPosition, setType

Methods inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.structure.ComponentType

getConceptIdentity, getLocalRepresentation, setConceptIdentity, setLocalRepresentation

Methods inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.structure.IdentifiableType

getId, getUri, getUrn, setId, setUri, setUrn

Methods inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.common.AnnotableType

getAnnotations, setAnnotations

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeDimensionType

public TimeDimensionType()