org.LexGrid.LexBIG.DataModel.Collections
Class CodingSchemeTagList

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

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

Class CodingSchemeTagList.

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

Constructor Summary
CodingSchemeTagList()
           
 
Method Summary
 void addTag(int index, java.lang.String vTag)
           
 void addTag(java.lang.String vTag)
           
 java.util.Enumeration<? extends java.lang.String> enumerateTag()
          Method enumerateTag.
 java.lang.String[] getTag()
          Method getTag.Returns the contents of the collection in an Array.
 java.lang.String getTag(int index)
          Method getTag.
 int getTagCount()
          Method getTagCount.
 java.util.Iterator<? extends java.lang.String> iterateTag()
          Method iterateTag.
 void removeAllTag()
           
 boolean removeTag(java.lang.String vTag)
          Method removeTag.
 java.lang.String removeTagAt(int index)
          Method removeTagAt.
 void setTag(int index, java.lang.String vTag)
           
 void setTag(java.lang.String[] vTagArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CodingSchemeTagList

public CodingSchemeTagList()
Method Detail

addTag

public void addTag(java.lang.String vTag)
            throws java.lang.IndexOutOfBoundsException
Parameters:
vTag -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addTag

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

enumerateTag

public java.util.Enumeration<? extends java.lang.String> enumerateTag()
Method enumerateTag.

Returns:
an Enumeration over all possible elements of this collection

getTag

public java.lang.String getTag(int index)
                        throws java.lang.IndexOutOfBoundsException
Method getTag.

Parameters:
index -
Returns:
the value of the java.lang.String at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getTag

public java.lang.String[] getTag()
Method getTag.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

getTagCount

public int getTagCount()
Method getTagCount.

Returns:
the size of this collection

iterateTag

public java.util.Iterator<? extends java.lang.String> iterateTag()
Method iterateTag.

Returns:
an Iterator over all possible elements in this collection

removeAllTag

public void removeAllTag()

removeTag

public boolean removeTag(java.lang.String vTag)
Method removeTag.

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

removeTagAt

public java.lang.String removeTagAt(int index)
Method removeTagAt.

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

setTag

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

setTag

public void setTag(java.lang.String[] vTagArray)
Parameters:
vTagArray -

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.