org.LexGrid.REST.concepts
Class Definitions

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.concepts.Definitions
All Implemented Interfaces:
java.io.Serializable

public class Definitions
extends LexGridBase
implements java.io.Serializable

Used to select all of the definitions from an entity. The URL is actually not linkable directly

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

Constructor Summary
Definitions()
           
 
Method Summary
 void addDefinition(Definition vDefinition)
           
 void addDefinition(int index, Definition vDefinition)
           
 java.util.Enumeration<? extends Definition> enumerateDefinition()
          Method enumerateDefinition.
 Definition[] getDefinition()
          Method getDefinition.Returns the contents of the collection in an Array.
 Definition getDefinition(int index)
          Method getDefinition.
 java.util.List<Definition> getDefinitionAsReference()
          Method getDefinitionAsReference.Returns a reference to '_definitionList'.
 int getDefinitionCount()
          Method getDefinitionCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends Definition> iterateDefinition()
          Method iterateDefinition.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllDefinition()
           
 boolean removeDefinition(Definition vDefinition)
          Method removeDefinition.
 Definition removeDefinitionAt(int index)
          Method removeDefinitionAt.
 void setDefinition(Definition[] vDefinitionArray)
           
 void setDefinition(int index, Definition vDefinition)
           
 void setDefinition(java.util.List<Definition> vDefinitionList)
          Sets the value of '_definitionList' by copying the given Vector.
 void setDefinitionAsReference(java.util.List<Definition> definitionList)
          Deprecated.  
static Definitions unmarshalDefinitions(java.io.Reader reader)
          Method unmarshalDefinitions.
 void validate()
           
 
Methods inherited from class org.mayo.edu.lgModel.LexGridBase
getParent, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Definitions

public Definitions()
Method Detail

addDefinition

public void addDefinition(Definition vDefinition)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
vDefinition -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addDefinition

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

enumerateDefinition

public java.util.Enumeration<? extends Definition> enumerateDefinition()
Method enumerateDefinition.

Returns:
an Enumeration over all possible elements of this collection

getDefinition

public Definition getDefinition(int index)
                         throws java.lang.IndexOutOfBoundsException
Method getDefinition.

Parameters:
index -
Returns:
the value of the org.LexGrid.REST.concepts.Definition at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getDefinition

public Definition[] getDefinition()
Method getDefinition.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

getDefinitionAsReference

public java.util.List<Definition> getDefinitionAsReference()
Method getDefinitionAsReference.Returns a reference to '_definitionList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getDefinitionCount

public int getDefinitionCount()
Method getDefinitionCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

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

iterateDefinition

public java.util.Iterator<? extends Definition> iterateDefinition()
Method iterateDefinition.

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

removeAllDefinition

public void removeAllDefinition()

removeDefinition

public boolean removeDefinition(Definition vDefinition)
Method removeDefinition.

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

removeDefinitionAt

public Definition removeDefinitionAt(int index)
Method removeDefinitionAt.

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

setDefinition

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

setDefinition

public void setDefinition(Definition[] vDefinitionArray)
Parameters:
vDefinitionArray -

setDefinition

public void setDefinition(java.util.List<Definition> vDefinitionList)
Sets the value of '_definitionList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vDefinitionList - the Vector to copy.

setDefinitionAsReference

public void setDefinitionAsReference(java.util.List<Definition> definitionList)
Deprecated. 

Sets the value of '_definitionList' by setting it to the given Vector. No type checking is performed.

Parameters:
definitionList - the Vector to set.

unmarshalDefinitions

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.REST.concepts.Definitions
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.