org.LexGrid.valueDomains
Class ValueDomains

java.lang.Object
  extended by org.LexGrid.valueDomains.ValueDomains
All Implemented Interfaces:
java.io.Serializable

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

A collection of value domain definitions.

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

Constructor Summary
ValueDomains()
           
 
Method Summary
 void addValueDomainDefinition(int index, ValueDomainDefinition vValueDomainDefinition)
           
 void addValueDomainDefinition(ValueDomainDefinition vValueDomainDefinition)
           
 java.util.Enumeration<ValueDomainDefinition> enumerateValueDomainDefinition()
          Method enumerateValueDomainDefinition.
 Mappings getMappings()
          Returns the value of field 'mappings'.
 ValueDomainDefinition[] getValueDomainDefinition()
          Method getValueDomainDefinition.Returns the contents of the collection in an Array.
 ValueDomainDefinition getValueDomainDefinition(int index)
          Method getValueDomainDefinition.
 int getValueDomainDefinitionCount()
          Method getValueDomainDefinitionCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<ValueDomainDefinition> iterateValueDomainDefinition()
          Method iterateValueDomainDefinition.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllValueDomainDefinition()
           
 boolean removeValueDomainDefinition(ValueDomainDefinition vValueDomainDefinition)
          Method removeValueDomainDefinition.
 ValueDomainDefinition removeValueDomainDefinitionAt(int index)
          Method removeValueDomainDefinitionAt.
 void setMappings(Mappings mappings)
          Sets the value of field 'mappings'.
 void setValueDomainDefinition(int index, ValueDomainDefinition vValueDomainDefinition)
           
 void setValueDomainDefinition(ValueDomainDefinition[] vValueDomainDefinitionArray)
           
static ValueDomains unmarshalValueDomains(java.io.Reader reader)
          Method unmarshalValueDomains.
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValueDomains

public ValueDomains()
Method Detail

addValueDomainDefinition

public void addValueDomainDefinition(ValueDomainDefinition vValueDomainDefinition)
                              throws java.lang.IndexOutOfBoundsException
Parameters:
vValueDomainDefinition -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addValueDomainDefinition

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

enumerateValueDomainDefinition

public java.util.Enumeration<ValueDomainDefinition> enumerateValueDomainDefinition()
Method enumerateValueDomainDefinition.

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

getValueDomainDefinition

public ValueDomainDefinition getValueDomainDefinition(int index)
                                               throws java.lang.IndexOutOfBoundsException
Method getValueDomainDefinition.

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

getValueDomainDefinition

public ValueDomainDefinition[] getValueDomainDefinition()
Method getValueDomainDefinition.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

getValueDomainDefinitionCount

public int getValueDomainDefinitionCount()
Method getValueDomainDefinitionCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

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

iterateValueDomainDefinition

public java.util.Iterator<ValueDomainDefinition> iterateValueDomainDefinition()
Method iterateValueDomainDefinition.

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

removeAllValueDomainDefinition

public void removeAllValueDomainDefinition()

removeValueDomainDefinition

public boolean removeValueDomainDefinition(ValueDomainDefinition vValueDomainDefinition)
Method removeValueDomainDefinition.

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

removeValueDomainDefinitionAt

public ValueDomainDefinition removeValueDomainDefinitionAt(int index)
Method removeValueDomainDefinitionAt.

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

setValueDomainDefinition

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

setValueDomainDefinition

public void setValueDomainDefinition(ValueDomainDefinition[] vValueDomainDefinitionArray)
Parameters:
vValueDomainDefinitionArray -

unmarshalValueDomains

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

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