org.sdmx.resources.sdmxml.schemas.v2_1.data.structurespecific
Class ObsType

java.lang.Object
  org.sdmx.resources.sdmxml.schemas.v2_1.common.AnnotableType
      org.sdmx.resources.sdmxml.schemas.v2_1.data.structurespecific.ObsType

Direct Known Subclasses:

TimeSeriesObsType

public abstract class ObsType
extends AnnotableType

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific" xmlns:common="http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common" xmlns:xs="http://www.w3.org/2001/XMLSchema">ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values.</p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific" xmlns:common="http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common" xmlns:xs="http://www.w3.org/2001/XMLSchema">Data structure definition schemas will drive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attribute(s) will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived observation type be for the observation dimension(s) and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.</p>
 

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific" xmlns:common="http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common" xmlns:xs="http://www.w3.org/2001/XMLSchema">If the data structure definition specific schema requires that explicit measures be used (only possible when the measure dimension is specified at the observation), then there will be types derived for each measure defined by the measure dimension. In this case, the types will be specific to each measure, which is to say that the representation of the primary measure (i.e. the observed value) will be restricted to that which is specified by the specific measure.</p>
 

Java class for ObsType complex type.

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

 <complexType name="ObsType">
   <complexContent>
     <extension base="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}AnnotableType">
       <attribute name="type" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}IDType" />
       <attribute name="TIME_PERIOD" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}ObservationalTimePeriodType" />
       <attribute name="REPORTING_YEAR_START_DAY" type="{http://www.w3.org/2001/XMLSchema}gMonthDay" />
       <attribute name="OBS_VALUE" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
       <anyAttribute namespace=''/>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

protected String	obsvalue
protected XMLGregorianCalendar	reportingyearstartday
protected List<String>	timeperiod
protected String	type

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

annotations

Constructor Summary

ObsType()

Method Summary

String	getOBSVALUE() Gets the value of the obsvalue property.
Map<QName,String>	getOtherAttributes() Gets a map that contains attributes that aren't bound to any typed property on this class.
XMLGregorianCalendar	getREPORTINGYEARSTARTDAY() Gets the value of the reportingyearstartday property.
List<String>	getTIMEPERIOD() Gets the value of the timeperiod property.
String	getType() Gets the value of the type property.
void	setOBSVALUE(String value) Sets the value of the obsvalue property.
void	setREPORTINGYEARSTARTDAY(XMLGregorianCalendar value) Sets the value of the reportingyearstartday property.
void	setType(String value) Sets the value of the type property.

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

Field Detail

type

protected String type

timeperiod

protected List<String> timeperiod

reportingyearstartday

protected XMLGregorianCalendar reportingyearstartday

obsvalue

protected String obsvalue

Constructor Detail

ObsType

public ObsType()

Method Detail

getType

public String getType()

Gets the value of the type property.

Returns:

possible object is String

setType

public void setType(String value)

Sets the value of the type property.

Parameters:

value - allowed object is String

getTIMEPERIOD

public List<String> getTIMEPERIOD()

Gets the value of the timeperiod 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 timeperiod property.

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

    getTIMEPERIOD().add(newItem);
 

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

getREPORTINGYEARSTARTDAY

public XMLGregorianCalendar getREPORTINGYEARSTARTDAY()

Gets the value of the reportingyearstartday property.

Returns:

possible object is XMLGregorianCalendar

setREPORTINGYEARSTARTDAY

public void setREPORTINGYEARSTARTDAY(XMLGregorianCalendar value)

Sets the value of the reportingyearstartday property.

Parameters:

value - allowed object is XMLGregorianCalendar

getOBSVALUE

public String getOBSVALUE()

Gets the value of the obsvalue property.

Returns:

possible object is String

setOBSVALUE

public void setOBSVALUE(String value)

Sets the value of the obsvalue property.

Parameters:

value - allowed object is String

getOtherAttributes

public Map<QName,String> getOtherAttributes()

Gets a map that contains attributes that aren't bound to any typed property on this class.

the map is keyed by the name of the attribute and the value is the string value of the attribute. the map returned by this method is live, and you can add new attribute by updating the map directly. Because of this design, there's no setter.

Returns:

always non-null