src/org/vamsas/objects/core/AlignmentSequenceAnnotation.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 org.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  * Class AlignmentSequenceAnnotation.\r
  26  * \r
  27  * @version $Revision$ $Date$\r
  28  */\r
  29 public class AlignmentSequenceAnnotation extends org.vamsas.objects.core.RangeAnnotation \r
  30 implements java.io.Serializable\r
  31 {\r
  32 \r
  33 \r
  34       //--------------------------/\r
  35      //- Class/Member Variables -/\r
  36     //--------------------------/\r
  37 \r
  38     /**\r
  39      * TODO:\r
  40      *  decide\r
  41      *  if\r
  42      *  this\r
  43      *  flag\r
  44      *  is\r
  45      *  redundant\r
  46      *  -\r
  47      *  when\r
  48      *  true\r
  49      *  it\r
  50      *  would\r
  51      *  suggest\r
  52      *  that\r
  53      *  the\r
  54      *  annotationElement\r
  55      *  values\r
  56      *  together\r
  57      *  form\r
  58      *  a\r
  59      *  graph\r
  60      *  \r
  61      */\r
  62     private boolean _graph;\r
  63 \r
  64     /**\r
  65      * keeps track of state for field: _graph\r
  66      */\r
  67     private boolean _has_graph;\r
  68 \r
  69     /**\r
  70      * Field _provenance\r
  71      */\r
  72     private org.vamsas.objects.core.Provenance _provenance;\r
  73 \r
  74 \r
  75       //----------------/\r
  76      //- Constructors -/\r
  77     //----------------/\r
  78 \r
  79     public AlignmentSequenceAnnotation() \r
  80      {\r
  81         super();\r
  82     } //-- org.vamsas.objects.core.AlignmentSequenceAnnotation()\r
  83 \r
  84 \r
  85       //-----------/\r
  86      //- Methods -/\r
  87     //-----------/\r
  88 \r
  89     /**\r
  90      * Method deleteGraph\r
  91      * \r
  92      */\r
  93     public void deleteGraph()\r
  94     {\r
  95         this._has_graph= false;\r
  96     } //-- void deleteGraph() \r
  97 \r
  98     /**\r
  99      * Note: hashCode() has not been overriden\r
 100      * \r
 101      * @param obj\r
 102      * @return boolean\r
 103      */\r
 104     public boolean equals(java.lang.Object obj)\r
 105     {\r
 106         if ( this == obj )\r
 107             return true;\r
 108         \r
 109         if (super.equals(obj)==false)\r
 110             return false;\r
 111         \r
 112         if (obj instanceof AlignmentSequenceAnnotation) {\r
 113         \r
 114             AlignmentSequenceAnnotation temp = (AlignmentSequenceAnnotation)obj;\r
 115             if (this._graph != temp._graph)\r
 116                 return false;\r
 117             if (this._has_graph != temp._has_graph)\r
 118                 return false;\r
 119             if (this._provenance != null) {\r
 120                 if (temp._provenance == null) return false;\r
 121                 else if (!(this._provenance.equals(temp._provenance))) \r
 122                     return false;\r
 123             }\r
 124             else if (temp._provenance != null)\r
 125                 return false;\r
 126             return true;\r
 127         }\r
 128         return false;\r
 129     } //-- boolean equals(java.lang.Object) \r
 130 \r
 131     /**\r
 132      * Returns the value of field 'graph'. The field 'graph' has\r
 133      * the following description: TODO:\r
 134      *  decide\r
 135      *  if\r
 136      *  this\r
 137      *  flag\r
 138      *  is\r
 139      *  redundant\r
 140      *  -\r
 141      *  when\r
 142      *  true\r
 143      *  it\r
 144      *  would\r
 145      *  suggest\r
 146      *  that\r
 147      *  the\r
 148      *  annotationElement\r
 149      *  values\r
 150      *  together\r
 151      *  form\r
 152      *  a\r
 153      *  graph\r
 154      *  \r
 155      * \r
 156      * @return boolean\r
 157      * @return the value of field 'graph'.\r
 158      */\r
 159     public boolean getGraph()\r
 160     {\r
 161         return this._graph;\r
 162     } //-- boolean getGraph() \r
 163 \r
 164     /**\r
 165      * Returns the value of field 'provenance'.\r
 166      * \r
 167      * @return Provenance\r
 168      * @return the value of field 'provenance'.\r
 169      */\r
 170     public org.vamsas.objects.core.Provenance getProvenance()\r
 171     {\r
 172         return this._provenance;\r
 173     } //-- org.vamsas.objects.core.Provenance getProvenance() \r
 174 \r
 175     /**\r
 176      * Method hasGraph\r
 177      * \r
 178      * \r
 179      * \r
 180      * @return boolean\r
 181      */\r
 182     public boolean hasGraph()\r
 183     {\r
 184         return this._has_graph;\r
 185     } //-- boolean hasGraph() \r
 186 \r
 187     /**\r
 188      * Method isValid\r
 189      * \r
 190      * \r
 191      * \r
 192      * @return boolean\r
 193      */\r
 194     public boolean isValid()\r
 195     {\r
 196         try {\r
 197             validate();\r
 198         }\r
 199         catch (org.exolab.castor.xml.ValidationException vex) {\r
 200             return false;\r
 201         }\r
 202         return true;\r
 203     } //-- boolean isValid() \r
 204 \r
 205     /**\r
 206      * Method marshal\r
 207      * \r
 208      * \r
 209      * \r
 210      * @param out\r
 211      */\r
 212     public void marshal(java.io.Writer out)\r
 213         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 214     {\r
 215         \r
 216         Marshaller.marshal(this, out);\r
 217     } //-- void marshal(java.io.Writer) \r
 218 \r
 219     /**\r
 220      * Method marshal\r
 221      * \r
 222      * \r
 223      * \r
 224      * @param handler\r
 225      */\r
 226     public void marshal(org.xml.sax.ContentHandler handler)\r
 227         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 228     {\r
 229         \r
 230         Marshaller.marshal(this, handler);\r
 231     } //-- void marshal(org.xml.sax.ContentHandler) \r
 232 \r
 233     /**\r
 234      * Sets the value of field 'graph'. The field 'graph' has the\r
 235      * following description: TODO:\r
 236      *  decide\r
 237      *  if\r
 238      *  this\r
 239      *  flag\r
 240      *  is\r
 241      *  redundant\r
 242      *  -\r
 243      *  when\r
 244      *  true\r
 245      *  it\r
 246      *  would\r
 247      *  suggest\r
 248      *  that\r
 249      *  the\r
 250      *  annotationElement\r
 251      *  values\r
 252      *  together\r
 253      *  form\r
 254      *  a\r
 255      *  graph\r
 256      *  \r
 257      * \r
 258      * @param graph the value of field 'graph'.\r
 259      */\r
 260     public void setGraph(boolean graph)\r
 261     {\r
 262         this._graph = graph;\r
 263         this._has_graph = true;\r
 264     } //-- void setGraph(boolean) \r
 265 \r
 266     /**\r
 267      * Sets the value of field 'provenance'.\r
 268      * \r
 269      * @param provenance the value of field 'provenance'.\r
 270      */\r
 271     public void setProvenance(org.vamsas.objects.core.Provenance provenance)\r
 272     {\r
 273         this._provenance = provenance;\r
 274     } //-- void setProvenance(org.vamsas.objects.core.Provenance) \r
 275 \r
 276     /**\r
 277      * Method unmarshal\r
 278      * \r
 279      * \r
 280      * \r
 281      * @param reader\r
 282      * @return RangeType\r
 283      */\r
 284     public static org.vamsas.objects.core.RangeType unmarshal(java.io.Reader reader)\r
 285         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 286     {\r
 287         return (org.vamsas.objects.core.AlignmentSequenceAnnotation) Unmarshaller.unmarshal(org.vamsas.objects.core.AlignmentSequenceAnnotation.class, reader);\r
 288     } //-- org.vamsas.objects.core.RangeType unmarshal(java.io.Reader) \r
 289 \r
 290     /**\r
 291      * Method validate\r
 292      * \r
 293      */\r
 294     public void validate()\r
 295         throws org.exolab.castor.xml.ValidationException\r
 296     {\r
 297         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 298         validator.validate(this);\r
 299     } //-- void validate() \r
 300 \r
 301 }\r