org.LexGrid.LexBIG.DataModel.Collections
Class MetadataPropertyList

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

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

Class MetadataPropertyList.

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

Constructor Summary
MetadataPropertyList()
           
 
Method Summary
 void addMetadataProperty(int index, MetadataProperty vMetadataProperty)
           
 void addMetadataProperty(MetadataProperty vMetadataProperty)
           
 java.util.Enumeration<? extends MetadataProperty> enumerateMetadataProperty()
          Method enumerateMetadataProperty.
 MetadataProperty[] getMetadataProperty()
          Method getMetadataProperty.Returns the contents of the collection in an Array.
 MetadataProperty getMetadataProperty(int index)
          Method getMetadataProperty.
 int getMetadataPropertyCount()
          Method getMetadataPropertyCount.
 java.util.Iterator<? extends MetadataProperty> iterateMetadataProperty()
          Method iterateMetadataProperty.
 void removeAllMetadataProperty()
           
 boolean removeMetadataProperty(MetadataProperty vMetadataProperty)
          Method removeMetadataProperty.
 MetadataProperty removeMetadataPropertyAt(int index)
          Method removeMetadataPropertyAt.
 void setMetadataProperty(int index, MetadataProperty vMetadataProperty)
           
 void setMetadataProperty(MetadataProperty[] vMetadataPropertyArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MetadataPropertyList

public MetadataPropertyList()
Method Detail

addMetadataProperty

public void addMetadataProperty(MetadataProperty vMetadataProperty)
                         throws java.lang.IndexOutOfBoundsException
Parameters:
vMetadataProperty -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addMetadataProperty

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

enumerateMetadataProperty

public java.util.Enumeration<? extends MetadataProperty> enumerateMetadataProperty()
Method enumerateMetadataProperty.

Returns:
an Enumeration over all possible elements of this collection

getMetadataProperty

public MetadataProperty getMetadataProperty(int index)
                                     throws java.lang.IndexOutOfBoundsException
Method getMetadataProperty.

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

getMetadataProperty

public MetadataProperty[] getMetadataProperty()
Method getMetadataProperty.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

getMetadataPropertyCount

public int getMetadataPropertyCount()
Method getMetadataPropertyCount.

Returns:
the size of this collection

iterateMetadataProperty

public java.util.Iterator<? extends MetadataProperty> iterateMetadataProperty()
Method iterateMetadataProperty.

Returns:
an Iterator over all possible elements in this collection

removeAllMetadataProperty

public void removeAllMetadataProperty()

removeMetadataProperty

public boolean removeMetadataProperty(MetadataProperty vMetadataProperty)
Method removeMetadataProperty.

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

removeMetadataPropertyAt

public MetadataProperty removeMetadataPropertyAt(int index)
Method removeMetadataPropertyAt.

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

setMetadataProperty

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

setMetadataProperty

public void setMetadataProperty(MetadataProperty[] vMetadataPropertyArray)
Parameters:
vMetadataPropertyArray -

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.