src/uk/ac/vamsas/objects/core/AlignmentAnnotation.java

   1 /*\r
   2  * This class was automatically generated with \r
   3  * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML\r
   4  * Schema.\r
   5  * $Id$\r
   6  */\r
   7 \r
   8 package uk.ac.vamsas.objects.core;\r
   9 \r
  10   //---------------------------------/\r
  11  //- Imported classes and packages -/\r
  12 //---------------------------------/\r
  13 \r
  14 import java.io.IOException;\r
  15 import java.io.Reader;\r
  16 import java.io.Serializable;\r
  17 import java.io.Writer;\r
  18 import org.exolab.castor.xml.MarshalException;\r
  19 import org.exolab.castor.xml.Marshaller;\r
  20 import org.exolab.castor.xml.Unmarshaller;\r
  21 import org.exolab.castor.xml.ValidationException;\r
  22 import org.xml.sax.ContentHandler;\r
  23 \r
  24 /**\r
  25  * This is annotation over the coordinate frame\r
  26  *  defined by all the columns in the alignment.\r
  27  *  \r
  28  * \r
  29  * @version $Revision$ $Date$\r
  30  */\r
  31 public class AlignmentAnnotation extends uk.ac.vamsas.objects.core.RangeAnnotation \r
  32 implements java.io.Serializable\r
  33 {\r
  34 \r
  35 \r
  36       //--------------------------/\r
  37      //- Class/Member Variables -/\r
  38     //--------------------------/\r
  39 \r
  40     /**\r
  41      * TODO: decide if this flag is\r
  42      *  redundant - when true it would suggest that\r
  43      *  the annotationElement values together form a\r
  44      *  graph \r
  45      */\r
  46     private boolean _graph;\r
  47 \r
  48     /**\r
  49      * keeps track of state for field: _graph\r
  50      */\r
  51     private boolean _has_graph;\r
  52 \r
  53     /**\r
  54      * Field _provenance\r
  55      */\r
  56     private uk.ac.vamsas.objects.core.Provenance _provenance;\r
  57 \r
  58 \r
  59       //----------------/\r
  60      //- Constructors -/\r
  61     //----------------/\r
  62 \r
  63     public AlignmentAnnotation() \r
  64      {\r
  65         super();\r
  66     } //-- uk.ac.vamsas.objects.core.AlignmentAnnotation()\r
  67 \r
  68 \r
  69       //-----------/\r
  70      //- Methods -/\r
  71     //-----------/\r
  72 \r
  73     /**\r
  74      * Method deleteGraph\r
  75      * \r
  76      */\r
  77     public void deleteGraph()\r
  78     {\r
  79         this._has_graph= false;\r
  80     } //-- void deleteGraph() \r
  81 \r
  82     /**\r
  83      * Note: hashCode() has not been overriden\r
  84      * \r
  85      * @param obj\r
  86      * @return boolean\r
  87      */\r
  88     public boolean equals(java.lang.Object obj)\r
  89     {\r
  90         if ( this == obj )\r
  91             return true;\r
  92         \r
  93         if (super.equals(obj)==false)\r
  94             return false;\r
  95         \r
  96         if (obj instanceof AlignmentAnnotation) {\r
  97         \r
  98             AlignmentAnnotation temp = (AlignmentAnnotation)obj;\r
  99             if (this._graph != temp._graph)\r
 100                 return false;\r
 101             if (this._has_graph != temp._has_graph)\r
 102                 return false;\r
 103             if (this._provenance != null) {\r
 104                 if (temp._provenance == null) return false;\r
 105                 else if (!(this._provenance.equals(temp._provenance))) \r
 106                     return false;\r
 107             }\r
 108             else if (temp._provenance != null)\r
 109                 return false;\r
 110             return true;\r
 111         }\r
 112         return false;\r
 113     } //-- boolean equals(java.lang.Object) \r
 114 \r
 115     /**\r
 116      * Returns the value of field 'graph'. The field 'graph' has\r
 117      * the following description: TODO: decide if this flag is\r
 118      *  redundant - when true it would suggest that\r
 119      *  the annotationElement values together form a\r
 120      *  graph \r
 121      * \r
 122      * @return boolean\r
 123      * @return the value of field 'graph'.\r
 124      */\r
 125     public boolean getGraph()\r
 126     {\r
 127         return this._graph;\r
 128     } //-- boolean getGraph() \r
 129 \r
 130     /**\r
 131      * Returns the value of field 'provenance'.\r
 132      * \r
 133      * @return Provenance\r
 134      * @return the value of field 'provenance'.\r
 135      */\r
 136     public uk.ac.vamsas.objects.core.Provenance getProvenance()\r
 137     {\r
 138         return this._provenance;\r
 139     } //-- uk.ac.vamsas.objects.core.Provenance getProvenance() \r
 140 \r
 141     /**\r
 142      * Method hasGraph\r
 143      * \r
 144      * \r
 145      * \r
 146      * @return boolean\r
 147      */\r
 148     public boolean hasGraph()\r
 149     {\r
 150         return this._has_graph;\r
 151     } //-- boolean hasGraph() \r
 152 \r
 153     /**\r
 154      * Method isValid\r
 155      * \r
 156      * \r
 157      * \r
 158      * @return boolean\r
 159      */\r
 160     public boolean isValid()\r
 161     {\r
 162         try {\r
 163             validate();\r
 164         }\r
 165         catch (org.exolab.castor.xml.ValidationException vex) {\r
 166             return false;\r
 167         }\r
 168         return true;\r
 169     } //-- boolean isValid() \r
 170 \r
 171     /**\r
 172      * Method marshal\r
 173      * \r
 174      * \r
 175      * \r
 176      * @param out\r
 177      */\r
 178     public void marshal(java.io.Writer out)\r
 179         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 180     {\r
 181         \r
 182         Marshaller.marshal(this, out);\r
 183     } //-- void marshal(java.io.Writer) \r
 184 \r
 185     /**\r
 186      * Method marshal\r
 187      * \r
 188      * \r
 189      * \r
 190      * @param handler\r
 191      */\r
 192     public void marshal(org.xml.sax.ContentHandler handler)\r
 193         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 194     {\r
 195         \r
 196         Marshaller.marshal(this, handler);\r
 197     } //-- void marshal(org.xml.sax.ContentHandler) \r
 198 \r
 199     /**\r
 200      * Sets the value of field 'graph'. The field 'graph' has the\r
 201      * following description: TODO: decide if this flag is\r
 202      *  redundant - when true it would suggest that\r
 203      *  the annotationElement values together form a\r
 204      *  graph \r
 205      * \r
 206      * @param graph the value of field 'graph'.\r
 207      */\r
 208     public void setGraph(boolean graph)\r
 209     {\r
 210         this._graph = graph;\r
 211         this._has_graph = true;\r
 212     } //-- void setGraph(boolean) \r
 213 \r
 214     /**\r
 215      * Sets the value of field 'provenance'.\r
 216      * \r
 217      * @param provenance the value of field 'provenance'.\r
 218      */\r
 219     public void setProvenance(uk.ac.vamsas.objects.core.Provenance provenance)\r
 220     {\r
 221         this._provenance = provenance;\r
 222     } //-- void setProvenance(uk.ac.vamsas.objects.core.Provenance) \r
 223 \r
 224     /**\r
 225      * Method unmarshal\r
 226      * \r
 227      * \r
 228      * \r
 229      * @param reader\r
 230      * @return RangeType\r
 231      */\r
 232     public static uk.ac.vamsas.objects.core.RangeType unmarshal(java.io.Reader reader)\r
 233         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 234     {\r
 235         return (uk.ac.vamsas.objects.core.AlignmentAnnotation) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.AlignmentAnnotation.class, reader);\r
 236     } //-- uk.ac.vamsas.objects.core.RangeType unmarshal(java.io.Reader) \r
 237 \r
 238     /**\r
 239      * Method validate\r
 240      * \r
 241      */\r
 242     public void validate()\r
 243         throws org.exolab.castor.xml.ValidationException\r
 244     {\r
 245         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 246         validator.validate(this);\r
 247     } //-- void validate() \r
 248 \r
 249 }\r