org.LexGrid.LexOnt
Class CodingSchemeManifestList

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.LexOnt.CodingSchemeManifestList
All Implemented Interfaces:
java.io.Serializable

public class CodingSchemeManifestList
extends LexGridBase
implements java.io.Serializable

Class CodingSchemeManifestList.

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

Constructor Summary
CodingSchemeManifestList()
           
 
Method Summary
 void addEntry(CodingSchemeManifest vEntry)
           
 void addEntry(int index, CodingSchemeManifest vEntry)
           
 java.util.Enumeration<? extends CodingSchemeManifest> enumerateEntry()
          Method enumerateEntry.
 CodingSchemeManifest[] getEntry()
          Method getEntry.Returns the contents of the collection in an Array.
 CodingSchemeManifest getEntry(int index)
          Method getEntry.
 java.util.List<CodingSchemeManifest> getEntryAsReference()
          Method getEntryAsReference.Returns a reference to '_entryList'.
 int getEntryCount()
          Method getEntryCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends CodingSchemeManifest> iterateEntry()
          Method iterateEntry.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllEntry()
           
 boolean removeEntry(CodingSchemeManifest vEntry)
          Method removeEntry.
 CodingSchemeManifest removeEntryAt(int index)
          Method removeEntryAt.
 void setEntry(CodingSchemeManifest[] vEntryArray)
           
 void setEntry(int index, CodingSchemeManifest vEntry)
           
 void setEntry(java.util.List<CodingSchemeManifest> vEntryList)
          Sets the value of '_entryList' by copying the given Vector.
 void setEntryAsReference(java.util.List<CodingSchemeManifest> entryList)
          Deprecated.  
static CodingSchemeManifestList unmarshalCodingSchemeManifestList(java.io.Reader reader)
          Method unmarshalCodingSchemeManifestList.
 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

CodingSchemeManifestList

public CodingSchemeManifestList()
Method Detail

addEntry

public void addEntry(CodingSchemeManifest vEntry)
              throws java.lang.IndexOutOfBoundsException
Parameters:
vEntry -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addEntry

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

enumerateEntry

public java.util.Enumeration<? extends CodingSchemeManifest> enumerateEntry()
Method enumerateEntry.

Returns:
an Enumeration over all possible elements of this collection

getEntry

public CodingSchemeManifest getEntry(int index)
                              throws java.lang.IndexOutOfBoundsException
Method getEntry.

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

getEntry

public CodingSchemeManifest[] getEntry()
Method getEntry.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

getEntryAsReference

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

Returns:
a reference to the Vector backing this class

getEntryCount

public int getEntryCount()
Method getEntryCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

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

iterateEntry

public java.util.Iterator<? extends CodingSchemeManifest> iterateEntry()
Method iterateEntry.

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

removeAllEntry

public void removeAllEntry()

removeEntry

public boolean removeEntry(CodingSchemeManifest vEntry)
Method removeEntry.

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

removeEntryAt

public CodingSchemeManifest removeEntryAt(int index)
Method removeEntryAt.

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

setEntry

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

setEntry

public void setEntry(CodingSchemeManifest[] vEntryArray)
Parameters:
vEntryArray -

setEntry

public void setEntry(java.util.List<CodingSchemeManifest> vEntryList)
Sets the value of '_entryList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vEntryList - the Vector to copy.

setEntryAsReference

public void setEntryAsReference(java.util.List<CodingSchemeManifest> entryList)
Deprecated. 

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

Parameters:
entryList - the Vector to set.

unmarshalCodingSchemeManifestList

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.LexOnt.CodingSchemeManifestList
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.