org.LexGrid.REST.naming
Class SupportedHierarchy

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.naming.URIMap
          extended by org.LexGrid.REST.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()
           
 
Method Summary
 void addAssociationName(AssociationName vAssociationName)
           
 void addAssociationName(int index, AssociationName vAssociationName)
           
 java.util.Enumeration<? extends AssociationName> enumerateAssociationName()
          Method enumerateAssociationName.
 AssociationName[] getAssociationName()
          Method getAssociationName.Returns the contents of the collection in an Array.
 AssociationName getAssociationName(int index)
          Method getAssociationName.
 java.util.List<AssociationName> getAssociationNameAsReference()
          Method getAssociationNameAsReference.Returns a reference to '_associationNameList'.
 int getAssociationNameCount()
          Method getAssociationNameCount.
 java.lang.Boolean getIsForwardNavigable()
          Returns the value of field 'isForwardNavigable'.
 EntityCode 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 AssociationName> iterateAssociationName()
          Method iterateAssociationName.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllAssociationName()
           
 boolean removeAssociationName(AssociationName vAssociationName)
          Method removeAssociationName.
 AssociationName removeAssociationNameAt(int index)
          Method removeAssociationNameAt.
 void setAssociationName(AssociationName[] vAssociationNameArray)
           
 void setAssociationName(int index, AssociationName vAssociationName)
           
 void setAssociationName(java.util.List<AssociationName> vAssociationNameList)
          Sets the value of '_associationNameList' by copying the given Vector.
 void setAssociationNameAsReference(java.util.List<AssociationName> associationNameList)
          Deprecated.  
 void setIsForwardNavigable(java.lang.Boolean isForwardNavigable)
          Sets the value of field 'isForwardNavigable'.
 void setRootCode(EntityCode rootCode)
          Sets the value of field 'rootCode'.
static SupportedHierarchy unmarshalSupportedHierarchy(java.io.Reader reader)
          Method unmarshalSupportedHierarchy.
 void validate()
           
 
Methods inherited from class org.LexGrid.REST.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()
Method Detail

addAssociationName

public void addAssociationName(AssociationName vAssociationName)
                        throws java.lang.IndexOutOfBoundsException
Parameters:
vAssociationName -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addAssociationName

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

enumerateAssociationName

public java.util.Enumeration<? extends AssociationName> enumerateAssociationName()
Method enumerateAssociationName.

Returns:
an Enumeration over all possible elements of this collection

getAssociationName

public AssociationName getAssociationName(int index)
                                   throws java.lang.IndexOutOfBoundsException
Method getAssociationName.

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

getAssociationName

public AssociationName[] getAssociationName()
Method getAssociationName.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

getAssociationNameAsReference

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

Returns:
a reference to the Vector backing this class

getAssociationNameCount

public int getAssociationNameCount()
Method getAssociationNameCount.

Returns:
the size of this collection

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 EntityCode 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

iterateAssociationName

public java.util.Iterator<? extends AssociationName> iterateAssociationName()
Method iterateAssociationName.

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

removeAllAssociationName

public void removeAllAssociationName()

removeAssociationName

public boolean removeAssociationName(AssociationName vAssociationName)
Method removeAssociationName.

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

removeAssociationNameAt

public AssociationName removeAssociationNameAt(int index)
Method removeAssociationNameAt.

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

setAssociationName

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

setAssociationName

public void setAssociationName(AssociationName[] vAssociationNameArray)
Parameters:
vAssociationNameArray -

setAssociationName

public void setAssociationName(java.util.List<AssociationName> vAssociationNameList)
Sets the value of '_associationNameList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vAssociationNameList - the Vector to copy.

setAssociationNameAsReference

public void setAssociationNameAsReference(java.util.List<AssociationName> associationNameList)
Deprecated. 

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

Parameters:
associationNameList - the Vector to set.

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(EntityCode 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.REST.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.