refactored org to uk
[vamsas.git] / src / uk / ac / vamsas / objects / core / AlignmentAnnotation.java
diff --git a/src/uk/ac/vamsas/objects/core/AlignmentAnnotation.java b/src/uk/ac/vamsas/objects/core/AlignmentAnnotation.java
new file mode 100644 (file)
index 0000000..0177f31
--- /dev/null
@@ -0,0 +1,249 @@
+/*\r
+ * This class was automatically generated with \r
+ * <a href="http://www.castor.org">Castor 0.9.9M2</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 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
+ *  defined by all the columns in the alignment.\r
+ *  \r
+ * \r
+ * @version $Revision$ $Date$\r
+ */\r
+public class AlignmentAnnotation extends uk.ac.vamsas.objects.core.RangeAnnotation \r
+implements java.io.Serializable\r
+{\r
+\r
+\r
+      //--------------------------/\r
+     //- Class/Member Variables -/\r
+    //--------------------------/\r
+\r
+    /**\r
+     * 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
+    private boolean _graph;\r
+\r
+    /**\r
+     * keeps track of state for field: _graph\r
+     */\r
+    private boolean _has_graph;\r
+\r
+    /**\r
+     * Field _provenance\r
+     */\r
+    private uk.ac.vamsas.objects.core.Provenance _provenance;\r
+\r
+\r
+      //----------------/\r
+     //- Constructors -/\r
+    //----------------/\r
+\r
+    public AlignmentAnnotation() \r
+     {\r
+        super();\r
+    } //-- uk.ac.vamsas.objects.core.AlignmentAnnotation()\r
+\r
+\r
+      //-----------/\r
+     //- Methods -/\r
+    //-----------/\r
+\r
+    /**\r
+     * Method deleteGraph\r
+     * \r
+     */\r
+    public void deleteGraph()\r
+    {\r
+        this._has_graph= false;\r
+    } //-- void deleteGraph() \r
+\r
+    /**\r
+     * Note: hashCode() has not been overriden\r
+     * \r
+     * @param obj\r
+     * @return boolean\r
+     */\r
+    public boolean equals(java.lang.Object obj)\r
+    {\r
+        if ( this == obj )\r
+            return true;\r
+        \r
+        if (super.equals(obj)==false)\r
+            return false;\r
+        \r
+        if (obj instanceof AlignmentAnnotation) {\r
+        \r
+            AlignmentAnnotation temp = (AlignmentAnnotation)obj;\r
+            if (this._graph != temp._graph)\r
+                return false;\r
+            if (this._has_graph != temp._has_graph)\r
+                return false;\r
+            if (this._provenance != null) {\r
+                if (temp._provenance == null) return false;\r
+                else if (!(this._provenance.equals(temp._provenance))) \r
+                    return false;\r
+            }\r
+            else if (temp._provenance != null)\r
+                return false;\r
+            return true;\r
+        }\r
+        return false;\r
+    } //-- boolean equals(java.lang.Object) \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 boolean\r
+     * @return the value of field 'graph'.\r
+     */\r
+    public boolean getGraph()\r
+    {\r
+        return this._graph;\r
+    } //-- boolean getGraph() \r
+\r
+    /**\r
+     * Returns the value of field 'provenance'.\r
+     * \r
+     * @return Provenance\r
+     * @return the value of field 'provenance'.\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
+     * Method hasGraph\r
+     * \r
+     * \r
+     * \r
+     * @return boolean\r
+     */\r
+    public boolean hasGraph()\r
+    {\r
+        return this._has_graph;\r
+    } //-- boolean hasGraph() \r
+\r
+    /**\r
+     * Method isValid\r
+     * \r
+     * \r
+     * \r
+     * @return boolean\r
+     */\r
+    public boolean isValid()\r
+    {\r
+        try {\r
+            validate();\r
+        }\r
+        catch (org.exolab.castor.xml.ValidationException vex) {\r
+            return false;\r
+        }\r
+        return true;\r
+    } //-- boolean isValid() \r
+\r
+    /**\r
+     * Method marshal\r
+     * \r
+     * \r
+     * \r
+     * @param out\r
+     */\r
+    public void marshal(java.io.Writer out)\r
+        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
+    {\r
+        \r
+        Marshaller.marshal(this, out);\r
+    } //-- void marshal(java.io.Writer) \r
+\r
+    /**\r
+     * Method marshal\r
+     * \r
+     * \r
+     * \r
+     * @param handler\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
+        Marshaller.marshal(this, handler);\r
+    } //-- void marshal(org.xml.sax.ContentHandler) \r
+\r
+    /**\r
+     * Sets the value of field 'graph'. The field 'graph' has the\r
+     * 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
+     * @param graph the value of field 'graph'.\r
+     */\r
+    public void setGraph(boolean graph)\r
+    {\r
+        this._graph = graph;\r
+        this._has_graph = true;\r
+    } //-- void setGraph(boolean) \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
+        this._provenance = provenance;\r
+    } //-- void setProvenance(uk.ac.vamsas.objects.core.Provenance) \r
+\r
+    /**\r
+     * Method unmarshal\r
+     * \r
+     * \r
+     * \r
+     * @param reader\r
+     * @return 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
+\r
+    /**\r
+     * Method validate\r
+     * \r
+     */\r
+    public void validate()\r
+        throws org.exolab.castor.xml.ValidationException\r
+    {\r
+        org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
+        validator.validate(this);\r
+    } //-- void validate() \r
+\r
+}\r