org.LexGrid.REST.relations
Class AssociationEntrySet

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

public class AssociationEntrySet
extends LexGridBase
implements java.io.Serializable

Class AssociationEntrySet.

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

Constructor Summary
AssociationEntrySet()
           
 
Method Summary
 void addAssociationEntry(AssociationEntry vAssociationEntry)
           
 void addAssociationEntry(int index, AssociationEntry vAssociationEntry)
           
 java.util.Enumeration<? extends AssociationEntry> enumerateAssociationEntry()
          Method enumerateAssociationEntry.
 AssociationEntry[] getAssociationEntry()
          Method getAssociationEntry.Returns the contents of the collection in an Array.
 AssociationEntry getAssociationEntry(int index)
          Method getAssociationEntry.
 java.util.List<AssociationEntry> getAssociationEntryAsReference()
          Method getAssociationEntryAsReference.Returns a reference to '_associationEntryList'.
 int getAssociationEntryCount()
          Method getAssociationEntryCount.
 Continuation getContinuation()
          Returns the value of field 'continuation'.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends AssociationEntry> iterateAssociationEntry()
          Method iterateAssociationEntry.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllAssociationEntry()
           
 boolean removeAssociationEntry(AssociationEntry vAssociationEntry)
          Method removeAssociationEntry.
 AssociationEntry removeAssociationEntryAt(int index)
          Method removeAssociationEntryAt.
 void setAssociationEntry(AssociationEntry[] vAssociationEntryArray)
           
 void setAssociationEntry(int index, AssociationEntry vAssociationEntry)
           
 void setAssociationEntry(java.util.List<AssociationEntry> vAssociationEntryList)
          Sets the value of '_associationEntryList' by copying the given Vector.
 void setAssociationEntryAsReference(java.util.List<AssociationEntry> associationEntryList)
          Deprecated.  
 void setContinuation(Continuation continuation)
          Sets the value of field 'continuation'.
static AssociationEntrySet unmarshalAssociationEntrySet(java.io.Reader reader)
          Method unmarshalAssociationEntrySet.
 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

AssociationEntrySet

public AssociationEntrySet()
Method Detail

addAssociationEntry

public void addAssociationEntry(AssociationEntry vAssociationEntry)
                         throws java.lang.IndexOutOfBoundsException
Parameters:
vAssociationEntry -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addAssociationEntry

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

enumerateAssociationEntry

public java.util.Enumeration<? extends AssociationEntry> enumerateAssociationEntry()
Method enumerateAssociationEntry.

Returns:
an Enumeration over all possible elements of this collection

getAssociationEntry

public AssociationEntry getAssociationEntry(int index)
                                     throws java.lang.IndexOutOfBoundsException
Method getAssociationEntry.

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

getAssociationEntry

public AssociationEntry[] getAssociationEntry()
Method getAssociationEntry.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

getAssociationEntryAsReference

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

Returns:
a reference to the Vector backing this class

getAssociationEntryCount

public int getAssociationEntryCount()
Method getAssociationEntryCount.

Returns:
the size of this collection

getContinuation

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

Returns:
the value of field 'Continuation'.

isValid

public boolean isValid()
Method isValid.

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

iterateAssociationEntry

public java.util.Iterator<? extends AssociationEntry> iterateAssociationEntry()
Method iterateAssociationEntry.

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

removeAllAssociationEntry

public void removeAllAssociationEntry()

removeAssociationEntry

public boolean removeAssociationEntry(AssociationEntry vAssociationEntry)
Method removeAssociationEntry.

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

removeAssociationEntryAt

public AssociationEntry removeAssociationEntryAt(int index)
Method removeAssociationEntryAt.

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

setAssociationEntry

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

setAssociationEntry

public void setAssociationEntry(AssociationEntry[] vAssociationEntryArray)
Parameters:
vAssociationEntryArray -

setAssociationEntry

public void setAssociationEntry(java.util.List<AssociationEntry> vAssociationEntryList)
Sets the value of '_associationEntryList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vAssociationEntryList - the Vector to copy.

setAssociationEntryAsReference

public void setAssociationEntryAsReference(java.util.List<AssociationEntry> associationEntryList)
Deprecated. 

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

Parameters:
associationEntryList - the Vector to set.

setContinuation

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

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

unmarshalAssociationEntrySet

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

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