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

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

public class HierarchicalCodelistType
extends Object

A hierarchical codelist references a Codelist, and supplies the extra structural metadata to assemble the codes into a hierarchy. A human-readable name must be supplied, and multiple language-specific variants may be provided. A longer human-readable description may be provided, and may also be presented as a set of language-specific variants. The CodelistRef element references a codelist, and may indicate more than one. Annotations may be provided in the Annotaions element. An ID unique for the agency specified in the agency attribute must be assigned, using the id attribute. A version may be provided using the version attribute - if no value is provided, it is assumed to be "1.0". A valid SDMX Registry URN may be provided in the urn attribute, as specified in the SDMX Registry Specification. If the isExternalReference attribute has a value of true, the uri attribute must specify the location of a valid SDMX Structure Message which provides the full details of the hierarchical codelist; otherwise, all details must be present. The validFrom and validTo attributes provide inclusive dates for providing supplemental validity information about the version.

Java class for HierarchicalCodelistType complex type.

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

 <complexType name="HierarchicalCodelistType">
   <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="CodelistRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}CodelistRefType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Hierarchy" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}HierarchyType" 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="agencyID" 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="urn" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="uri" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="isExternalReference" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <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<CodelistRefType>	codelistRef
protected List<TextType>	description
protected List<HierarchyType>	hierarchy
protected String	id
protected Boolean	isExternalReference
protected Boolean	isFinal
protected List<TextType>	name
protected String	uri
protected String	urn
protected String	validFrom
protected String	validTo
protected String	version

Constructor Summary

HierarchicalCodelistType()

Method Summary

String	getAgencyID() Gets the value of the agencyID property.
AnnotationsType	getAnnotations() Gets the value of the annotations property.
List<CodelistRefType>	getCodelistRef() Gets the value of the codelistRef property.
List<TextType>	getDescription() Gets the value of the description property.
List<HierarchyType>	getHierarchy() Gets the value of the hierarchy property.
String	getId() Gets the value of the id 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

codelistRef

protected List<CodelistRefType> codelistRef

hierarchy

protected List<HierarchyType> hierarchy

annotations

protected AnnotationsType annotations

id

protected String id

agencyID

protected String agencyID

version

protected String version

urn

protected String urn

uri

protected String uri

isExternalReference

protected Boolean isExternalReference

isFinal

protected Boolean isFinal

validFrom

protected String validFrom

validTo

protected String validTo

Constructor Detail

HierarchicalCodelistType

public HierarchicalCodelistType()

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

getCodelistRef

public List<CodelistRefType> getCodelistRef()

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

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

    getCodelistRef().add(newItem);
 

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

getHierarchy

public List<HierarchyType> getHierarchy()

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

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

    getHierarchy().add(newItem);
 

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

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

getAgencyID

public String getAgencyID()

Gets the value of the agencyID property.

Returns:

possible object is String

setAgencyID

public void setAgencyID(String value)

Sets the value of the agencyID 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

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

getUri

public String getUri()

Gets the value of the uri property.

Returns:

possible object is String

setUri

public void setUri(String value)

Sets the value of the uri property.

Parameters:

value - allowed object is String

isIsExternalReference

public Boolean isIsExternalReference()

Gets the value of the isExternalReference property.

Returns:

possible object is Boolean

setIsExternalReference

public void setIsExternalReference(Boolean value)

Sets the value of the isExternalReference property.

Parameters:

value - allowed object is Boolean

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