org.LexGrid.LexBIG.DataModel.Collections
Class CodedNodeReferenceList

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

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

Class CodedNodeReferenceList.

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

Constructor Summary
CodedNodeReferenceList()
           
 
Method Summary
 void addCodedNodeReference(CodedNodeReference vCodedNodeReference)
           
 void addCodedNodeReference(int index, CodedNodeReference vCodedNodeReference)
           
 java.util.Enumeration<? extends CodedNodeReference> enumerateCodedNodeReference()
          Method enumerateCodedNodeReference.
 CodedNodeReference[] getCodedNodeReference()
          Method getCodedNodeReference.Returns the contents of the collection in an Array.
 CodedNodeReference getCodedNodeReference(int index)
          Method getCodedNodeReference.
 int getCodedNodeReferenceCount()
          Method getCodedNodeReferenceCount.
 java.util.Iterator<? extends CodedNodeReference> iterateCodedNodeReference()
          Method iterateCodedNodeReference.
 void removeAllCodedNodeReference()
           
 boolean removeCodedNodeReference(CodedNodeReference vCodedNodeReference)
          Method removeCodedNodeReference.
 CodedNodeReference removeCodedNodeReferenceAt(int index)
          Method removeCodedNodeReferenceAt.
 void setCodedNodeReference(CodedNodeReference[] vCodedNodeReferenceArray)
           
 void setCodedNodeReference(int index, CodedNodeReference vCodedNodeReference)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CodedNodeReferenceList

public CodedNodeReferenceList()
Method Detail

addCodedNodeReference

public void addCodedNodeReference(CodedNodeReference vCodedNodeReference)
                           throws java.lang.IndexOutOfBoundsException
Parameters:
vCodedNodeReference -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addCodedNodeReference

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

enumerateCodedNodeReference

public java.util.Enumeration<? extends CodedNodeReference> enumerateCodedNodeReference()
Method enumerateCodedNodeReference.

Returns:
an Enumeration over all possible elements of this collection

getCodedNodeReference

public CodedNodeReference getCodedNodeReference(int index)
                                         throws java.lang.IndexOutOfBoundsException
Method getCodedNodeReference.

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

getCodedNodeReference

public CodedNodeReference[] getCodedNodeReference()
Method getCodedNodeReference.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

getCodedNodeReferenceCount

public int getCodedNodeReferenceCount()
Method getCodedNodeReferenceCount.

Returns:
the size of this collection

iterateCodedNodeReference

public java.util.Iterator<? extends CodedNodeReference> iterateCodedNodeReference()
Method iterateCodedNodeReference.

Returns:
an Iterator over all possible elements in this collection

removeAllCodedNodeReference

public void removeAllCodedNodeReference()

removeCodedNodeReference

public boolean removeCodedNodeReference(CodedNodeReference vCodedNodeReference)
Method removeCodedNodeReference.

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

removeCodedNodeReferenceAt

public CodedNodeReference removeCodedNodeReferenceAt(int index)
Method removeCodedNodeReferenceAt.

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

setCodedNodeReference

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

setCodedNodeReference

public void setCodedNodeReference(CodedNodeReference[] vCodedNodeReferenceArray)
Parameters:
vCodedNodeReferenceArray -

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.