Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  extended by org.sdmx.resources.sdmxml.schemas.v2_1.common.AnnotableType
      extended by org.sdmx.resources.sdmxml.schemas.v2_1.data.structurespecific.DataSetType
Direct Known Subclasses:
TimeSeriesDataSetType
public abstract class DataSetType
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">DataSetType is the abstract type which defines the base structure for any data structure definition specific data set. A derived data set type will be created that is specific to a data structure definition and the details of the organisation of the data (i.e. which dimension is the observation dimension and whether explicit measures should be used). Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The derived data set type will restrict this choice to be either grouped or un-grouped observations. If this dimension is "AllDimensions" then the derived data set type 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) and can be used for incremental updates and deletions (i.e. only the relevant updates or deletes are exchanged). 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.</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">This base type is designed such that derived types can be processed in a generic manner; it assures that data structure definition specific data will have a consistent structure. The group, series, and observation elements are unqualified, meaning that they are not qualified with a namespace in an instance. This means that in the derived data set types, the elements will always be the same, regardless of the target namespace of the schemas which defines these derived types. This allows for consistent processing of the structure without regard to what the namespace might be for the data structure definition specific schema.</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">The data set can contain values for attributes which do not have an attribute relationship with any data structure definition components. These attribute values will exist in XML attributes in this element based on this type (DataSet). This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived data set 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). To allow for generic processing, it is required that the only unqualified XML attributes in the derived data set type (outside of the standard data set attributes) be for 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 attribute.</p>

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" form="unqualified"/>
         <element name="Group" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific}GroupType" maxOccurs="unbounded" minOccurs="0" form="unqualified"/>
         <choice minOccurs="0">
           <element name="Series" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific}SeriesType" maxOccurs="unbounded" form="unqualified"/>
           <element name="Obs" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific}ObsType" maxOccurs="unbounded" form="unqualified"/>
         </choice>
       </sequence>
       <attGroup ref="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific}SetAttributeGroup"/>
       <attribute name="REPORTING_YEAR_START_DAY" type="{http://www.w3.org/2001/XMLSchema}gMonthDay" />
       <anyAttribute namespace=''/>
     </extension>
   </complexContent>
 </complexType>

Field Summary
protected  ActionType action
           
protected  DataProviderReferenceType dataProvider
           
protected  DataScopeType dataScope
           
protected  List<GroupType> group
           
protected  List<ObsType> obs
           
protected  List<String> publicationPeriod
           
protected  XMLGregorianCalendar publicationYear
           
protected  List<String> reportingBeginDate
           
protected  List<String> reportingEndDate
           
protected  XMLGregorianCalendar reportingyearstartday
           
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.
 DataProviderReferenceType getDataProvider()
          Gets the value of the dataProvider property.
 DataScopeType getDataScope()
          Gets the value of the dataScope property.
 List<GroupType> getGroup()
          Gets the value of the group property.
 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.
 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.
 XMLGregorianCalendar getREPORTINGYEARSTARTDAY()
          Gets the value of the reportingyearstartday 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 setDataProvider(DataProviderReferenceType value)
          Sets the value of the dataProvider property.
 void setDataScope(DataScopeType value)
          Sets the value of the dataScope property.
 void setPublicationYear(XMLGregorianCalendar value)
          Sets the value of the publicationYear property.
 void setREPORTINGYEARSTARTDAY(XMLGregorianCalendar value)
          Sets the value of the reportingyearstartday 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

group

protected List<GroupType> group

series

protected List<SeriesType> series

obs

protected List<ObsType> obs

reportingyearstartday

protected XMLGregorianCalendar reportingyearstartday

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

dataScope

protected DataScopeType dataScope
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

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

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

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

getDataScope

public DataScopeType getDataScope()
Gets the value of the dataScope property.

Returns:
possible object is DataScopeType

setDataScope

public void setDataScope(DataScopeType value)
Sets the value of the dataScope property.

Parameters:
value - allowed object is DataScopeType

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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2012. All Rights Reserved.