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

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

Direct Known Subclasses:

TimeSeriesType

public abstract class SeriesType
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">SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition, save the dimension declared to be at the observation level for this data set. In addition to observations, values can be provided for attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both.</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 based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series 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 attributes 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 group type be for the series dimensions 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>
 

Java class for SeriesType complex type.

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

 <complexType name="SeriesType">
   <complexContent>
     <extension base="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}AnnotableType">
       <sequence>
         <element name="Obs" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific}ObsType" maxOccurs="unbounded" minOccurs="0" form="unqualified"/>
       </sequence>
       <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" />
       <anyAttribute namespace=''/>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

protected List<ObsType>	obs
protected XMLGregorianCalendar	reportingyearstartday
protected List<String>	timeperiod

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

annotations

Constructor Summary

SeriesType()

Method Summary

List<ObsType>	getObs() Gets the value of the obs 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.
void	setREPORTINGYEARSTARTDAY(XMLGregorianCalendar value) Sets the value of the reportingyearstartday 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

obs

protected List<ObsType> obs

timeperiod

protected List<String> timeperiod

reportingyearstartday

protected XMLGregorianCalendar reportingyearstartday

Constructor Detail

SeriesType

public SeriesType()

Method Detail

getObs

public List<ObsType> getObs()

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

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

    getObs().add(newItem);
 

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

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

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