org.LexGrid.naming
Class SupportedHierarchy

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.naming.URIMap
          extended by org.LexGrid.naming.SupportedHierarchy
All Implemented Interfaces:
java.io.Serializable

public class SupportedHierarchy
extends URIMap
implements java.io.Serializable

A list of associations that can be browsed hierarchically.

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

Constructor Summary
SupportedHierarchy()
           
SupportedHierarchy(java.lang.String defaultValue)
           
 
Method Summary
 void addAssociationNames(int index, java.lang.String vAssociationNames)
           
 void addAssociationNames(java.lang.String vAssociationNames)
           
 java.util.Enumeration<? extends java.lang.String> enumerateAssociationNames()
          Method enumerateAssociationNames.
 java.lang.String[] getAssociationNames()
          Method getAssociationNames.Returns the contents of the collection in an Array.
 java.lang.String getAssociationNames(int index)
          Method getAssociationNames.
 java.util.List<java.lang.String> getAssociationNamesAsReference()
          Method getAssociationNamesAsReference.Returns a reference to '_associationNamesList'.
 int getAssociationNamesCount()
          Method getAssociationNamesCount.
 java.lang.String getContent()
          Returns the value of field 'content'.
 java.lang.Boolean getIsForwardNavigable()
          Returns the value of field 'isForwardNavigable'.
 java.lang.String getRootCode()
          Returns the value of field 'rootCode'.
 java.lang.Boolean isIsForwardNavigable()
          Returns the value of field 'isForwardNavigable'.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends java.lang.String> iterateAssociationNames()
          Method iterateAssociationNames.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllAssociationNames()
           
 boolean removeAssociationNames(java.lang.String vAssociationNames)
          Method removeAssociationNames.
 java.lang.String removeAssociationNamesAt(int index)
          Method removeAssociationNamesAt.
 void setAssociationNames(int index, java.lang.String vAssociationNames)
           
 void setAssociationNames(java.util.List<java.lang.String> vAssociationNamesList)
          Sets the value of '_associationNamesList' by copying the given Vector.
 void setAssociationNames(java.lang.String[] vAssociationNamesArray)
           
 void setAssociationNamesAsReference(java.util.List<java.lang.String> associationNamesList)
          Deprecated.  
 void setContent(java.lang.String content)
          Sets the value of field 'content'.
 void setIsForwardNavigable(java.lang.Boolean isForwardNavigable)
          Sets the value of field 'isForwardNavigable'.
 void setRootCode(java.lang.String rootCode)
          Sets the value of field 'rootCode'.
static SupportedHierarchy unmarshalSupportedHierarchy(java.io.Reader reader)
          Method unmarshalSupportedHierarchy.
 void validate()
           
 
Methods inherited from class org.LexGrid.naming.URIMap
getLocalId, getUri, setLocalId, setUri, unmarshalURIMap
 
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

SupportedHierarchy

public SupportedHierarchy()

SupportedHierarchy

public SupportedHierarchy(java.lang.String defaultValue)
Method Detail

addAssociationNames

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

addAssociationNames

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

enumerateAssociationNames

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

Returns:
an Enumeration over all possible elements of this collection

getAssociationNames

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

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

getAssociationNames

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

getAssociationNamesAsReference

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

Returns:
a reference to the Vector backing this class

getAssociationNamesCount

public int getAssociationNamesCount()
Method getAssociationNamesCount.

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

Overrides:
getContent in class URIMap
Returns:
the value of field 'Content'.

getIsForwardNavigable

public java.lang.Boolean getIsForwardNavigable()
Returns the value of field 'isForwardNavigable'. The field 'isForwardNavigable' has the following description: "true" if coding scheme hierarchy is top-down; "false" for bottom-up

Returns:
the value of field 'IsForwardNavigable'.

getRootCode

public java.lang.String getRootCode()
Returns the value of field 'rootCode'. The field 'rootCode' has the following description: "@" for coding scheme that are top-down (ROOT) in hierarchy; "@@" for coding scheme that are bottom-up (TAIL) hierarchy

Returns:
the value of field 'RootCode'.

isIsForwardNavigable

public java.lang.Boolean isIsForwardNavigable()
Returns the value of field 'isForwardNavigable'. The field 'isForwardNavigable' has the following description: "true" if coding scheme hierarchy is top-down; "false" for bottom-up

Returns:
the value of field 'IsForwardNavigable'.

isValid

public boolean isValid()
Method isValid.

Overrides:
isValid in class URIMap
Returns:
true if this object is valid according to the schema

iterateAssociationNames

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

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
Overrides:
marshal in class URIMap
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
Overrides:
marshal in class URIMap
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

removeAllAssociationNames

public void removeAllAssociationNames()

removeAssociationNames

public boolean removeAssociationNames(java.lang.String vAssociationNames)
Method removeAssociationNames.

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

removeAssociationNamesAt

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

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

setAssociationNames

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

setAssociationNames

public void setAssociationNames(java.lang.String[] vAssociationNamesArray)
Parameters:
vAssociationNamesArray -

setAssociationNames

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

Parameters:
vAssociationNamesList - the Vector to copy.

setAssociationNamesAsReference

public void setAssociationNamesAsReference(java.util.List<java.lang.String> associationNamesList)
Deprecated. 

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

Parameters:
associationNamesList - the Vector to set.

setContent

public void setContent(java.lang.String content)
Sets the value of field 'content'. The field 'content' has the following description: internal content storage

Overrides:
setContent in class URIMap
Parameters:
content - the value of field 'content'.

setIsForwardNavigable

public void setIsForwardNavigable(java.lang.Boolean isForwardNavigable)
Sets the value of field 'isForwardNavigable'. The field 'isForwardNavigable' has the following description: "true" if coding scheme hierarchy is top-down; "false" for bottom-up

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

setRootCode

public void setRootCode(java.lang.String rootCode)
Sets the value of field 'rootCode'. The field 'rootCode' has the following description: "@" for coding scheme that are top-down (ROOT) in hierarchy; "@@" for coding scheme that are bottom-up (TAIL) hierarchy

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

unmarshalSupportedHierarchy

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.naming.SupportedHierarchy
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
Overrides:
validate in class URIMap
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.