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_0.genericmetadata
Class MetadataSetType

java.lang.Object
  extended by org.sdmx.resources.sdmxml.schemas.v2_0.genericmetadata.MetadataSetType

public class MetadataSetType
extends Object

The Metadata Set is a set of reported metadata against a set of values for a given full or partial target identifier, as described in a metadata structure definition. Child elements include identification of the relevant metadata structure definition using the MetadataStructureRef and MetadataStructureAgencyRef elements. The ReportRef element includes the ID of the report structure as described in the metadata structure definition. AttributeValueSet is a repeatable child element which allows target identifier keys and their associated metadata attribute values to be reported (this functions like a series element does for data sets). An optional name and annotations may also be supplied. The metadataStructureURI allows for a URI to be provided, pointing to the SDMX-ML Structure Message representation of the referenced metadata structure definition. Attributes are provided for describing the contents of a data or metadata set, which are particularly important for interactions with the SDMX Registry: datasetID, dataProviderSchemeAgencyID, dataProviderSchemeID, dataflowAgencyID, and dataflowID all take the IDs specified by the attribute names. The action attribute indicates whether the file is appending, replacing, or deleting. Attributes reportingBeginDate, reportingEndDate, validFromDate, and validToDate are inclusive. publicationYear holds the ISO 8601 four-digit year, and publicationPeriod specifies the period of publication of the data in terms of whatever provisioning agreements might be in force (ie, "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).

Java class for MetadataSetType complex type.

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

 <complexType name="MetadataSetType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Name" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TextType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="MetadataStructureRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType"/>
         <element name="MetadataStructureAgencyRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType"/>
         <element name="ReportRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType"/>
         <element name="AttributeValueSet" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/genericmetadata}AttributeValueSetType" maxOccurs="unbounded"/>
         <element name="Annotations" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}AnnotationsType" minOccurs="0"/>
       </sequence>
       <attribute name="metadataStructureURI" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="datasetID" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="dataProviderSchemeAgencyId" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="dataProviderSchemeId" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="dataProviderID" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="dataflowAgencyID" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="dataflowID" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="action" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}ActionType" />
       <attribute name="reportingBeginDate" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
       <attribute name="reportingEndDate" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
       <attribute name="validFromDate" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
       <attribute name="validToDate" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
       <attribute name="publicationYear" type="{http://www.w3.org/2001/XMLSchema}gYear" />
       <attribute name="publicationPeriod" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary
protected  ActionType action
           
protected  AnnotationsType annotations
           
protected  List<AttributeValueSetType> attributeValueSet
           
protected  String dataflowAgencyID
           
protected  String dataflowID
           
protected  String dataProviderID
           
protected  String dataProviderSchemeAgencyId
           
protected  String dataProviderSchemeId
           
protected  String datasetID
           
protected  String metadataStructureAgencyRef
           
protected  String metadataStructureRef
           
protected  String metadataStructureURI
           
protected  List<TextType> name
           
protected  String publicationPeriod
           
protected  XMLGregorianCalendar publicationYear
           
protected  String reportingBeginDate
           
protected  String reportingEndDate
           
protected  String reportRef
           
protected  String validFromDate
           
