ReportingTaxonomyType (sdmx-model-2

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.structure
Class ReportingTaxonomyType

java.lang.Object
  org.sdmx.resources.sdmxml.schemas.v2_0.structure.ReportingTaxonomyType

public class ReportingTaxonomyType
extends Object
extends Object

ReportingTaxonomyType groups data flows and/or metadata flows for the purposes of assembling "reports" made up of data from disparate sources. It is a maintainable object, and thus has a mandatory human-readable Name and optional Description containing a longer human-readable description. Annotations may be included. All of these fields may be provided in multiple, parallel languages. The id attribute assignes a unique ID to the Reporting Taxonomy, version provides a version number, uri contains a URL where the SDMX-ML expression of the Reporting taxonomy can be found, and must be included if the isExternalReference attribute has a value of true. The urn attribute holds the value of a valid SDMX Registry URN as per the SDMX Registry specification. The isExternalReference attribute, if set to true, indicates that the uri attribute points to an external location for the ReportingTaxonomy, with only the id, Name element, and version supplied in addition. The agencyID attribute holds the ID of the Reporting Taxonomies' maintenance agency. Also, if the Reporting Taxonomy is final, the isFinal attribute must`have a value of true - otherwise, it will be assumed to be non-final. (All production versions must be made final - that is, unchangeable without versioning.) The sub-element Category may be used to group dataflows and metadataflows into useful sub-packages. DataflowRef and MetadataFlowRef are references to the flows which make up the reporting taxonomy at the top level. The validFrom and validTo attributes provide inclusive dates for providing supplemental validity information about the version.

Java class for ReportingTaxonomyType complex type.

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

 <complexType name="ReportingTaxonomyType">
   <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"/>
         <element name="Description" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TextType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="DataflowRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}DataflowRefType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="MetadataflowRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}MetadataflowRefType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Category" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}CategoryType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Annotations" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}AnnotationsType" minOccurs="0"/>
       </sequence>
       <attribute name="id" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="uri" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="urn" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="isExternalReference" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="agencyID" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="isFinal" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="validFrom" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
       <attribute name="validTo" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary
`protected String`	`agencyID`
`protected AnnotationsType`	`annotations`
`protected List<CategoryType>`	`category`
`protected List<DataflowRefType>`	`dataflowRef`
`protected List<TextType>`	`description`
`protected String`	`id`
`protected Boolean`	`isExternalReference`
`protected Boolean`	`isFinal`
`protected List<MetadataflowRefType>`	`metadataflowRef`
`protected List<TextType>`	`name`
`protected String`	`uri`
`protected String`	`urn`
`protected String`	`validFrom`
`protected String`	`validTo`
`protected String`	`version`

Constructor Summary
`ReportingTaxonomyType()`

Method Summary
`String`	`getAgencyID()` Gets the value of the agencyID property.
`AnnotationsType`	`getAnnotations()` Gets the value of the annotations property.
`List<CategoryType>`	`getCategory()` Gets the value of the category property.
`List<DataflowRefType>`	`getDataflowRef()` Gets the value of the dataflowRef property.
`List<TextType>`	`getDescription()` Gets the value of the description property.
`String`	`getId()` Gets the value of the id property.
`List<MetadataflowRefType>`	`getMetadataflowRef()` Gets the value of the metadataflowRef property.
`List<TextType>`	`getName()` Gets the value of the name property.
`String`	`getUri()` Gets the value of the uri property.
`String`	`getUrn()` Gets the value of the urn property.
`String`	`getValidFrom()` Gets the value of the validFrom property.
`String`	`getValidTo()` Gets the value of the validTo property.
`String`	`getVersion()` Gets the value of the version property.
`Boolean`	`isIsExternalReference()` Gets the value of the isExternalReference property.
`Boolean`	`isIsFinal()` Gets the value of the isFinal property.
`void`	`setAgencyID(String value)` Sets the value of the agencyID property.
`void`	`setAnnotations(AnnotationsType value)` Sets the value of the annotations property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setIsExternalReference(Boolean value)` Sets the value of the isExternalReference property.
`void`	`setIsFinal(Boolean value)` Sets the value of the isFinal property.
`void`	`setUri(String value)` Sets the value of the uri property.
`void`	`setUrn(String value)` Sets the value of the urn property.
`void`	`setValidFrom(String value)` Sets the value of the validFrom property.
`void`	`setValidTo(String value)` Sets the value of the validTo property.
`void`	`setVersion(String value)` Sets the value of the version 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

description

protected List<TextType> description

dataflowRef

protected List<DataflowRefType> dataflowRef

metadataflowRef

protected List<MetadataflowRefType> metadataflowRef

annotations

protected AnnotationsType annotations

id

protected String id

version

protected String version

uri

protected String uri

urn

protected String urn

isExternalReference

protected Boolean isExternalReference

agencyID

protected String agencyID

isFinal

protected Boolean isFinal

validFrom

protected String validFrom

validTo

protected String validTo

Constructor Detail

ReportingTaxonomyType

public ReportingTaxonomyType()

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.