org.LexGrid.REST.commonTypes
Class LocalNames

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.commonTypes.LocalNames
All Implemented Interfaces:
java.io.Serializable

public class LocalNames
extends LexGridBase
implements java.io.Serializable

A collection of coding scheme names.

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

Constructor Summary
LocalNames()
           
 
Method Summary
 void addLocalName(CodingSchemeName vLocalName)
           
 void addLocalName(int index, CodingSchemeName vLocalName)
           
 java.util.Enumeration<? extends CodingSchemeName> enumerateLocalName()
          Method enumerateLocalName.
 CodingSchemeName[] getLocalName()
          Method getLocalName.Returns the contents of the collection in an Array.
 CodingSchemeName getLocalName(int index)
          Method getLocalName.
 java.util.List<CodingSchemeName> getLocalNameAsReference()
          Method getLocalNameAsReference.Returns a reference to '_localNameList'.
 int getLocalNameCount()
          Method getLocalNameCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends CodingSchemeName> iterateLocalName()
          Method iterateLocalName.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllLocalName()
           
 boolean removeLocalName(CodingSchemeName vLocalName)
          Method removeLocalName.
 CodingSchemeName removeLocalNameAt(int index)
          Method removeLocalNameAt.
 void setLocalName(CodingSchemeName[] vLocalNameArray)
           
 void setLocalName(int index, CodingSchemeName vLocalName)
           
 void setLocalName(java.util.List<CodingSchemeName> vLocalNameList)
          Sets the value of '_localNameList' by copying the given Vector.
 void setLocalNameAsReference(java.util.List<CodingSchemeName> localNameList)
          Deprecated.  
static LocalNames unmarshalLocalNames(java.io.Reader reader)
          Method unmarshalLocalNames.
 void validate()
           
 
Methods inherited from class org.mayo.edu.lgModel.LexGridBase
getParent, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LocalNames

public LocalNames()
Method Detail

addLocalName

public void addLocalName(CodingSchemeName vLocalName)
                  throws java.lang.IndexOutOfBoundsException
Parameters:
vLocalName -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addLocalName

public void addLocalName(int index,
                         CodingSchemeName vLocalName)
                  throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vLocalName -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateLocalName

public java.util.Enumeration<? extends CodingSchemeName> enumerateLocalName()
Method enumerateLocalName.

Returns:
an Enumeration over all possible elements of this collection

getLocalName

public CodingSchemeName getLocalName(int index)
                              throws java.lang.IndexOutOfBoundsException
Method getLocalName.

Parameters:
index -
Returns:
the value of the org.LexGrid.REST.commonTypes.CodingSchemeName at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getLocalName

public CodingSchemeName[] getLocalName()
Method getLocalName.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:
this collection as an Array

getLocalNameAsReference

public java.util.List<CodingSchemeName> getLocalNameAsReference()
Method getLocalNameAsReference.Returns a reference to '_localNameList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getLocalNameCount

public int getLocalNameCount()
Method getLocalNameCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

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

iterateLocalName

public java.util.Iterator<? extends CodingSchemeName> iterateLocalName()
Method iterateLocalName.

Returns:
an Iterator over all possible elements in this collection

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

removeAllLocalName

public void removeAllLocalName()

removeLocalName

public boolean removeLocalName(CodingSchemeName vLocalName)
Method removeLocalName.

Parameters:
vLocalName -
Returns:
true if the object was removed from the collection.

removeLocalNameAt

public CodingSchemeName removeLocalNameAt(int index)
Method removeLocalNameAt.

Parameters:
index -
Returns:
the element removed from the collection

setLocalName

public void setLocalName(int index,
                         CodingSchemeName vLocalName)
                  throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vLocalName -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setLocalName

public void setLocalName(CodingSchemeName[] vLocalNameArray)
Parameters:
vLocalNameArray -

setLocalName

public void setLocalName(java.util.List<CodingSchemeName> vLocalNameList)
Sets the value of '_localNameList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vLocalNameList - the Vector to copy.

setLocalNameAsReference

public void setLocalNameAsReference(java.util.List<CodingSchemeName> localNameList)
Deprecated. 

Sets the value of '_localNameList' by setting it to the given Vector. No type checking is performed.

Parameters:
localNameList - the Vector to set.

unmarshalLocalNames

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.REST.commonTypes.LocalNames
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.