protected  String validToDate
           
 
Constructor Summary
MetadataSetType()
           
 
Method Summary
 ActionType getAction()
          Gets the value of the action property.
 AnnotationsType getAnnotations()
          Gets the value of the annotations property.
 List<AttributeValueSetType> getAttributeValueSet()
          Gets the value of the attributeValueSet property.
 String getDataflowAgencyID()
          Gets the value of the dataflowAgencyID property.
 String getDataflowID()
          Gets the value of the dataflowID property.
 String getDataProviderID()
          Gets the value of the dataProviderID property.
 String getDataProviderSchemeAgencyId()
          Gets the value of the dataProviderSchemeAgencyId property.
 String getDataProviderSchemeId()
          Gets the value of the dataProviderSchemeId property.
 String getDatasetID()
          Gets the value of the datasetID property.
 String getMetadataStructureAgencyRef()
          Gets the value of the metadataStructureAgencyRef property.
 String getMetadataStructureRef()
          Gets the value of the metadataStructureRef property.
 String getMetadataStructureURI()
          Gets the value of the metadataStructureURI property.
 List<TextType> getName()
          Gets the value of the name property.
 String getPublicationPeriod()
          Gets the value of the publicationPeriod property.
 XMLGregorianCalendar getPublicationYear()
          Gets the value of the publicationYear property.
 String getReportingBeginDate()
          Gets the value of the reportingBeginDate property.
 String getReportingEndDate()
          Gets the value of the reportingEndDate property.
 String getReportRef()
          Gets the value of the reportRef property.
 String getValidFromDate()
          Gets the value of the validFromDate property.
 String getValidToDate()
          Gets the value of the validToDate property.
 void setAction(ActionType value)
          Sets the value of the action property.
 void setAnnotations(AnnotationsType value)
          Sets the value of the annotations property.
 void setDataflowAgencyID(String value)
          Sets the value of the dataflowAgencyID property.
 void setDataflowID(String value)
          Sets the value of the dataflowID property.
 void setDataProviderID(String value)
          Sets the value of the dataProviderID property.
 void setDataProviderSchemeAgencyId(String value)
          Sets the value of the dataProviderSchemeAgencyId property.
 void setDataProviderSchemeId(String value)
          Sets the value of the dataProviderSchemeId property.
 void setDatasetID(String value)
          Sets the value of the datasetID property.
 void setMetadataStructureAgencyRef(String value)
          Sets the value of the metadataStructureAgencyRef property.
 void setMetadataStructureRef(String value)
          Sets the value of the metadataStructureRef property.
 void setMetadataStructureURI(String value)
          Sets the value of the metadataStructureURI property.
 void setPublicationPeriod(String value)
          Sets the value of the publicationPeriod property.
 void setPublicationYear(XMLGregorianCalendar value)
          Sets the value of the publicationYear property.
 void setReportingBeginDate(String value)
          Sets the value of the reportingBeginDate property.
 void setReportingEndDate(String value)
          Sets the value of the reportingEndDate property.
 void setReportRef(String value)
          Sets the value of the reportRef property.
 void setValidFromDate(String value)
          Sets the value of the validFromDate property.
 void setValidToDate(String value)
          Sets the value of the validToDate property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected List<TextType> name

metadataStructureRef

protected String metadataStructureRef

metadataStructureAgencyRef

protected String metadataStructureAgencyRef

reportRef

protected String reportRef

attributeValueSet

protected List<AttributeValueSetType> attributeValueSet

annotations

protected AnnotationsType annotations

metadataStructureURI

protected String metadataStructureURI

datasetID

protected String datasetID

dataProviderSchemeAgencyId

protected String dataProviderSchemeAgencyId

dataProviderSchemeId

protected String dataProviderSchemeId

dataProviderID

protected String dataProviderID

dataflowAgencyID

protected String dataflowAgencyID

dataflowID

protected String dataflowID

action

protected ActionType action

reportingBeginDate

protected String reportingBeginDate

reportingEndDate

protected String reportingEndDate

validFromDate

protected String validFromDate

validToDate

protected String validToDate

publicationYear

protected XMLGregorianCalendar publicationYear

publicationPeriod

protected String publicationPeriod
Constructor Detail

MetadataSetType

public MetadataSetType()
Method Detail

getName

public List<TextType> getName()
Gets the value of the name 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 name property.

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

    getName().add(newItem);

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

getMetadataStructureRef

public String getMetadataStructureRef()
Gets the value of the metadataStructureRef property.

Returns:
possible object is String

setMetadataStructureRef

public void setMetadataStructureRef(String value)
Sets the value of the metadataStructureRef property.

Parameters:
value - allowed object is String

getMetadataStructureAgencyRef

public String getMetadataStructureAgencyRef()
Gets the value of the metadataStructureAgencyRef property.

Returns:
possible object is String

setMetadataStructureAgencyRef

