org.sdmx.resources.sdmxml.schemas.v2_0.structure
Class HierarchyType

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

public class HierarchyType
extends Object

The recursive CodeRef element is used to assemble the codes in the codelist(s) referenced by the parent hierarchical codelist into a hierarchy. The Level element is used to describe the levels of a levelled hierarchy, which may be referenced from each of the CodeRefs in the Hierarchy. A human-readable name must be assigned, which may be provided in multiple, parallel-language versions. A longer, human-readable Description may also be provided, which can also have multiple parallel-language versions. Annotations may be provided with the Annotations element. The id attribute provides a unique id for the hierarchy. The urn attribute can be used to specify the hierarchy with a valid SDMX Registry URN (see the SDMX Registry Specification). The version attribute specifies a version (understood to be "1.0" if not specified), and isFinal, once given a value of true, indicates that nothing may be changed without also changing the version number. validFrom and validTo are inclusive dates indicating the relevant period of the hierarchy.

Java class for HierarchyType complex type.

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

 <complexType name="HierarchyType">
   <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="CodeRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}CodeRefType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Level" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}LevelType" 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="urn" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" />
       <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 AnnotationsType	annotations
protected List<CodeRefType>	codeRef
protected List<TextType>	description
protected String	id
protected Boolean	isFinal
protected List<LevelType>	level
protected List<TextType>	name
protected String	urn
protected String	validFrom
protected String	validTo
protected String	version

Constructor Summary

HierarchyType()

Method Summary

AnnotationsType	getAnnotations() Gets the value of the annotations property.
List<CodeRefType>	getCodeRef() Gets the value of the codeRef property.
List<TextType>	getDescription() Gets the value of the description property.
String	getId() Gets the value of the id property.
List<LevelType>	getLevel() Gets the value of the level property.
List<TextType>	getName() Gets the value of the name 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	isIsFinal() Gets the value of the isFinal property.
void	setAnnotations(AnnotationsType value) Sets the value of the annotations property.
void	setId(String value) Sets the value of the id property.
void	setIsFinal(Boolean value) Sets the value of the isFinal 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

codeRef

protected List<CodeRefType> codeRef

level

protected List<LevelType> level

annotations

protected AnnotationsType annotations

id

protected String id

urn

protected String urn

version

protected String version

isFinal

protected Boolean isFinal

validFrom

protected String validFrom

validTo

protected String validTo

Constructor Detail

HierarchyType

public HierarchyType()

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

getDescription

public List<TextType> getDescription()

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

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

    getDescription().add(newItem);
 

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

getCodeRef

public List<CodeRefType> getCodeRef()

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

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

    getCodeRef().add(newItem);
 

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

getLevel

public List<LevelType> getLevel()

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

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

    getLevel().add(newItem);
 

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

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

getId

public String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String

getUrn

public String getUrn()

Gets the value of the urn property.

Returns:

possible object is String

setUrn

public void setUrn(String value)

Sets the value of the urn property.

Parameters:

value - allowed object is String

getVersion

public String getVersion()

Gets the value of the version property.

Returns:

possible object is String

setVersion

public void setVersion(String value)

Sets the value of the version property.

Parameters:

value - allowed object is String

isIsFinal

public Boolean isIsFinal()

Gets the value of the isFinal property.

Returns:

possible object is Boolean

setIsFinal

public void setIsFinal(Boolean value)

Sets the value of the isFinal property.

Parameters:

value - allowed object is Boolean

getValidFrom

public String getValidFrom()

Gets the value of the validFrom property.

Returns:

possible object is String

setValidFrom

public void setValidFrom(String value)

Sets the value of the validFrom property.

Parameters:

value - allowed object is String

getValidTo

public String getValidTo()

Gets the value of the validTo property.

Returns:

possible object is String

setValidTo

public void setValidTo(String value)

Sets the value of the validTo property.

Parameters:

value - allowed object is String