org.sdmx.resources.sdmxml.schemas.v2_1.data.generic
Class DataSetType

java.lang.Object
  org.sdmx.resources.sdmxml.schemas.v2_1.common.AnnotableType
      org.sdmx.resources.sdmxml.schemas.v2_1.data.generic.DataSetType

Direct Known Subclasses:

TimeSeriesDataSetType

public class DataSetType
extends AnnotableType

DataSetType defines the structure of the generic data set. Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The organisation used is dependent on the structure specification in the header of the data message (which is referenced via the structureRef attribute). The structure specification states which data occurs at the observation level. If this dimension is "AllDimensions" then the data set must consist of a collection of un-grouped observations; otherwise the data set will contain a collection of series with the observations in the series disambiguated by the specified dimension at the observation level. This data set is capable of containing data (observed values) and/or documentation (attribute values). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series.

Java class for DataSetType complex type.

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

 <complexType name="DataSetType">
   <complexContent>
     <extension base="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}AnnotableType">
       <sequence>
         <element name="DataProvider" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}DataProviderReferenceType" minOccurs="0"/>
         <element name="Attributes" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/generic}ValuesType" minOccurs="0"/>
         <element name="Group" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/generic}GroupType" maxOccurs="unbounded" minOccurs="0"/>
         <choice minOccurs="0">
           <element name="Series" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/generic}SeriesType" maxOccurs="unbounded"/>
           <element name="Obs" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/generic}ObsOnlyType" maxOccurs="unbounded"/>
         </choice>
       </sequence>
       <attGroup ref="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}SetAttributeGroup"/>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

protected ActionType	action
protected ValuesType	attributes
protected DataProviderReferenceType	dataProvider
protected List<GroupType>	group
protected List<ObsOnlyType>	obs
protected List<String>	publicationPeriod
protected XMLGregorianCalendar	publicationYear
protected List<String>	reportingBeginDate
protected List<String>	reportingEndDate
protected List<SeriesType>	series
protected String	setID
protected Object	structureRef
protected XMLGregorianCalendar	validFromDate
protected XMLGregorianCalendar	validToDate

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

annotations

Constructor Summary

DataSetType()

Method Summary

ActionType	getAction() Gets the value of the action property.
ValuesType	getAttributes() Gets the value of the attributes property.
DataProviderReferenceType	getDataProvider() Gets the value of the dataProvider property.
List<GroupType>	getGroup() Gets the value of the group property.
List<ObsOnlyType>	getObs() Gets the value of the obs property.
List<String>	getPublicationPeriod() Gets the value of the publicationPeriod property.
XMLGregorianCalendar	getPublicationYear() Gets the value of the publicationYear property.
List<String>	getReportingBeginDate() Gets the value of the reportingBeginDate property.
List<String>	getReportingEndDate() Gets the value of the reportingEndDate property.
List<SeriesType>	getSeries() Gets the value of the series property.
String	getSetID() Gets the value of the setID property.
Object	getStructureRef() Gets the value of the structureRef property.
XMLGregorianCalendar	getValidFromDate() Gets the value of the validFromDate property.
XMLGregorianCalendar	getValidToDate() Gets the value of the validToDate property.
void	setAction(ActionType value) Sets the value of the action property.
void	setAttributes(ValuesType value) Sets the value of the attributes property.
void	setDataProvider(DataProviderReferenceType value) Sets the value of the dataProvider property.
void	setPublicationYear(XMLGregorianCalendar value) Sets the value of the publicationYear property.
void	setSetID(String value) Sets the value of the setID property.
void	setStructureRef(Object value) Sets the value of the structureRef property.
void	setValidFromDate(XMLGregorianCalendar value) Sets the value of the validFromDate property.
void	setValidToDate(XMLGregorianCalendar value) Sets the value of the validToDate 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

dataProvider

protected DataProviderReferenceType dataProvider

attributes

protected ValuesType attributes

group

protected List<GroupType> group

series

protected List<SeriesType> series

obs

protected List<ObsOnlyType> obs

structureRef

protected Object structureRef

setID

protected String setID

action

protected ActionType action

reportingBeginDate

protected List<String> reportingBeginDate

reportingEndDate

protected List<String> reportingEndDate

validFromDate

protected XMLGregorianCalendar validFromDate

validToDate

protected XMLGregorianCalendar validToDate

publicationYear

protected XMLGregorianCalendar publicationYear

publicationPeriod

protected List<String> publicationPeriod

Constructor Detail

DataSetType

public DataSetType()

Method Detail

getDataProvider

public DataProviderReferenceType getDataProvider()

Gets the value of the dataProvider property.

Returns:

possible object is DataProviderReferenceType

setDataProvider

public void setDataProvider(DataProviderReferenceType value)

Sets the value of the dataProvider property.

Parameters:

value - allowed object is DataProviderReferenceType

getAttributes

public ValuesType getAttributes()

Gets the value of the attributes property.

Returns:

possible object is ValuesType

setAttributes

public void setAttributes(ValuesType value)

Sets the value of the attributes property.

Parameters:

value - allowed object is ValuesType

getGroup

public List<GroupType> getGroup()

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

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

    getGroup().add(newItem);
 

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

getSeries

public List<SeriesType> getSeries()

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

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

    getSeries().add(newItem);
 

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

getObs

public List<ObsOnlyType> 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 ObsOnlyType

getStructureRef

public Object getStructureRef()

Gets the value of the structureRef property.

Returns:

possible object is Object

setStructureRef

public void setStructureRef(Object value)

Sets the value of the structureRef property.

Parameters:

value - allowed object is Object

getSetID

public String getSetID()

Gets the value of the setID property.

Returns:

possible object is String

setSetID

public void setSetID(String value)

Sets the value of the setID property.

Parameters:

value - allowed object is String

getAction

public ActionType getAction()

Gets the value of the action property.

Returns:

possible object is ActionType

setAction

public void setAction(ActionType value)

Sets the value of the action property.

Parameters:

value - allowed object is ActionType

getReportingBeginDate

public List<String> getReportingBeginDate()

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

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

    getReportingBeginDate().add(newItem);
 

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

getReportingEndDate

public List<String> getReportingEndDate()

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

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

    getReportingEndDate().add(newItem);
 

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

getValidFromDate

public XMLGregorianCalendar getValidFromDate()

Gets the value of the validFromDate property.

Returns:

possible object is XMLGregorianCalendar

setValidFromDate

public void setValidFromDate(XMLGregorianCalendar value)

Sets the value of the validFromDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getValidToDate

public XMLGregorianCalendar getValidToDate()

Gets the value of the validToDate property.

Returns:

possible object is XMLGregorianCalendar

setValidToDate

public void setValidToDate(XMLGregorianCalendar value)

Sets the value of the validToDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getPublicationYear

public XMLGregorianCalendar getPublicationYear()

Gets the value of the publicationYear property.

Returns:

possible object is XMLGregorianCalendar

setPublicationYear

public void setPublicationYear(XMLGregorianCalendar value)

Sets the value of the publicationYear property.

Parameters:

value - allowed object is XMLGregorianCalendar

getPublicationPeriod

public List<String> getPublicationPeriod()

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

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

    getPublicationPeriod().add(newItem);
 

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