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

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

public class CodelistMapType
extends Object

CodelistMap allows the description of how the codes in a codelist are represented in a target codelist or associated hierarchical codelist. A human-readable Name is provided, and a longer, human-readable description may be provided as well, in the Name and Description elements respectively. These may be supplied in multiple, language-specific versions.CodelistRef references the codelist or hierarchical codelist being mapped; TargetCodelistRef indicates the codelist to which it will be mapped. CodeMap is the element which indicates the equivalence of codes in the referenced codelist to those in the target codelist. Any codes not mapped are assumed to lack equivalence. The CodelistMap may be annotated using the Annotations element. The id attribute is used to assign an identifier which is unique within the StructureSet for all CodelistMaps.

Java class for CodelistMapType complex type.

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

 <complexType name="CodelistMapType">
   <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"/>
         <choice>
           <element name="CodelistRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}CodelistRefType"/>
           <element name="HierarchicalCodelistRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}HierarchicalCodelistRefType"/>
         </choice>
         <choice>
           <element name="TargetCodelistRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}CodelistRefType"/>
           <element name="TargetHierarchicalCodelistRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}HierarchicalCodelistRefType"/>
         </choice>
         <element name="CodeMap" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}CodeMapType" maxOccurs="unbounded"/>
         <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" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected AnnotationsType	annotations
protected CodelistRefType	codelistRef
protected List<CodeMapType>	codeMap
protected List<TextType>	description
protected HierarchicalCodelistRefType	hierarchicalCodelistRef
protected String	id
protected List<TextType>	name
protected CodelistRefType	targetCodelistRef
protected HierarchicalCodelistRefType	targetHierarchicalCodelistRef

Constructor Summary

CodelistMapType()

Method Summary

AnnotationsType	getAnnotations() Gets the value of the annotations property.
CodelistRefType	getCodelistRef() Gets the value of the codelistRef property.
List<CodeMapType>	getCodeMap() Gets the value of the codeMap property.
List<TextType>	getDescription() Gets the value of the description property.
HierarchicalCodelistRefType	getHierarchicalCodelistRef() Gets the value of the hierarchicalCodelistRef property.
String	getId() Gets the value of the id property.
List<TextType>	getName() Gets the value of the name property.
CodelistRefType	getTargetCodelistRef() Gets the value of the targetCodelistRef property.
HierarchicalCodelistRefType	getTargetHierarchicalCodelistRef() Gets the value of the targetHierarchicalCodelistRef property.
void	setAnnotations(AnnotationsType value) Sets the value of the annotations property.
void	setCodelistRef(CodelistRefType value) Sets the value of the codelistRef property.
void	setHierarchicalCodelistRef(HierarchicalCodelistRefType value) Sets the value of the hierarchicalCodelistRef property.
void	setId(String value) Sets the value of the id property.
void	setTargetCodelistRef(CodelistRefType value) Sets the value of the targetCodelistRef property.
void	setTargetHierarchicalCodelistRef(HierarchicalCodelistRefType value) Sets the value of the targetHierarchicalCodelistRef 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 CodelistRefType codelistRef

hierarchicalCodelistRef

protected HierarchicalCodelistRefType hierarchicalCodelistRef

targetCodelistRef

protected CodelistRefType targetCodelistRef

targetHierarchicalCodelistRef

protected HierarchicalCodelistRefType targetHierarchicalCodelistRef

codeMap

protected List<CodeMapType> codeMap

annotations

protected AnnotationsType annotations

id

protected String id

Constructor Detail

CodelistMapType

public CodelistMapType()

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 CodelistRefType getCodelistRef()

Gets the value of the codelistRef property.

Returns:

possible object is CodelistRefType

setCodelistRef

public void setCodelistRef(CodelistRefType value)

Sets the value of the codelistRef property.

Parameters:

value - allowed object is CodelistRefType

getHierarchicalCodelistRef

public HierarchicalCodelistRefType getHierarchicalCodelistRef()

Gets the value of the hierarchicalCodelistRef property.

Returns:

possible object is HierarchicalCodelistRefType

setHierarchicalCodelistRef

public void setHierarchicalCodelistRef(HierarchicalCodelistRefType value)

Sets the value of the hierarchicalCodelistRef property.

Parameters:

value - allowed object is HierarchicalCodelistRefType

getTargetCodelistRef

public CodelistRefType getTargetCodelistRef()

Gets the value of the targetCodelistRef property.

Returns:

possible object is CodelistRefType

setTargetCodelistRef

public void setTargetCodelistRef(CodelistRefType value)

Sets the value of the targetCodelistRef property.

Parameters:

value - allowed object is CodelistRefType

getTargetHierarchicalCodelistRef

public HierarchicalCodelistRefType getTargetHierarchicalCodelistRef()

Gets the value of the targetHierarchicalCodelistRef property.

Returns:

possible object is HierarchicalCodelistRefType

setTargetHierarchicalCodelistRef

public void setTargetHierarchicalCodelistRef(HierarchicalCodelistRefType value)

Sets the value of the targetHierarchicalCodelistRef property.

Parameters:

value - allowed object is HierarchicalCodelistRefType

getCodeMap

public List<CodeMapType> getCodeMap()

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

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

    getCodeMap().add(newItem);
 

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

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