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

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

public class CodeRefType
extends Object

The CodeRefType provides the structure for a codelist reference. At a minimum, either a URN value (a valid SDMX Registry URN as specified in teh SDMX Registry Specification) must be supplied, or a ColdelistAliasRef and a CodeID must be specified. CodelistAliasRef references an alias assigned in a CodelistRef element in the containing hierarchical codelist.CodeRef references a code from the codelist identified at the level of the parent hierarchical codelist. Codes are arranged in a hierarchy by 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 levelled one. CodeID holds the ID of the code in the codelist referenced by the hierarchical codelist. CodeRef references a code. LevelRef holds the id of a Level described in the same parent Hierarchical Codelist. NodeAliasID allows for an ID to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures. Version holds the version number of the referenced code, to support management of complex hierarchies. Along with this field are the ValidFrom and ValidTo dates, which are inclusive dates during which the code is valid within the parent hierarchy.

Java class for CodeRefType complex type.

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

 <complexType name="CodeRefType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="URN" type="{http://www.w3.org/2001/XMLSchema}anyURI" minOccurs="0"/>
         <element name="CodelistAliasRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" minOccurs="0"/>
         <element name="CodeID" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" minOccurs="0"/>
         <element name="CodeRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}CodeRefType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="LevelRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" minOccurs="0"/>
         <element name="NodeAliasID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Version" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ValidFrom" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" minOccurs="0"/>
         <element name="ValidTo" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected String	codeID
protected String	codelistAliasRef
protected List<CodeRefType>	codeRef
protected String	levelRef
protected String	nodeAliasID
protected String	urn
protected String	validFrom
protected String	validTo
protected String	version

Constructor Summary

CodeRefType()

Method Summary

String	getCodeID() Gets the value of the codeID property.
String	getCodelistAliasRef() Gets the value of the codelistAliasRef property.
List<CodeRefType>	getCodeRef() Gets the value of the codeRef property.
String	getLevelRef() Gets the value of the levelRef property.
String	getNodeAliasID() Gets the value of the nodeAliasID 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.
void	setCodeID(String value) Sets the value of the codeID property.
void	setCodelistAliasRef(String value) Sets the value of the codelistAliasRef property.
void	setLevelRef(String value) Sets the value of the levelRef property.
void	setNodeAliasID(String value) Sets the value of the nodeAliasID 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

urn

protected String urn

codelistAliasRef

protected String codelistAliasRef

codeID

protected String codeID

codeRef

protected List<CodeRefType> codeRef

levelRef

protected String levelRef

nodeAliasID

protected String nodeAliasID

version

protected String version

validFrom

protected String validFrom

validTo

protected String validTo

Constructor Detail

CodeRefType

public CodeRefType()

Method Detail

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

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 String getCodeID()

Gets the value of the codeID property.

Returns:

possible object is String

setCodeID

public void setCodeID(String value)

Sets the value of the codeID property.

Parameters:

value - allowed object is String

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

getLevelRef

public String getLevelRef()

Gets the value of the levelRef property.

Returns:

possible object is String

setLevelRef

public void setLevelRef(String value)

Sets the value of the levelRef property.

Parameters:

value - allowed object is String

getNodeAliasID

public String getNodeAliasID()

Gets the value of the nodeAliasID property.

Returns:

possible object is String

setNodeAliasID

public void setNodeAliasID(String value)

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

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