+/*\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
+ * Class NodeType.\r
+ * \r
+ * @version $Revision$ $Date$\r
+ */\r
+public class NodeType extends uk.ac.vamsas.client.Vobject \r
+implements java.io.Serializable\r
+{\r
+\r
+\r
+ //--------------------------/\r
+ //- Class/Member Variables -/\r
+ //--------------------------/\r
+\r
+ /**\r
+ * Primary Key for vamsas object referencing \r
+ */\r
+ private java.lang.String _id;\r
+\r
+ /**\r
+ * Field _modifiable.\r
+ */\r
+ private java.lang.String _modifiable;\r
+\r
+ /**\r
+ * Short name for this node\r
+ */\r
+ private java.lang.String _name;\r
+\r
+ /**\r
+ * Descriptive text for this node\r
+ */\r
+ private java.lang.String _description;\r
+\r
+ /**\r
+ * Direct associations between this node and any vamsas objects\r
+ */\r
+ private java.util.Vector _vrefList;\r
+\r
+ /**\r
+ * Field _propertyList.\r
+ */\r
+ private java.util.Vector _propertyList;\r
+\r
+\r
+ //----------------/\r
+ //- Constructors -/\r
+ //----------------/\r
+\r
+ public NodeType() {\r
+ super();\r
+ this._vrefList = new java.util.Vector();\r
+ this._propertyList = new java.util.Vector();\r
+ }\r
+\r
+\r
+ //-----------/\r
+ //- Methods -/\r
+ //-----------/\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param vProperty\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void addProperty(\r
+ final uk.ac.vamsas.objects.core.Property vProperty)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ this._propertyList.addElement(vProperty);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vProperty\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void addProperty(\r
+ final int index,\r
+ final uk.ac.vamsas.objects.core.Property vProperty)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ this._propertyList.add(index, vProperty);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param vVref\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void addVref(\r
+ final uk.ac.vamsas.objects.core.Vref vVref)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ this._vrefList.addElement(vVref);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vVref\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void addVref(\r
+ final int index,\r
+ final uk.ac.vamsas.objects.core.Vref vVref)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ this._vrefList.add(index, vVref);\r
+ }\r
+\r
+ /**\r
+ * Method enumerateProperty.\r
+ * \r
+ * @return an Enumeration over all\r
+ * uk.ac.vamsas.objects.core.Property elements\r
+ */\r
+ public java.util.Enumeration enumerateProperty(\r
+ ) {\r
+ return this._propertyList.elements();\r
+ }\r
+\r
+ /**\r
+ * Method enumerateVref.\r
+ * \r
+ * @return an Enumeration over all\r
+ * uk.ac.vamsas.objects.core.Vref elements\r
+ */\r
+ public java.util.Enumeration enumerateVref(\r
+ ) {\r
+ return this._vrefList.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 NodeType) {\r
+ \r
+ NodeType temp = (NodeType)obj;\r
+ if (this._id != null) {\r
+ if (temp._id == null) return false;\r
+ else if (!(this._id.equals(temp._id))) \r
+ return false;\r
+ }\r
+ else if (temp._id != null)\r
+ return false;\r
+ if (this._modifiable != null) {\r
+ if (temp._modifiable == null) return false;\r
+ else if (!(this._modifiable.equals(temp._modifiable))) \r
+ return false;\r
+ }\r
+ else if (temp._modifiable != null)\r
+ return false;\r
+ if (this._name != null) {\r
+ if (temp._name == null) return false;\r
+ else if (!(this._name.equals(temp._name))) \r
+ return false;\r
+ }\r
+ else if (temp._name != null)\r
+ return false;\r
+ if (this._description != null) {\r
+ if (temp._description == null) return false;\r
+ else if (!(this._description.equals(temp._description))) \r
+ return false;\r
+ }\r
+ else if (temp._description != null)\r
+ return false;\r
+ if (this._vrefList != null) {\r
+ if (temp._vrefList == null) return false;\r
+ else if (!(this._vrefList.equals(temp._vrefList))) \r
+ return false;\r
+ }\r
+ else if (temp._vrefList != null)\r
+ return false;\r
+ if (this._propertyList != null) {\r
+ if (temp._propertyList == null) return false;\r
+ else if (!(this._propertyList.equals(temp._propertyList))) \r
+ return false;\r
+ }\r
+ else if (temp._propertyList != null)\r
+ return false;\r
+ return true;\r
+ }\r
+ return false;\r
+ }\r
+\r
+ /**\r
+ * Returns the value of field 'description'. The field\r
+ * 'description' has the following description: Descriptive\r
+ * text for this node\r
+ * \r
+ * @return the value of field 'Description'.\r
+ */\r
+ public java.lang.String getDescription(\r
+ ) {\r
+ return this._description;\r
+ }\r
+\r
+ /**\r
+ * Returns the value of field 'id'. The field 'id' has the\r
+ * following description: Primary Key for vamsas object\r
+ * referencing \r
+ * \r
+ * @return the value of field 'Id'.\r
+ */\r
+ public java.lang.String getId(\r
+ ) {\r
+ return this._id;\r
+ }\r
+\r
+ /**\r
+ * Returns the value of field 'modifiable'.\r
+ * \r
+ * @return the value of field 'Modifiable'.\r
+ */\r
+ public java.lang.String getModifiable(\r
+ ) {\r
+ return this._modifiable;\r
+ }\r
+\r
+ /**\r
+ * Returns the value of field 'name'. The field 'name' has the\r
+ * following description: Short name for this node\r
+ * \r
+ * @return the value of field 'Name'.\r
+ */\r
+ public java.lang.String getName(\r
+ ) {\r
+ return this._name;\r
+ }\r
+\r
+ /**\r
+ * Method getProperty.\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 uk.ac.vamsas.objects.core.Property\r
+ * at the given index\r
+ */\r
+ public uk.ac.vamsas.objects.core.Property getProperty(\r
+ final int index)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._propertyList.size()) {\r
+ throw new IndexOutOfBoundsException("getProperty: Index value '" + index + "' not in range [0.." + (this._propertyList.size() - 1) + "]");\r
+ }\r
+ \r
+ return (uk.ac.vamsas.objects.core.Property) _propertyList.get(index);\r
+ }\r
+\r
+ /**\r
+ * Method getProperty.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 uk.ac.vamsas.objects.core.Property[] getProperty(\r
+ ) {\r
+ uk.ac.vamsas.objects.core.Property[] array = new uk.ac.vamsas.objects.core.Property[0];\r
+ return (uk.ac.vamsas.objects.core.Property[]) this._propertyList.toArray(array);\r
+ }\r
+\r
+ /**\r
+ * Method getPropertyAsReference.Returns a reference to\r
+ * '_propertyList'. 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 getPropertyAsReference(\r
+ ) {\r
+ return this._propertyList;\r
+ }\r
+\r
+ /**\r
+ * Method getPropertyCount.\r
+ * \r
+ * @return the size of this collection\r
+ */\r
+ public int getPropertyCount(\r
+ ) {\r
+ return this._propertyList.size();\r
+ }\r
+\r
+ /**\r
+ * Method getVref.\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 uk.ac.vamsas.objects.core.Vref at\r
+ * the given index\r
+ */\r
+ public uk.ac.vamsas.objects.core.Vref getVref(\r
+ final int index)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._vrefList.size()) {\r
+ throw new IndexOutOfBoundsException("getVref: Index value '" + index + "' not in range [0.." + (this._vrefList.size() - 1) + "]");\r
+ }\r
+ \r
+ return (uk.ac.vamsas.objects.core.Vref) _vrefList.get(index);\r
+ }\r
+\r
+ /**\r
+ * Method getVref.Returns the contents of the collection in an\r
+ * Array. <p>Note: Just in case the collection contents are\r
+ * changing in another thread, we pass a 0-length Array of the\r
+ * 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 uk.ac.vamsas.objects.core.Vref[] getVref(\r
+ ) {\r
+ uk.ac.vamsas.objects.core.Vref[] array = new uk.ac.vamsas.objects.core.Vref[0];\r
+ return (uk.ac.vamsas.objects.core.Vref[]) this._vrefList.toArray(array);\r
+ }\r
+\r
+ /**\r
+ * Method getVrefAsReference.Returns a reference to\r
+ * '_vrefList'. 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 getVrefAsReference(\r
+ ) {\r
+ return this._vrefList;\r
+ }\r
+\r
+ /**\r
+ * Method getVrefCount.\r
+ * \r
+ * @return the size of this collection\r
+ */\r
+ public int getVrefCount(\r
+ ) {\r
+ return this._vrefList.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 (_id != null) {\r
+ result = 37 * result + _id.hashCode();\r
+ }\r
+ if (_modifiable != null) {\r
+ result = 37 * result + _modifiable.hashCode();\r
+ }\r
+ if (_name != null) {\r
+ result = 37 * result + _name.hashCode();\r
+ }\r
+ if (_description != null) {\r
+ result = 37 * result + _description.hashCode();\r
+ }\r
+ if (_vrefList != null) {\r
+ result = 37 * result + _vrefList.hashCode();\r
+ }\r
+ if (_propertyList != null) {\r
+ result = 37 * result + _propertyList.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 removeAllProperty(\r
+ ) {\r
+ this._propertyList.clear();\r
+ }\r
+\r
+ /**\r
+ */\r
+ public void removeAllVref(\r
+ ) {\r
+ this._vrefList.clear();\r
+ }\r
+\r
+ /**\r
+ * Method removeProperty.\r
+ * \r
+ * @param vProperty\r
+ * @return true if the object was removed from the collection.\r
+ */\r
+ public boolean removeProperty(\r
+ final uk.ac.vamsas.objects.core.Property vProperty) {\r
+ boolean removed = _propertyList.remove(vProperty);\r
+ return removed;\r
+ }\r
+\r
+ /**\r
+ * Method removePropertyAt.\r
+ * \r
+ * @param index\r
+ * @return the element removed from the collection\r
+ */\r
+ public uk.ac.vamsas.objects.core.Property removePropertyAt(\r
+ final int index) {\r
+ java.lang.Object obj = this._propertyList.remove(index);\r
+ return (uk.ac.vamsas.objects.core.Property) obj;\r
+ }\r
+\r
+ /**\r
+ * Method removeVref.\r
+ * \r
+ * @param vVref\r
+ * @return true if the object was removed from the collection.\r
+ */\r
+ public boolean removeVref(\r
+ final uk.ac.vamsas.objects.core.Vref vVref) {\r
+ boolean removed = _vrefList.remove(vVref);\r
+ return removed;\r
+ }\r
+\r
+ /**\r
+ * Method removeVrefAt.\r
+ * \r
+ * @param index\r
+ * @return the element removed from the collection\r
+ */\r
+ public uk.ac.vamsas.objects.core.Vref removeVrefAt(\r
+ final int index) {\r
+ java.lang.Object obj = this._vrefList.remove(index);\r
+ return (uk.ac.vamsas.objects.core.Vref) obj;\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'description'. The field\r
+ * 'description' has the following description: Descriptive\r
+ * text for this node\r
+ * \r
+ * @param description the value of field 'description'.\r
+ */\r
+ public void setDescription(\r
+ final java.lang.String description) {\r
+ this._description = description;\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'id'. The field 'id' has the\r
+ * following description: Primary Key for vamsas object\r
+ * referencing \r
+ * \r
+ * @param id the value of field 'id'.\r
+ */\r
+ public void setId(\r
+ final java.lang.String id) {\r
+ this._id = id;\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'modifiable'.\r
+ * \r
+ * @param modifiable the value of field 'modifiable'.\r
+ */\r
+ public void setModifiable(\r
+ final java.lang.String modifiable) {\r
+ this._modifiable = modifiable;\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'name'. The field 'name' has the\r
+ * following description: Short name for this node\r
+ * \r
+ * @param name the value of field 'name'.\r
+ */\r
+ public void setName(\r
+ final java.lang.String name) {\r
+ this._name = name;\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vProperty\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void setProperty(\r
+ final int index,\r
+ final uk.ac.vamsas.objects.core.Property vProperty)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._propertyList.size()) {\r
+ throw new IndexOutOfBoundsException("setProperty: Index value '" + index + "' not in range [0.." + (this._propertyList.size() - 1) + "]");\r
+ }\r
+ \r
+ this._propertyList.set(index, vProperty);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param vPropertyArray\r
+ */\r
+ public void setProperty(\r
+ final uk.ac.vamsas.objects.core.Property[] vPropertyArray) {\r
+ //-- copy array\r
+ _propertyList.clear();\r
+ \r
+ for (int i = 0; i < vPropertyArray.length; i++) {\r
+ this._propertyList.add(vPropertyArray[i]);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Sets the value of '_propertyList' by copying the given\r
+ * Vector. All elements will be checked for type safety.\r
+ * \r
+ * @param vPropertyList the Vector to copy.\r
+ */\r
+ public void setProperty(\r
+ final java.util.Vector vPropertyList) {\r
+ // copy vector\r
+ this._propertyList.clear();\r
+ \r
+ this._propertyList.addAll(vPropertyList);\r
+ }\r
+\r
+ /**\r
+ * Sets the value of '_propertyList' by setting it to the given\r
+ * Vector. No type checking is performed.\r
+ * @deprecated\r
+ * \r
+ * @param propertyVector the Vector to set.\r
+ */\r
+ public void setPropertyAsReference(\r
+ final java.util.Vector propertyVector) {\r
+ this._propertyList = propertyVector;\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param index\r
+ * @param vVref\r
+ * @throws java.lang.IndexOutOfBoundsException if the index\r
+ * given is outside the bounds of the collection\r
+ */\r
+ public void setVref(\r
+ final int index,\r
+ final uk.ac.vamsas.objects.core.Vref vVref)\r
+ throws java.lang.IndexOutOfBoundsException {\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._vrefList.size()) {\r
+ throw new IndexOutOfBoundsException("setVref: Index value '" + index + "' not in range [0.." + (this._vrefList.size() - 1) + "]");\r
+ }\r
+ \r
+ this._vrefList.set(index, vVref);\r
+ }\r
+\r
+ /**\r
+ * \r
+ * \r
+ * @param vVrefArray\r
+ */\r
+ public void setVref(\r
+ final uk.ac.vamsas.objects.core.Vref[] vVrefArray) {\r
+ //-- copy array\r
+ _vrefList.clear();\r
+ \r
+ for (int i = 0; i < vVrefArray.length; i++) {\r
+ this._vrefList.add(vVrefArray[i]);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Sets the value of '_vrefList' by copying the given Vector.\r
+ * All elements will be checked for type safety.\r
+ * \r
+ * @param vVrefList the Vector to copy.\r
+ */\r
+ public void setVref(\r
+ final java.util.Vector vVrefList) {\r
+ // copy vector\r
+ this._vrefList.clear();\r
+ \r
+ this._vrefList.addAll(vVrefList);\r
+ }\r
+\r
+ /**\r
+ * Sets the value of '_vrefList' by setting it to the given\r
+ * Vector. No type checking is performed.\r
+ * @deprecated\r
+ * \r
+ * @param vrefVector the Vector to set.\r
+ */\r
+ public void setVrefAsReference(\r
+ final java.util.Vector vrefVector) {\r
+ this._vrefList = vrefVector;\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.NodeType.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 / commitdiff