org.LexGrid.LexBIG.DataModel.Collections
Class AssociatedDataList

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

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

Class AssociatedDataList.

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

Constructor Summary
AssociatedDataList()
           
 
Method Summary
 void addAssociatedData(AssociatedData vAssociatedData)
           
 void addAssociatedData(int index, AssociatedData vAssociatedData)
           
 java.util.Enumeration<? extends AssociatedData> enumerateAssociatedData()
          Method enumerateAssociatedData.
 AssociatedData[] getAssociatedData()
          Method getAssociatedData.Returns the contents of the collection in an Array.
 AssociatedData getAssociatedData(int index)
          Method getAssociatedData.
 int getAssociatedDataCount()
          Method getAssociatedDataCount.
 java.util.Iterator<? extends AssociatedData> iterateAssociatedData()
          Method iterateAssociatedData.
 void removeAllAssociatedData()
           
 boolean removeAssociatedData(AssociatedData vAssociatedData)
          Method removeAssociatedData.
 AssociatedData removeAssociatedDataAt(int index)
          Method removeAssociatedDataAt.
 void setAssociatedData(AssociatedData[] vAssociatedDataArray)
           
 void setAssociatedData(int index, AssociatedData vAssociatedData)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AssociatedDataList

public AssociatedDataList()
Method Detail

addAssociatedData

public void addAssociatedData(AssociatedData vAssociatedData)
                       throws java.lang.IndexOutOfBoundsException
Parameters:
vAssociatedData -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addAssociatedData

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

enumerateAssociatedData

public java.util.Enumeration<? extends AssociatedData> enumerateAssociatedData()
Method enumerateAssociatedData.

Returns:
an Enumeration over all possible elements of this collection

getAssociatedData

public AssociatedData getAssociatedData(int index)
                                 throws java.lang.IndexOutOfBoundsException
Method getAssociatedData.

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

getAssociatedData

public AssociatedData[] getAssociatedData()
Method getAssociatedData.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

getAssociatedDataCount

public int getAssociatedDataCount()
Method getAssociatedDataCount.

Returns:
the size of this collection

iterateAssociatedData

public java.util.Iterator<? extends AssociatedData> iterateAssociatedData()
Method iterateAssociatedData.

Returns:
an Iterator over all possible elements in this collection

removeAllAssociatedData

public void removeAllAssociatedData()

removeAssociatedData

public boolean removeAssociatedData(AssociatedData vAssociatedData)
Method removeAssociatedData.

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

removeAssociatedDataAt

public AssociatedData removeAssociatedDataAt(int index)
Method removeAssociatedDataAt.

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

setAssociatedData

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

setAssociatedData

public void setAssociatedData(AssociatedData[] vAssociatedDataArray)
Parameters:
vAssociatedDataArray -

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.