public void setMetadataStructureAgencyRef(String value)
Sets the value of the metadataStructureAgencyRef property.

Parameters:
value - allowed object is String

getReportRef

public String getReportRef()
Gets the value of the reportRef property.

Returns:
possible object is String

setReportRef

public void setReportRef(String value)
Sets the value of the reportRef property.

Parameters:
value - allowed object is String

getAttributeValueSet

public List<AttributeValueSetType> getAttributeValueSet()
Gets the value of the attributeValueSet 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 attributeValueSet property.

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

    getAttributeValueSet().add(newItem);

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

getAnnotations

public AnnotationsType getAnnotations()
Gets the value of the annotations property.

Returns:
possible object is AnnotationsType

setAnnotations

public void setAnnotations(AnnotationsType value)
Sets the value of the annotations property.

Parameters:
value - allowed object is AnnotationsType

getMetadataStructureURI

public String getMetadataStructureURI()
Gets the value of the metadataStructureURI property.

Returns:
possible object is String

setMetadataStructureURI

public void setMetadataStructureURI(String value)
Sets the value of the metadataStructureURI property.

Parameters:
value - allowed object is String

getDatasetID

public String getDatasetID()
Gets the value of the datasetID property.

Returns:
possible object is String

setDatasetID

public void setDatasetID(String value)
Sets the value of the datasetID property.

Parameters:
value - allowed object is String

getDataProviderSchemeAgencyId

public String getDataProviderSchemeAgencyId()
Gets the value of the dataProviderSchemeAgencyId property.

Returns:
possible object is String

setDataProviderSchemeAgencyId

public void setDataProviderSchemeAgencyId(String value)
Sets the value of the dataProviderSchemeAgencyId property.

Parameters:
value - allowed object is String

getDataProviderSchemeId

public String getDataProviderSchemeId()
Gets the value of the dataProviderSchemeId property.

Returns:
possible object is String

setDataProviderSchemeId

public void setDataProviderSchemeId(String value)
Sets the value of the dataProviderSchemeId property.

Parameters:
value - allowed object is String

getDataProviderID

public String getDataProviderID()
Gets the value of the dataProviderID property.

Returns:
possible object is String

setDataProviderID

public void setDataProviderID(String value)
Sets the value of the dataProviderID property.

Parameters:
value - allowed object is String

getDataflowAgencyID

public String getDataflowAgencyID()
Gets the value of the dataflowAgencyID property.

Returns:
possible object is String

setDataflowAgencyID

public void setDataflowAgencyID(String value)
Sets the value of the dataflowAgencyID property.

Parameters:
value - allowed object is String

getDataflowID

public String getDataflowID()
Gets the value of the dataflowID property.

Returns:
possible object is String

setDataflowID

public void setDataflowID(String value)
Sets the value of the dataflowID 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 String getReportingBeginDate()
Gets the value of the reportingBeginDate property.

Returns:
possible object is String

setReportingBeginDate

public void setReportingBeginDate(String value)
Sets the value of the reportingBeginDate property.

Parameters:
value - allowed object is String

getReportingEndDate

public String getReportingEndDate()
Gets the value of the reportingEndDate property.

Returns:
possible object is String

setReportingEndDate

public void setReportingEndDate(String value)
Sets the value of the reportingEndDate property.

Parameters:
value - allowed object is String

getValidFromDate

public String getValidFromDate()
Gets the value of the validFromDate property.

Returns:
possible object is String

setValidFromDate

public void setValidFromDate(String value)
Sets the value of the validFromDate property.

Parameters:
value - allowed object is String

getValidToDate

public String getValidToDate()
Gets the value of the validToDate property.

Returns:
possible object is String

setValidToDate

public void setValidToDate(String value)
Sets the value of the validToDate property.

Parameters:
value - allowed object is String

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 String getPublicationPeriod()
Gets the value of the publicationPeriod property.

Returns:
possible object is String

setPublicationPeriod

public void setPublicationPeriod(String value)
Sets the value of the publicationPeriod property.

Parameters:
value - allowed object is String
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.