org.sdmx.resources.sdmxml.schemas.v2_1.structure
Class HierarchicalCodeType

java.lang.Object
  org.sdmx.resources.sdmxml.schemas.v2_1.common.AnnotableType
      org.sdmx.resources.sdmxml.schemas.v2_1.structure.IdentifiableType
          org.sdmx.resources.sdmxml.schemas.v2_1.structure.HierarchicalCodeBaseType
              org.sdmx.resources.sdmxml.schemas.v2_1.structure.HierarchicalCodeType

public class HierarchicalCodeType
extends HierarchicalCodeBaseType

HierarchicalCodeType describes the structure of a hierarchical code. A hierarchical code provides for a reference to a code that is referenced within the hierarchical code list via either a complete reference to a code through either a URN or full set of reference fields, or a local reference which utilizes the included codelist reference alias and the identification of a code from the list. Codes are arranged in a hierarchy by this reference. Note that it is possible to reference a single code such that it has multiple parents within the hierarchy. Further, the hierarchy may or may not be a leveled one.

Java class for HierarchicalCodeType complex type.

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

 <complexType name="HierarchicalCodeType">
   <complexContent>
     <extension base="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/structure}HierarchicalCodeBaseType">
       <sequence>
         <choice>
           <element name="Code" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}CodeReferenceType"/>
           <sequence>
             <element name="CodelistAliasRef" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}IDType"/>
             <element name="CodeID" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}LocalCodeReferenceType"/>
           </sequence>
         </choice>
         <element name="HierarchicalCode" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/structure}HierarchicalCodeType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Level" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}LocalLevelReferenceType" minOccurs="0"/>
       </sequence>
       <attribute name="version" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}VersionType" />
       <attribute name="validFrom" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
       <attribute name="validTo" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

protected CodeReferenceType	code
protected LocalCodeReferenceType	codeID
protected String	codelistAliasRef
protected List<HierarchicalCodeType>	hierarchicalCode
protected LocalLevelReferenceType	level
protected XMLGregorianCalendar	validFrom
protected XMLGregorianCalendar	validTo
protected String	version

Fields inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.structure.IdentifiableType

id, uri, urn

Fields inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.common.AnnotableType

annotations

Constructor Summary

HierarchicalCodeType()

Method Summary

CodeReferenceType	getCode() Gets the value of the code property.
LocalCodeReferenceType	getCodeID() Gets the value of the codeID property.
String	getCodelistAliasRef() Gets the value of the codelistAliasRef property.
List<HierarchicalCodeType>	getHierarchicalCode() Gets the value of the hierarchicalCode property.
LocalLevelReferenceType	getLevel() Gets the value of the level property.
XMLGregorianCalendar	getValidFrom() Gets the value of the validFrom property.
XMLGregorianCalendar	getValidTo() Gets the value of the validTo property.
String	getVersion() Gets the value of the version property.
void	setCode(CodeReferenceType value) Sets the value of the code property.
void	setCodeID(LocalCodeReferenceType value) Sets the value of the codeID property.
void	setCodelistAliasRef(String value) Sets the value of the codelistAliasRef property.
void	setLevel(LocalLevelReferenceType value) Sets the value of the level property.
void	setValidFrom(XMLGregorianCalendar value) Sets the value of the validFrom property.
void	setValidTo(XMLGregorianCalendar value) Sets the value of the validTo property.
void	setVersion(String value) Sets the value of the version property.

Methods inherited from class org.sdmx.resources.sdmxml.schemas.v2_1.structure.IdentifiableType

getId, getUri, getUrn, setId, setUri, setUrn

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

code

protected CodeReferenceType code

codelistAliasRef

protected String codelistAliasRef

codeID

protected LocalCodeReferenceType codeID

hierarchicalCode

protected List<HierarchicalCodeType> hierarchicalCode

level

protected LocalLevelReferenceType level

version

protected String version

validFrom

protected XMLGregorianCalendar validFrom

validTo

protected XMLGregorianCalendar validTo

Constructor Detail

HierarchicalCodeType

public HierarchicalCodeType()

Method Detail

getCode

public CodeReferenceType getCode()

Gets the value of the code property.

Returns:

possible object is CodeReferenceType

setCode

public void setCode(CodeReferenceType value)

Sets the value of the code property.

Parameters:

value - allowed object is CodeReferenceType

getCodelistAliasRef

public String getCodelistAliasRef()

Gets the value of the codelistAliasRef property.

Returns:

possible object is String

setCodelistAliasRef

public void setCodelistAliasRef(String value)

Sets the value of the codelistAliasRef property.

Parameters:

value - allowed object is String

getCodeID

public LocalCodeReferenceType getCodeID()

Gets the value of the codeID property.

Returns:

possible object is LocalCodeReferenceType

setCodeID

public void setCodeID(LocalCodeReferenceType value)

Sets the value of the codeID property.

Parameters:

value - allowed object is LocalCodeReferenceType

getHierarchicalCode

public List<HierarchicalCodeType> getHierarchicalCode()

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

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

    getHierarchicalCode().add(newItem);
 

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

getLevel

public LocalLevelReferenceType getLevel()

Gets the value of the level property.

Returns:

possible object is LocalLevelReferenceType

setLevel

public void setLevel(LocalLevelReferenceType value)

Sets the value of the level property.

Parameters:

value - allowed object is LocalLevelReferenceType

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

getValidFrom

public XMLGregorianCalendar getValidFrom()

Gets the value of the validFrom property.

Returns:

possible object is XMLGregorianCalendar

setValidFrom

public void setValidFrom(XMLGregorianCalendar value)

Sets the value of the validFrom property.

Parameters:

value - allowed object is XMLGregorianCalendar

getValidTo

public XMLGregorianCalendar getValidTo()

Gets the value of the validTo property.

Returns:

possible object is XMLGregorianCalendar

setValidTo

public void setValidTo(XMLGregorianCalendar value)

Sets the value of the validTo property.

Parameters:

value - allowed object is XMLGregorianCalendar