org.LexGrid.builtins
Class TsAnyType

java.lang.Object
  extended by org.LexGrid.builtins.TsAnyType
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
EntityDescription, Text

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

An opaque inner type that can contain any well-formed, but arbitrary information.

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

Constructor Summary
TsAnyType()
           
 
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'.
 boolean isValid()
          Method isValid.
 java.util.Iterator<java.lang.Object> iterateAnyObject()
          Method iterateAnyObject.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 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'.
static TsAnyType unmarshalTsAnyType(java.io.Reader reader)
          Method unmarshalTsAnyType.
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TsAnyType

public TsAnyType()
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'.

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

iterateAnyObject

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

Returns:
an Iterator over all possible elements in this collection

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
handler -
Throws:
java.io.IOException - if an IOException occurs during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

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'.

unmarshalTsAnyType

public static TsAnyType unmarshalTsAnyType(java.io.Reader reader)
                                    throws org.exolab.castor.xml.MarshalException,
                                           org.exolab.castor.xml.ValidationException
Method unmarshalTsAnyType.

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.builtins.TsAnyType
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Throws:
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

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.