org.LexGrid.REST.codingSchemes
Class CodingSchemeDirectoryEntryGroup

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

public class CodingSchemeDirectoryEntryGroup
extends LexGridBase
implements java.io.Serializable

Information about a coding scheme that is known to a given resource.

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

Constructor Summary
CodingSchemeDirectoryEntryGroup()
           
 
Method Summary
 void addVersionTags(int index, java.lang.String vVersionTags)
           
 void addVersionTags(java.lang.String vVersionTags)
           
 java.util.Enumeration<? extends java.lang.String> enumerateVersionTags()
          Method enumerateVersionTags.
 EntityDescription getCodingSchemeDescription()
          Returns the value of field 'codingSchemeDescription'.
 CodingSchemeName getCodingSchemeName()
          Returns the value of field 'codingSchemeName'.
 URI getCodingSchemeURI()
          Returns the value of field 'codingSchemeURI'.
 java.lang.String getCodingSchemeVersion()
          Returns the value of field 'codingSchemeVersion'.
 java.lang.String getFormalName()
          Returns the value of field 'formalName'.
 java.lang.String[] getVersionTags()
          Method getVersionTags.Returns the contents of the collection in an Array.
 java.lang.String getVersionTags(int index)
          Method getVersionTags.
 java.util.List<java.lang.String> getVersionTagsAsReference()
          Method getVersionTagsAsReference.Returns a reference to '_versionTagsList'.
 int getVersionTagsCount()
          Method getVersionTagsCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends java.lang.String> iterateVersionTags()
          Method iterateVersionTags.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllVersionTags()
           
 boolean removeVersionTags(java.lang.String vVersionTags)
          Method removeVersionTags.
 java.lang.String removeVersionTagsAt(int index)
          Method removeVersionTagsAt.
 void setCodingSchemeDescription(EntityDescription codingSchemeDescription)
          Sets the value of field 'codingSchemeDescription'.
 void setCodingSchemeName(CodingSchemeName codingSchemeName)
          Sets the value of field 'codingSchemeName'.
 void setCodingSchemeURI(URI codingSchemeURI)
          Sets the value of field 'codingSchemeURI'.
 void setCodingSchemeVersion(java.lang.String codingSchemeVersion)
          Sets the value of field 'codingSchemeVersion'.
 void setFormalName(java.lang.String formalName)
          Sets the value of field 'formalName'.
 void setVersionTags(int index, java.lang.String vVersionTags)
           
 void setVersionTags(java.util.List<java.lang.String> vVersionTagsList)
          Sets the value of '_versionTagsList' by copying the given Vector.
 void setVersionTags(java.lang.String[] vVersionTagsArray)
           
 void setVersionTagsAsReference(java.util.List<java.lang.String> versionTagsList)
          Deprecated.  
static CodingSchemeDirectoryEntryGroup unmarshalCodingSchemeDirectoryEntryGroup(java.io.Reader reader)
          Method unmarshalCodingSchemeDirectoryEntryGroup.
 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

CodingSchemeDirectoryEntryGroup

public CodingSchemeDirectoryEntryGroup()
Method Detail

addVersionTags

public void addVersionTags(java.lang.String vVersionTags)
                    throws java.lang.IndexOutOfBoundsException
Parameters:
vVersionTags -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addVersionTags

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

enumerateVersionTags

public java.util.Enumeration<? extends java.lang.String> enumerateVersionTags()
Method enumerateVersionTags.

Returns:
an Enumeration over all possible elements of this collection

getCodingSchemeDescription

public EntityDescription getCodingSchemeDescription()
Returns the value of field 'codingSchemeDescription'. The field 'codingSchemeDescription' has the following description: A short description of the coding scheme contents.

Returns:
the value of field 'CodingSchemeDescription'.

getCodingSchemeName

public CodingSchemeName getCodingSchemeName()
Returns the value of field 'codingSchemeName'.

Returns:
the value of field 'CodingSchemeName'.

getCodingSchemeURI

public URI getCodingSchemeURI()
Returns the value of field 'codingSchemeURI'. The field 'codingSchemeURI' has the following description: The official URI of the coding scheme

Returns:
the value of field 'CodingSchemeURI'.

getCodingSchemeVersion

public java.lang.String getCodingSchemeVersion()
Returns the value of field 'codingSchemeVersion'.

Returns:
the value of field 'CodingSchemeVersion'.

getFormalName

public java.lang.String getFormalName()
Returns the value of field 'formalName'. The field 'formalName' has the following description: The official name of the coding scheme

Returns:
the value of field 'FormalName'.

getVersionTags

public java.lang.String getVersionTags(int index)
                                throws java.lang.IndexOutOfBoundsException
Method getVersionTags.

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

getVersionTags

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

getVersionTagsAsReference

public java.util.List<java.lang.String> getVersionTagsAsReference()
Method getVersionTagsAsReference.Returns a reference to '_versionTagsList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getVersionTagsCount

public int getVersionTagsCount()
Method getVersionTagsCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

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

iterateVersionTags

public java.util.Iterator<? extends java.lang.String> iterateVersionTags()
Method iterateVersionTags.

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

removeAllVersionTags

public void removeAllVersionTags()

removeVersionTags

public boolean removeVersionTags(java.lang.String vVersionTags)
Method removeVersionTags.

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

removeVersionTagsAt

public java.lang.String removeVersionTagsAt(int index)
Method removeVersionTagsAt.

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

setCodingSchemeDescription

public void setCodingSchemeDescription(EntityDescription codingSchemeDescription)
Sets the value of field 'codingSchemeDescription'. The field 'codingSchemeDescription' has the following description: A short description of the coding scheme contents.

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

setCodingSchemeName

public void setCodingSchemeName(CodingSchemeName codingSchemeName)
Sets the value of field 'codingSchemeName'.

Parameters:
codingSchemeName - the value of field 'codingSchemeName'

setCodingSchemeURI

public void setCodingSchemeURI(URI codingSchemeURI)
Sets the value of field 'codingSchemeURI'. The field 'codingSchemeURI' has the following description: The official URI of the coding scheme

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

setCodingSchemeVersion

public void setCodingSchemeVersion(java.lang.String codingSchemeVersion)
Sets the value of field 'codingSchemeVersion'.

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

setFormalName

public void setFormalName(java.lang.String formalName)
Sets the value of field 'formalName'. The field 'formalName' has the following description: The official name of the coding scheme

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

setVersionTags

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

setVersionTags

public void setVersionTags(java.lang.String[] vVersionTagsArray)
Parameters:
vVersionTagsArray -

setVersionTags

public void setVersionTags(java.util.List<java.lang.String> vVersionTagsList)
Sets the value of '_versionTagsList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vVersionTagsList - the Vector to copy.

setVersionTagsAsReference

public void setVersionTagsAsReference(java.util.List<java.lang.String> versionTagsList)
Deprecated. 

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

Parameters:
versionTagsList - the Vector to set.

unmarshalCodingSchemeDirectoryEntryGroup

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

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