--- /dev/null
+/*\r
+ * This class was automatically generated with \r
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
+ * Schema.\r
+ * $Id$\r
+ */\r
+\r
+package uk.ac.vamsas.objects.core;\r
+\r
+ //---------------------------------/\r
+ //- Imported classes and packages -/\r
+//---------------------------------/\r
+\r
+import org.exolab.castor.xml.Marshaller;\r
+import org.exolab.castor.xml.Unmarshaller;\r
+\r
+/**\r
+ * node identity and mapping data between tree representations and\r
+ * vamsas document objects\r
+ * \r
+ * \r
+ * @version $Revision$ $Date$\r
+ */\r
+public class Treenode extends uk.ac.vamsas.objects.core.NodeType \r
+implements java.io.Serializable\r
+{\r
+\r
+\r
+ //--------------------------/\r
+ //- Class/Member Variables -/\r
+ //--------------------------/\r
+\r
+ /**\r
+ * reference to one or more trees containing the node being\r
+ * described.\r
+ * \r
+ */\r
+ private java.util.Vector _treeId;\r
+\r
+ /**\r
+ * String uniquely identifying a particular node in the\r
+ * referenced tree according to the format of the tree\r
+ * representation that is referenced.\r
+ * \r
+ */\r
+ private java.lang.String _nodespec;\r
+\r
+\r
+ //----------------/\r
+ //- Constructors -/\r
+ //----------------/\r
+\r
+ public Treenode() {\r
+ super();\r
+ this._treeId = new java.util.Vector();\r
+ }\r
+\r
+\r
+ //-----------/\r
+ //- Methods -/\r
+ //-----------/\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param vTreeId\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void addTreeId(\r
+ final java.lang.Object vTreeId)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ this._treeId.addElement(vTreeId);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vTreeId\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void addTreeId(\r
+ final int index,\r
+ final java.lang.Object vTreeId)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ this._treeId.add(index, vTreeId);\r
+ }\r
+\r
+ /**\r
+ * Method enumerateTreeId.\r
+ * \r
+ * @return an Enumeration over all java.lang.Object elements\r
+ */\r
+ public java.util.Enumeration enumerateTreeId(\r
+ ) {\r
+ return this._treeId.elements();\r
+ }\r
+\r
+ /**\r
+ * Overrides the java.lang.Object.equals method.\r
+ * \r
+ * @param obj\r
+ * @return true if the objects are equal.\r
+ */\r
+ public boolean equals(\r
+ final java.lang.Object obj) {\r
+ if ( this == obj )\r
+ return true;\r
+ \r
+ if (super.equals(obj)==false)\r
+ return false;\r
+ \r
+ if (obj instanceof Treenode) {\r
+ \r
+ Treenode temp = (Treenode)obj;\r
+ if (this._treeId != null) {\r
+ if (temp._treeId == null) return false;\r
+ else if (!(this._treeId.equals(temp._treeId))) \r
+ return false;\r
+ }\r
+ else if (temp._treeId != null)\r
+ return false;\r
+ if (this._nodespec != null) {\r
+ if (temp._nodespec == null) return false;\r
+ else if (!(this._nodespec.equals(temp._nodespec))) \r
+ return false;\r
+ }\r
+ else if (temp._nodespec != null)\r
+ return false;\r
+ return true;\r
+ }\r
+ return false;\r
+ }\r
+\r
+ /**\r
+ * Returns the value of field 'nodespec'. The field 'nodespec'\r
+ * has the following description: String uniquely identifying a\r
+ * particular node in the referenced tree according to the\r
+ * format of the tree representation that is referenced.\r
+ * \r
+ * \r
+ * @return the value of field 'Nodespec'.\r
+ */\r
+ public java.lang.String getNodespec(\r
+ ) {\r
+ return this._nodespec;\r
+ }\r
+\r
+ /**\r
+ * Method getTreeId.\r
+ * \r
+ * @param index\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ * @return the value of the java.lang.Object at the given index\r
+ */\r
+ public java.lang.Object getTreeId(\r
+ final int index)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._treeId.size()) {\r
+ throw new IndexOutOfBoundsException("getTreeId: Index value '" + index + "' not in range [0.." + (this._treeId.size() - 1) + "]");\r
+ }\r
+ \r
+ return _treeId.get(index);\r
+ }\r
+\r
+ /**\r
+ * Method getTreeId.Returns the contents of the collection in\r
+ * an Array. <p>Note: Just in case the collection contents\r
+ * are changing in another thread, we pass a 0-length Array of\r
+ * the correct type into the API call. This way we <i>know</i>\r
+ * that the Array returned is of exactly the correct length.\r
+ * \r
+ * @return this collection as an Array\r
+ */\r
+ public java.lang.Object[] getTreeId(\r
+ ) {\r
+ java.lang.Object[] array = new java.lang.Object[0];\r
+ return (java.lang.Object[]) this._treeId.toArray(array);\r
+ }\r
+\r
+ /**\r
+ * Method getTreeIdAsReference.Returns a reference to\r
+ * '_treeId'. No type checking is performed on any\r
+ * modifications to the Vector.\r
+ * \r
+ * @return a reference to the Vector backing this class\r
+ */\r
+ public java.util.Vector getTreeIdAsReference(\r
+ ) {\r
+ return this._treeId;\r
+ }\r
+\r
+ /**\r
+ * Method getTreeIdCount.\r
+ * \r
+ * @return the size of this collection\r
+ */\r
+ public int getTreeIdCount(\r
+ ) {\r
+ return this._treeId.size();\r
+ }\r
+\r
+ /**\r
+ * Overrides the java.lang.Object.hashCode method.\r
+ * <p>\r
+ * The following steps came from <b>Effective Java Programming\r
+ * Language Guide</b> by Joshua Bloch, Chapter 3\r
+ * \r
+ * @return a hash code value for the object.\r
+ */\r
+ public int hashCode(\r
+ ) {\r
+ int result = super.hashCode();\r
+ \r
+ long tmp;\r
+ if (_treeId != null) {\r
+ result = 37 * result + _treeId.hashCode();\r
+ }\r
+ if (_nodespec != null) {\r
+ result = 37 * result + _nodespec.hashCode();\r
+ }\r
+ \r
+ return result;\r
+ }\r
+\r
+ /**\r
+ * Method isValid.\r
+ * \r
+ * @return true if this object is valid according to the schema\r
+ */\r
+ public boolean isValid(\r
+ ) {\r
+ try {\r
+ validate();\r
+ } catch (org.exolab.castor.xml.ValidationException vex) {\r
+ return false;\r
+ }\r
+ return true;\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param out\r
+ * @throws org.exolab.castor.xml.MarshalException if object is\r
+ * null or if any SAXException is thrown during marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
+ */\r
+ public void marshal(\r
+ final java.io.Writer out)\r
+ throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
+ Marshaller.marshal(this, out);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param handler\r
+ * @throws java.io.IOException if an IOException occurs during\r
+ * marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
+ * @throws org.exolab.castor.xml.MarshalException if object is\r
+ * null or if any SAXException is thrown during marshaling\r
+ */\r
+ public void marshal(\r
+ final org.xml.sax.ContentHandler handler)\r
+ throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
+ Marshaller.marshal(this, handler);\r
+ }\r
+\r
+ /**\r
+ */\r
+ public void removeAllTreeId(\r
+ ) {\r
+ this._treeId.clear();\r
+ }\r
+\r
+ /**\r
+ * Method removeTreeId.\r
+ * \r
+ * @param vTreeId\r
+ * @return true if the object was removed from the collection.\r
+ */\r
+ public boolean removeTreeId(\r
+ final java.lang.Object vTreeId) {\r
+ boolean removed = _treeId.remove(vTreeId);\r
+ return removed;\r
+ }\r
+\r
+ /**\r
+ * Method removeTreeIdAt.\r
+ * \r
+ * @param index\r
+ * @return the element removed from the collection\r
+ */\r
+ public java.lang.Object removeTreeIdAt(\r
+ final int index) {\r
+ java.lang.Object obj = this._treeId.remove(index);\r
+ return obj;\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'nodespec'. The field 'nodespec' has\r
+ * the following description: String uniquely identifying a\r
+ * particular node in the referenced tree according to the\r
+ * format of the tree representation that is referenced.\r
+ * \r
+ * \r
+ * @param nodespec the value of field 'nodespec'.\r
+ */\r
+ public void setNodespec(\r
+ final java.lang.String nodespec) {\r
+ this._nodespec = nodespec;\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vTreeId\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void setTreeId(\r
+ final int index,\r
+ final java.lang.Object vTreeId)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._treeId.size()) {\r
+ throw new IndexOutOfBoundsException("setTreeId: Index value '" + index + "' not in range [0.." + (this._treeId.size() - 1) + "]");\r
+ }\r
+ \r
+ this._treeId.set(index, vTreeId);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param vTreeIdArray\r
+ */\r
+ public void setTreeId(\r
+ final java.lang.Object[] vTreeIdArray) {\r
+ //-- copy array\r
+ _treeId.clear();\r
+ \r
+ for (int i = 0; i < vTreeIdArray.length; i++) {\r
+ this._treeId.add(vTreeIdArray[i]);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Sets the value of '_treeId' by copying the given Vector. All\r
+ * elements will be checked for type safety.\r
+ * \r
+ * @param vTreeIdList the Vector to copy.\r
+ */\r
+ public void setTreeId(\r
+ final java.util.Vector vTreeIdList) {\r
+ // copy vector\r
+ this._treeId.clear();\r
+ \r
+ this._treeId.addAll(vTreeIdList);\r
+ }\r
+\r
+ /**\r
+ * Sets the value of '_treeId' by setting it to the given\r
+ * Vector. No type checking is performed.\r
+ * @deprecated\r
+ * \r
+ * @param treeIdVector the Vector to set.\r
+ */\r
+ public void setTreeIdAsReference(\r
+ final java.util.Vector treeIdVector) {\r
+ this._treeId = treeIdVector;\r
+ }\r
+\r
+ /**\r
+ * Method unmarshal.\r
+ * \r
+ * @param reader\r
+ * @throws org.exolab.castor.xml.MarshalException if object is\r
+ * null or if any SAXException is thrown during marshaling\r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
+ * @return the unmarshaled uk.ac.vamsas.objects.core.NodeType\r
+ */\r
+ public static uk.ac.vamsas.objects.core.NodeType unmarshal(\r
+ final java.io.Reader reader)\r
+ throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
+ return (uk.ac.vamsas.objects.core.NodeType) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Treenode.class, reader);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @throws org.exolab.castor.xml.ValidationException if this\r
+ * object is an invalid instance according to the schema\r
+ */\r
+ public void validate(\r
+ )\r
+ throws org.exolab.castor.xml.ValidationException {\r
+ org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
+ validator.validate(this);\r
+ }\r
+\r
+}\r
git://source.jalview.org / vamsas.git / blobdiff