org.LexGrid.valueDomains
Class CodingSchemeReference

java.lang.Object
  extended by org.LexGrid.valueDomains.CodingSchemeReference
All Implemented Interfaces:
java.io.Serializable

public class CodingSchemeReference
extends java.lang.Object
implements java.io.Serializable

A reference to all of the entity codes in a given coding scheme.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
CodingSchemeReference()
           
 
Method Summary
 java.lang.String getCodingScheme()
          Returns the value of field 'codingScheme'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setCodingScheme(java.lang.String codingScheme)
          Sets the value of field 'codingScheme'.
static CodingSchemeReference unmarshalCodingSchemeReference(java.io.Reader reader)
          Method unmarshalCodingSchemeReference.
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CodingSchemeReference

public CodingSchemeReference()
Method Detail

getCodingScheme

public java.lang.String getCodingScheme()
Returns the value of field 'codingScheme'. The field 'codingScheme' has the following description: The local identifier of the coding scheme that the entity codes are drawn from . codingSchemeName must match a local id of a supportedCodingScheme in the mappings section.

Returns:
the value of field 'CodingScheme'.

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
handler -
Throws:
java.io.IOException - if an IOException occurs during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setCodingScheme

public void setCodingScheme(java.lang.String codingScheme)
Sets the value of field 'codingScheme'. The field 'codingScheme' has the following description: The local identifier of the coding scheme that the entity codes are drawn from . codingSchemeName must match a local id of a supportedCodingScheme in the mappings section.

Parameters:
codingScheme - the value of field 'codingScheme'.

unmarshalCodingSchemeReference

public static CodingSchemeReference unmarshalCodingSchemeReference(java.io.Reader reader)
                                                            throws org.exolab.castor.xml.MarshalException,
                                                                   org.exolab.castor.xml.ValidationException
Method unmarshalCodingSchemeReference.

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.valueDomains.CodingSchemeReference
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Throws:
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.