org.LexGrid.REST.concepts
Class EntityDirectory

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

public class EntityDirectory
extends LexGridBase
implements java.io.Serializable

A directory of a set of terminology entities containing basic information about them.

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

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

EntityDirectory

public EntityDirectory()
Method Detail

addEntry

public void addEntry(EntityDirectoryEntry 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,
                     EntityDirectoryEntry 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 EntityDirectoryEntry> enumerateEntry()
Method enumerateEntry.

Returns:
an Enumeration over all possible elements of this collection

getContinuation

public Continuation getContinuation()
Returns the value of field 'continuation'.

Returns:
the value of field 'Continuation'.

getEntry

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

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

getEntry

public EntityDirectoryEntry[] 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<EntityDirectoryEntry> 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 EntityDirectoryEntry> 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(EntityDirectoryEntry vEntry)
Method removeEntry.

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

removeEntryAt

public EntityDirectoryEntry removeEntryAt(int index)
Method removeEntryAt.

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

setContinuation

public void setContinuation(Continuation continuation)
Sets the value of field 'continuation'.

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

setEntry

public void setEntry(int index,
                     EntityDirectoryEntry 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(EntityDirectoryEntry[] vEntryArray)
Parameters:
vEntryArray -

setEntry

public void setEntry(java.util.List<EntityDirectoryEntry> 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<EntityDirectoryEntry> 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.

unmarshalEntityDirectory

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

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