/*\r
* This class was automatically generated with \r
- * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML\r
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
* Schema.\r
* $Id$\r
*/\r
//- Imported classes and packages -/\r
//---------------------------------/\r
\r
-import java.io.IOException;\r
-import java.io.Reader;\r
-import java.io.Serializable;\r
-import java.io.Writer;\r
-import org.exolab.castor.xml.MarshalException;\r
import org.exolab.castor.xml.Marshaller;\r
import org.exolab.castor.xml.Unmarshaller;\r
-import org.exolab.castor.xml.ValidationException;\r
-import org.xml.sax.ContentHandler;\r
\r
/**\r
* This is annotation over the coordinate frame\r
private boolean _has_graph;\r
\r
/**\r
- * Field _provenance\r
+ * Field _provenance.\r
*/\r
private uk.ac.vamsas.objects.core.Provenance _provenance;\r
\r
//- Constructors -/\r
//----------------/\r
\r
- public AlignmentAnnotation() \r
- {\r
+ public AlignmentAnnotation() {\r
super();\r
- } //-- uk.ac.vamsas.objects.core.AlignmentAnnotation()\r
+ }\r
\r
\r
//-----------/\r
//-----------/\r
\r
/**\r
- * Method deleteGraph\r
- * \r
*/\r
- public void deleteGraph()\r
- {\r
+ public void deleteGraph(\r
+ ) {\r
this._has_graph= false;\r
- } //-- void deleteGraph() \r
+ }\r
\r
/**\r
- * Note: hashCode() has not been overriden\r
+ * Overrides the java.lang.Object.equals method.\r
* \r
* @param obj\r
- * @return boolean\r
+ * @return true if the objects are equal.\r
*/\r
- public boolean equals(java.lang.Object obj)\r
- {\r
+ public boolean equals(\r
+ final java.lang.Object obj) {\r
if ( this == obj )\r
return true;\r
\r
return true;\r
}\r
return false;\r
- } //-- boolean equals(java.lang.Object) \r
+ }\r
\r
/**\r
* Returns the value of field 'graph'. The field 'graph' has\r
* the annotationElement values together form a\r
* graph \r
* \r
- * @return boolean\r
- * @return the value of field 'graph'.\r
+ * @return the value of field 'Graph'.\r
*/\r
- public boolean getGraph()\r
- {\r
+ public boolean getGraph(\r
+ ) {\r
return this._graph;\r
- } //-- boolean getGraph() \r
+ }\r
\r
/**\r
* Returns the value of field 'provenance'.\r
* \r
- * @return Provenance\r
- * @return the value of field 'provenance'.\r
+ * @return the value of field 'Provenance'.\r
*/\r
- public uk.ac.vamsas.objects.core.Provenance getProvenance()\r
- {\r
+ public uk.ac.vamsas.objects.core.Provenance getProvenance(\r
+ ) {\r
return this._provenance;\r
- } //-- uk.ac.vamsas.objects.core.Provenance getProvenance() \r
+ }\r
\r
/**\r
- * Method hasGraph\r
- * \r
+ * Method hasGraph.\r
* \r
- * \r
- * @return boolean\r
+ * @return true if at least one Graph has been added\r
*/\r
- public boolean hasGraph()\r
- {\r
+ public boolean hasGraph(\r
+ ) {\r
return this._has_graph;\r
- } //-- boolean hasGraph() \r
+ }\r
\r
/**\r
- * Method isValid\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
+ result = 37 * result + (_graph?0:1);\r
+ if (_provenance != null) {\r
+ result = 37 * result + _provenance.hashCode();\r
+ }\r
+ \r
+ return result;\r
+ }\r
+\r
+ /**\r
+ * Returns the value of field 'graph'. The field 'graph' has\r
+ * the following description: TODO: decide if this flag is\r
+ * redundant - when true it would suggest that\r
+ * the annotationElement values together form a\r
+ * graph \r
* \r
+ * @return the value of field 'Graph'.\r
+ */\r
+ public boolean isGraph(\r
+ ) {\r
+ return this._graph;\r
+ }\r
+\r
+ /**\r
+ * Method isValid.\r
* \r
- * @return boolean\r
+ * @return true if this object is valid according to the schema\r
*/\r
- public boolean isValid()\r
- {\r
+ public boolean isValid(\r
+ ) {\r
try {\r
validate();\r
- }\r
- catch (org.exolab.castor.xml.ValidationException vex) {\r
+ } catch (org.exolab.castor.xml.ValidationException vex) {\r
return false;\r
}\r
return true;\r
- } //-- boolean isValid() \r
+ }\r
\r
/**\r
- * Method marshal\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(java.io.Writer out)\r
- throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
- {\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
- } //-- void marshal(java.io.Writer) \r
+ }\r
\r
/**\r
- * Method marshal\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(org.xml.sax.ContentHandler handler)\r
- throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
- {\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
- } //-- void marshal(org.xml.sax.ContentHandler) \r
+ }\r
\r
/**\r
* Sets the value of field 'graph'. The field 'graph' has the\r
* \r
* @param graph the value of field 'graph'.\r
*/\r
- public void setGraph(boolean graph)\r
- {\r
+ public void setGraph(\r
+ final boolean graph) {\r
this._graph = graph;\r
this._has_graph = true;\r
- } //-- void setGraph(boolean) \r
+ }\r
\r
/**\r
* Sets the value of field 'provenance'.\r
* \r
* @param provenance the value of field 'provenance'.\r
*/\r
- public void setProvenance(uk.ac.vamsas.objects.core.Provenance provenance)\r
- {\r
+ public void setProvenance(\r
+ final uk.ac.vamsas.objects.core.Provenance provenance) {\r
this._provenance = provenance;\r
- } //-- void setProvenance(uk.ac.vamsas.objects.core.Provenance) \r
+ }\r
\r
/**\r
- * Method unmarshal\r
- * \r
- * \r
+ * Method unmarshal.\r
* \r
* @param reader\r
- * @return RangeType\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.RangeType\r
*/\r
- public static uk.ac.vamsas.objects.core.RangeType unmarshal(java.io.Reader reader)\r
- throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
- {\r
- return (uk.ac.vamsas.objects.core.AlignmentAnnotation) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.AlignmentAnnotation.class, reader);\r
- } //-- uk.ac.vamsas.objects.core.RangeType unmarshal(java.io.Reader) \r
+ public static uk.ac.vamsas.objects.core.RangeType 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.RangeType) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.AlignmentAnnotation.class, reader);\r
+ }\r
\r
/**\r
- * Method validate\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
- throws org.exolab.castor.xml.ValidationException\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
- } //-- void validate() \r
+ }\r
\r
}\r
git://source.jalview.org / vamsas.git / blobdiff