org.LexGrid.LexBIG.DataModel.Collections
Class ConceptReferenceList

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

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

Class ConceptReferenceList.

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

Constructor Summary
ConceptReferenceList()
           
 
Method Summary
 void addConceptReference(ConceptReference vConceptReference)
           
 void addConceptReference(int index, ConceptReference vConceptReference)
           
 java.util.Enumeration<? extends ConceptReference> enumerateConceptReference()
          Method enumerateConceptReference.
 ConceptReference[] getConceptReference()
          Method getConceptReference.Returns the contents of the collection in an Array.
 ConceptReference getConceptReference(int index)
          Method getConceptReference.
 int getConceptReferenceCount()
          Method getConceptReferenceCount.
 java.util.Iterator<? extends ConceptReference> iterateConceptReference()
          Method iterateConceptReference.
 void removeAllConceptReference()
           
 boolean removeConceptReference(ConceptReference vConceptReference)
          Method removeConceptReference.
 ConceptReference removeConceptReferenceAt(int index)
          Method removeConceptReferenceAt.
 void setConceptReference(ConceptReference[] vConceptReferenceArray)
           
 void setConceptReference(int index, ConceptReference vConceptReference)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConceptReferenceList

public ConceptReferenceList()
Method Detail

addConceptReference

public void addConceptReference(ConceptReference vConceptReference)
                         throws java.lang.IndexOutOfBoundsException
Parameters:
vConceptReference -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addConceptReference

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

enumerateConceptReference

public java.util.Enumeration<? extends ConceptReference> enumerateConceptReference()
Method enumerateConceptReference.

Returns:
an Enumeration over all possible elements of this collection

getConceptReference

public ConceptReference getConceptReference(int index)
                                     throws java.lang.IndexOutOfBoundsException
Method getConceptReference.

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

getConceptReference

public ConceptReference[] getConceptReference()
Method getConceptReference.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

getConceptReferenceCount

public int getConceptReferenceCount()
Method getConceptReferenceCount.

Returns:
the size of this collection

iterateConceptReference

public java.util.Iterator<? extends ConceptReference> iterateConceptReference()
Method iterateConceptReference.

Returns:
an Iterator over all possible elements in this collection

removeAllConceptReference

public void removeAllConceptReference()

removeConceptReference

public boolean removeConceptReference(ConceptReference vConceptReference)
Method removeConceptReference.

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

removeConceptReferenceAt

public ConceptReference removeConceptReferenceAt(int index)
Method removeConceptReferenceAt.

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

setConceptReference

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

setConceptReference

public void setConceptReference(ConceptReference[] vConceptReferenceArray)
Parameters:
vConceptReferenceArray -

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.