org.LexGrid.LexBIG.DataModel.Collections
Class AssociationList

java.lang.Object
  extended by org.LexGrid.LexBIG.DataModel.Collections.AssociationList
All Implemented Interfaces:
java.io.Serializable

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

Class AssociationList.

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

Constructor Summary
AssociationList()
           
 
Method Summary
 void addAssociation(Association vAssociation)
           
 void addAssociation(int index, Association vAssociation)
           
 java.util.Enumeration<Association> enumerateAssociation()
          Method enumerateAssociation.
 Association[] getAssociation()
          Method getAssociation.Returns the contents of the collection in an Array.
 Association getAssociation(int index)
          Method getAssociation.
 int getAssociationCount()
          Method getAssociationCount.
 java.util.Iterator<Association> iterateAssociation()
          Method iterateAssociation.
 void removeAllAssociation()
           
 boolean removeAssociation(Association vAssociation)
          Method removeAssociation.
 Association removeAssociationAt(int index)
          Method removeAssociationAt.
 void setAssociation(Association[] vAssociationArray)
           
 void setAssociation(int index, Association vAssociation)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AssociationList

public AssociationList()
Method Detail

addAssociation

public void addAssociation(Association vAssociation)
                    throws java.lang.IndexOutOfBoundsException
Parameters:
vAssociation -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addAssociation

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

enumerateAssociation

public java.util.Enumeration<Association> enumerateAssociation()
Method enumerateAssociation.

Returns:
an Enumeration over all possible elements of this collection

getAssociation

public Association getAssociation(int index)
                           throws java.lang.IndexOutOfBoundsException
Method getAssociation.

Parameters:
index -
Returns:
the value of the org.LexGrid.LexBIG.DataModel.Core.Association at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getAssociation

public Association[] getAssociation()
Method getAssociation.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

getAssociationCount

public int getAssociationCount()
Method getAssociationCount.

Returns:
the size of this collection

iterateAssociation

public java.util.Iterator<Association> iterateAssociation()
Method iterateAssociation.

Returns:
an Iterator over all possible elements in this collection

removeAllAssociation

public void removeAllAssociation()

removeAssociation

public boolean removeAssociation(Association vAssociation)
Method removeAssociation.

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

removeAssociationAt

public Association removeAssociationAt(int index)
Method removeAssociationAt.

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

setAssociation

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

setAssociation

public void setAssociation(Association[] vAssociationArray)
Parameters:
vAssociationArray -

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.