org.LexGrid.LexBIG.DataModel.Collections
Class CodingSchemeSummaryList

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

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

Class CodingSchemeSummaryList.

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

Constructor Summary
CodingSchemeSummaryList()
           
 
Method Summary
 void addCodingSchemeSummary(CodingSchemeSummary vCodingSchemeSummary)
           
 void addCodingSchemeSummary(int index, CodingSchemeSummary vCodingSchemeSummary)
           
 java.util.Enumeration<? extends CodingSchemeSummary> enumerateCodingSchemeSummary()
          Method enumerateCodingSchemeSummary.
 CodingSchemeSummary[] getCodingSchemeSummary()
          Method getCodingSchemeSummary.Returns the contents of the collection in an Array.
 CodingSchemeSummary getCodingSchemeSummary(int index)
          Method getCodingSchemeSummary.
 int getCodingSchemeSummaryCount()
          Method getCodingSchemeSummaryCount.
 java.util.Iterator<? extends CodingSchemeSummary> iterateCodingSchemeSummary()
          Method iterateCodingSchemeSummary.
 void removeAllCodingSchemeSummary()
           
 boolean removeCodingSchemeSummary(CodingSchemeSummary vCodingSchemeSummary)
          Method removeCodingSchemeSummary.
 CodingSchemeSummary removeCodingSchemeSummaryAt(int index)
          Method removeCodingSchemeSummaryAt.
 void setCodingSchemeSummary(CodingSchemeSummary[] vCodingSchemeSummaryArray)
           
 void setCodingSchemeSummary(int index, CodingSchemeSummary vCodingSchemeSummary)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CodingSchemeSummaryList

public CodingSchemeSummaryList()
Method Detail

addCodingSchemeSummary

public void addCodingSchemeSummary(CodingSchemeSummary vCodingSchemeSummary)
                            throws java.lang.IndexOutOfBoundsException
Parameters:
vCodingSchemeSummary -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addCodingSchemeSummary

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

enumerateCodingSchemeSummary

public java.util.Enumeration<? extends CodingSchemeSummary> enumerateCodingSchemeSummary()
Method enumerateCodingSchemeSummary.

Returns:
an Enumeration over all possible elements of this collection

getCodingSchemeSummary

public CodingSchemeSummary getCodingSchemeSummary(int index)
                                           throws java.lang.IndexOutOfBoundsException
Method getCodingSchemeSummary.

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

getCodingSchemeSummary

public CodingSchemeSummary[] getCodingSchemeSummary()
Method getCodingSchemeSummary.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

getCodingSchemeSummaryCount

public int getCodingSchemeSummaryCount()
Method getCodingSchemeSummaryCount.

Returns:
the size of this collection

iterateCodingSchemeSummary

public java.util.Iterator<? extends CodingSchemeSummary> iterateCodingSchemeSummary()
Method iterateCodingSchemeSummary.

Returns:
an Iterator over all possible elements in this collection

removeAllCodingSchemeSummary

public void removeAllCodingSchemeSummary()

removeCodingSchemeSummary

public boolean removeCodingSchemeSummary(CodingSchemeSummary vCodingSchemeSummary)
Method removeCodingSchemeSummary.

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

removeCodingSchemeSummaryAt

public CodingSchemeSummary removeCodingSchemeSummaryAt(int index)
Method removeCodingSchemeSummaryAt.

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

setCodingSchemeSummary

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

setCodingSchemeSummary

public void setCodingSchemeSummary(CodingSchemeSummary[] vCodingSchemeSummaryArray)
Parameters:
vCodingSchemeSummaryArray -

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.