org.jembi.sdmxhd.primitives
Class CodeList

java.lang.Object
  extended by org.jembi.sdmxhd.primitives.CodeList
All Implemented Interfaces:
XMLWritable

public class CodeList
extends java.lang.Object
implements XMLWritable

This object represents a codelist structure, it stores localized name and description of the codelist along with additional information that makes up the codelist


Constructor Summary
CodeList()
           
 
Method Summary
 java.lang.String getAgencyID()
           
 Code getCodeByDescription(java.lang.String description)
          Find a code with a description that matches the supplied description.
 Code getCodeByID(java.lang.String id)
          Gets a code by it id
 java.util.Set<Code> getCodes()
           
 LocalizedString getDescription()
           
 java.lang.String getId()
           
 java.lang.String getIsExternalReference()
           
 java.lang.String getIsFinal()
           
 LocalizedString getName()
           
 java.lang.String getUri()
           
 java.lang.String getUrn()
           
 java.lang.String getValidFrom()
           
 java.lang.String getValidTo()
           
 java.lang.String getVersion()
           
 void setAgencyID(java.lang.String agencyID)
           
 void setCodes(java.util.Set<Code> codes)
           
 void setDescription(LocalizedString description)
           
 void setId(java.lang.String id)
           
 void setIsExternalReference(java.lang.String isExternalReference)
           
 void setIsFinal(java.lang.String isFinal)
           
 void setName(LocalizedString name)
           
 void setUri(java.lang.String uri)
           
 void setUrn(java.lang.String urn)
           
 void setValidFrom(java.lang.String validFrom)
           
 void setValidTo(java.lang.String validTo)
           
 void setVersion(java.lang.String version)
           
 void toXML(javax.xml.stream.XMLStreamWriter xmlWriter)
          Writes this object to the xmlStream writer in SDMX-HD XML representation
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CodeList

public CodeList()
Method Detail

toXML

public void toXML(javax.xml.stream.XMLStreamWriter xmlWriter)
           throws java.lang.Exception
Description copied from interface: XMLWritable
Writes this object to the xmlStream writer in SDMX-HD XML representation

Specified by:
toXML in interface XMLWritable
Throws:
java.lang.Exception

getCodeByDescription

public Code getCodeByDescription(java.lang.String description)
Find a code with a description that matches the supplied description.

Parameters:
description - the description for the required code
Returns:
the found code or null if not found

getCodeByID

public Code getCodeByID(java.lang.String id)
Gets a code by it id

Parameters:
id - the code id
Returns:
the code with the specified id

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getCodes

public java.util.Set<Code> getCodes()

setCodes

public void setCodes(java.util.Set<Code> codes)

getAgencyID

public java.lang.String getAgencyID()

setAgencyID

public void setAgencyID(java.lang.String agencyID)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getName

public LocalizedString getName()

setName

public void setName(LocalizedString name)

getDescription

public LocalizedString getDescription()

setDescription

public void setDescription(LocalizedString description)

getUri

public java.lang.String getUri()

setUri

public void setUri(java.lang.String uri)

getUrn

public java.lang.String getUrn()

setUrn

public void setUrn(java.lang.String urn)

getIsExternalReference

public java.lang.String getIsExternalReference()

setIsExternalReference

public void setIsExternalReference(java.lang.String isExternalReference)

getIsFinal

public java.lang.String getIsFinal()

setIsFinal

public void setIsFinal(java.lang.String isFinal)

getValidFrom

public java.lang.String getValidFrom()

setValidFrom

public void setValidFrom(java.lang.String validFrom)

getValidTo

public java.lang.String getValidTo()

setValidTo

public void setValidTo(java.lang.String validTo)