org.LexGrid.valueSets
Class ValueSetDefinitions

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.valueSets.ValueSetDefinitions
All Implemented Interfaces:
java.io.Serializable

public class ValueSetDefinitions
extends LexGridBase
implements java.io.Serializable

A collection of value set definitions.

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

Constructor Summary
ValueSetDefinitions()
           
 
Method Summary
 void addValueSetDefinition(int index, ValueSetDefinition vValueSetDefinition)
           
 void addValueSetDefinition(ValueSetDefinition vValueSetDefinition)
           
 java.util.Enumeration<? extends ValueSetDefinition> enumerateValueSetDefinition()
          Method enumerateValueSetDefinition.
 Mappings getMappings()
          Returns the value of field 'mappings'.
 ValueSetDefinition[] getValueSetDefinition()
          Method getValueSetDefinition.Returns the contents of the collection in an Array.
 ValueSetDefinition getValueSetDefinition(int index)
          Method getValueSetDefinition.
 java.util.List<ValueSetDefinition> getValueSetDefinitionAsReference()
          Method getValueSetDefinitionAsReference.Returns a reference to '_valueSetDefinitionList'.
 int getValueSetDefinitionCount()
          Method getValueSetDefinitionCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends ValueSetDefinition> iterateValueSetDefinition()
          Method iterateValueSetDefinition.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllValueSetDefinition()
           
 boolean removeValueSetDefinition(ValueSetDefinition vValueSetDefinition)
          Method removeValueSetDefinition.
 ValueSetDefinition removeValueSetDefinitionAt(int index)
          Method removeValueSetDefinitionAt.
 void setMappings(Mappings mappings)
          Sets the value of field 'mappings'.
 void setValueSetDefinition(int index, ValueSetDefinition vValueSetDefinition)
           
 void setValueSetDefinition(java.util.List<ValueSetDefinition> vValueSetDefinitionList)
          Sets the value of '_valueSetDefinitionList' by copying the given Vector.
 void setValueSetDefinition(ValueSetDefinition[] vValueSetDefinitionArray)
           
 void setValueSetDefinitionAsReference(java.util.List<ValueSetDefinition> valueSetDefinitionList)
          Deprecated.  
static ValueSetDefinitions unmarshalValueSetDefinitions(java.io.Reader reader)
          Method unmarshalValueSetDefinitions.
 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

ValueSetDefinitions

public ValueSetDefinitions()
Method Detail

addValueSetDefinition

public void addValueSetDefinition(ValueSetDefinition vValueSetDefinition)
                           throws java.lang.IndexOutOfBoundsException
Parameters:
vValueSetDefinition -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addValueSetDefinition

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

enumerateValueSetDefinition

public java.util.Enumeration<? extends ValueSetDefinition> enumerateValueSetDefinition()
Method enumerateValueSetDefinition.

Returns:
an Enumeration over all possible elements of this collection

getMappings

public Mappings getMappings()
Returns the value of field 'mappings'. The field 'mappings' has the following description: The local names and corresponding URIs used in this collection

Returns:
the value of field 'Mappings'.

getValueSetDefinition

public ValueSetDefinition getValueSetDefinition(int index)
                                         throws java.lang.IndexOutOfBoundsException
Method getValueSetDefinition.

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

getValueSetDefinition

public ValueSetDefinition[] getValueSetDefinition()
Method getValueSetDefinition.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

getValueSetDefinitionAsReference

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

Returns:
a reference to the Vector backing this class

getValueSetDefinitionCount

public int getValueSetDefinitionCount()
Method getValueSetDefinitionCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

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

iterateValueSetDefinition

public java.util.Iterator<? extends ValueSetDefinition> iterateValueSetDefinition()
Method iterateValueSetDefinition.

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

removeAllValueSetDefinition

public void removeAllValueSetDefinition()

removeValueSetDefinition

public boolean removeValueSetDefinition(ValueSetDefinition vValueSetDefinition)
Method removeValueSetDefinition.

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

removeValueSetDefinitionAt

public ValueSetDefinition removeValueSetDefinitionAt(int index)
Method removeValueSetDefinitionAt.

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

setMappings

public void setMappings(Mappings mappings)
Sets the value of field 'mappings'. The field 'mappings' has the following description: The local names and corresponding URIs used in this collection

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

setValueSetDefinition

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

setValueSetDefinition

public void setValueSetDefinition(ValueSetDefinition[] vValueSetDefinitionArray)
Parameters:
vValueSetDefinitionArray -

setValueSetDefinition

public void setValueSetDefinition(java.util.List<ValueSetDefinition> vValueSetDefinitionList)
Sets the value of '_valueSetDefinitionList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vValueSetDefinitionList - the Vector to copy.

setValueSetDefinitionAsReference

public void setValueSetDefinitionAsReference(java.util.List<ValueSetDefinition> valueSetDefinitionList)
Deprecated. 

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

Parameters:
valueSetDefinitionList - the Vector to set.

unmarshalValueSetDefinitions

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.valueSets.ValueSetDefinitions
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.