org.LexGrid.LexBIG.DataModel.Core
Class AssociatedData

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

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

A "dataProperty" - data that is the target of an association.

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

Constructor Summary
AssociatedData()
           
 
Method Summary
 void addAnyObject(int index, java.lang.Object vAnyObject)
           
 void addAnyObject(java.lang.Object vAnyObject)
           
 java.util.Enumeration<java.lang.Object> enumerateAnyObject()
          Method enumerateAnyObject.
 java.lang.Object[] getAnyObject()
          Method getAnyObject.Returns the contents of the collection in an Array.
 java.lang.Object getAnyObject(int index)
          Method getAnyObject.
 int getAnyObjectCount()
          Method getAnyObjectCount.
 java.lang.String getContent()
          Returns the value of field 'content'.
 java.lang.String getDataType()
          Returns the value of field 'dataType'.
 java.lang.String getId()
          Returns the value of field 'id'.
 java.util.Iterator<java.lang.Object> iterateAnyObject()
          Method iterateAnyObject.
 void removeAllAnyObject()
           
 boolean removeAnyObject(java.lang.Object vAnyObject)
          Method removeAnyObject.
 java.lang.Object removeAnyObjectAt(int index)
          Method removeAnyObjectAt.
 void setAnyObject(int index, java.lang.Object vAnyObject)
           
 void setAnyObject(java.lang.Object[] vAnyObjectArray)
           
 void setContent(java.lang.String content)
          Sets the value of field 'content'.
 void setDataType(java.lang.String dataType)
          Sets the value of field 'dataType'.
 void setId(java.lang.String id)
          Sets the value of field 'id'.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AssociatedData

public AssociatedData()
Method Detail

addAnyObject

public void addAnyObject(java.lang.Object vAnyObject)
                  throws java.lang.IndexOutOfBoundsException
Parameters:
vAnyObject -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addAnyObject

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

enumerateAnyObject

public java.util.Enumeration<java.lang.Object> enumerateAnyObject()
Method enumerateAnyObject.

Returns:
an Enumeration over all possible elements of this collection

getAnyObject

public java.lang.Object getAnyObject(int index)
                              throws java.lang.IndexOutOfBoundsException
Method getAnyObject.

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

getAnyObject

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

getAnyObjectCount

public int getAnyObjectCount()
Method getAnyObjectCount.

Returns:
the size of this collection

getContent

public java.lang.String getContent()
Returns the value of field 'content'. The field 'content' has the following description: internal content storage

Returns:
the value of field 'Content'.

getDataType

public java.lang.String getDataType()
Returns the value of field 'dataType'. The field 'dataType' has the following description: The data type of the property. The data itself is the value.

Returns:
the value of field 'DataType'.

getId

public java.lang.String getId()
Returns the value of field 'id'. The field 'id' has the following description: An identifier that makes this chunk of data unique within an association.

Returns:
the value of field 'Id'.

iterateAnyObject

public java.util.Iterator<java.lang.Object> iterateAnyObject()
Method iterateAnyObject.

Returns:
an Iterator over all possible elements in this collection

removeAllAnyObject

public void removeAllAnyObject()

removeAnyObject

public boolean removeAnyObject(java.lang.Object vAnyObject)
Method removeAnyObject.

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

removeAnyObjectAt

public java.lang.Object removeAnyObjectAt(int index)
Method removeAnyObjectAt.

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

setAnyObject

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

setAnyObject

public void setAnyObject(java.lang.Object[] vAnyObjectArray)
Parameters:
vAnyObjectArray -

setContent

public void setContent(java.lang.String content)
Sets the value of field 'content'. The field 'content' has the following description: internal content storage

Parameters:
content - the value of field 'content'.

setDataType

public void setDataType(java.lang.String dataType)
Sets the value of field 'dataType'. The field 'dataType' has the following description: The data type of the property. The data itself is the value.

Parameters:
dataType - the value of field 'dataType'.

setId

public void setId(java.lang.String id)
Sets the value of field 'id'. The field 'id' has the following description: An identifier that makes this chunk of data unique within an association.

Parameters:
id - the value of field 'id'.

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.