src/org/vamsas/objects/core/Map.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 Map.\r
  26  * \r
  27  * @version $Revision$ $Date$\r
  28  */\r
  29 public class Map extends org.vamsas.client.Vobject \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      * Offset\r
  40      *  to\r
  41      *  first\r
  42      *  position\r
  43      *  in\r
  44      *  dataset\r
  45      *  sequence\r
  46      *  record\r
  47      *  that\r
  48      *  this\r
  49      *  database\r
  50      *  entry\r
  51      *  maps\r
  52      *  to\r
  53      *  \r
  54      */\r
  55     private int _from = 0;\r
  56 \r
  57     /**\r
  58      * keeps track of state for field: _from\r
  59      */\r
  60     private boolean _has_from;\r
  61 \r
  62     /**\r
  63      * Offset\r
  64      *  to\r
  65      *  last\r
  66      *  position\r
  67      *  in\r
  68      *  dataset\r
  69      *  sequence\r
  70      *  record\r
  71      *  that\r
  72      *  this\r
  73      *  database\r
  74      *  entry\r
  75      *  maps\r
  76      *  to\r
  77      *  \r
  78      */\r
  79     private int _to = 0;\r
  80 \r
  81     /**\r
  82      * keeps track of state for field: _to\r
  83      */\r
  84     private boolean _has_to;\r
  85 \r
  86     /**\r
  87      * Offset\r
  88      *  to first\r
  89      *  last\r
  90      *  position\r
  91      *  in\r
  92      *  database\r
  93      *  entry\r
  94      *  that\r
  95      *  first\r
  96      *  (or\r
  97      *  offset)\r
  98      *  position\r
  99      *  in\r
 100      *  sequence\r
 101      *  maps to\r
 102      *  \r
 103      */\r
 104     private int _start;\r
 105 \r
 106     /**\r
 107      * keeps track of state for field: _start\r
 108      */\r
 109     private boolean _has_start;\r
 110 \r
 111     /**\r
 112      * Offset\r
 113      *  to last\r
 114      *  position\r
 115      *  in\r
 116      *  database\r
 117      *  entry\r
 118      *  that\r
 119      *  last\r
 120      *  (offset)\r
 121      *  position\r
 122      *  in\r
 123      *  sequence\r
 124      *  maps to\r
 125      *  \r
 126      */\r
 127     private int _end;\r
 128 \r
 129     /**\r
 130      * keeps track of state for field: _end\r
 131      */\r
 132     private boolean _has_end;\r
 133 \r
 134 \r
 135       //----------------/\r
 136      //- Constructors -/\r
 137     //----------------/\r
 138 \r
 139     public Map() \r
 140      {\r
 141         super();\r
 142     } //-- org.vamsas.objects.core.Map()\r
 143 \r
 144 \r
 145       //-----------/\r
 146      //- Methods -/\r
 147     //-----------/\r
 148 \r
 149     /**\r
 150      * Method deleteEnd\r
 151      * \r
 152      */\r
 153     public void deleteEnd()\r
 154     {\r
 155         this._has_end= false;\r
 156     } //-- void deleteEnd() \r
 157 \r
 158     /**\r
 159      * Method deleteFrom\r
 160      * \r
 161      */\r
 162     public void deleteFrom()\r
 163     {\r
 164         this._has_from= false;\r
 165     } //-- void deleteFrom() \r
 166 \r
 167     /**\r
 168      * Method deleteStart\r
 169      * \r
 170      */\r
 171     public void deleteStart()\r
 172     {\r
 173         this._has_start= false;\r
 174     } //-- void deleteStart() \r
 175 \r
 176     /**\r
 177      * Method deleteTo\r
 178      * \r
 179      */\r
 180     public void deleteTo()\r
 181     {\r
 182         this._has_to= false;\r
 183     } //-- void deleteTo() \r
 184 \r
 185     /**\r
 186      * Note: hashCode() has not been overriden\r
 187      * \r
 188      * @param obj\r
 189      * @return boolean\r
 190      */\r
 191     public boolean equals(java.lang.Object obj)\r
 192     {\r
 193         if ( this == obj )\r
 194             return true;\r
 195         \r
 196         if (super.equals(obj)==false)\r
 197             return false;\r
 198         \r
 199         if (obj instanceof Map) {\r
 200         \r
 201             Map temp = (Map)obj;\r
 202             if (this._from != temp._from)\r
 203                 return false;\r
 204             if (this._has_from != temp._has_from)\r
 205                 return false;\r
 206             if (this._to != temp._to)\r
 207                 return false;\r
 208             if (this._has_to != temp._has_to)\r
 209                 return false;\r
 210             if (this._start != temp._start)\r
 211                 return false;\r
 212             if (this._has_start != temp._has_start)\r
 213                 return false;\r
 214             if (this._end != temp._end)\r
 215                 return false;\r
 216             if (this._has_end != temp._has_end)\r
 217                 return false;\r
 218             return true;\r
 219         }\r
 220         return false;\r
 221     } //-- boolean equals(java.lang.Object) \r
 222 \r
 223     /**\r
 224      * Returns the value of field 'end'. The field 'end' has the\r
 225      * following description: Offset\r
 226      *  to last\r
 227      *  position\r
 228      *  in\r
 229      *  database\r
 230      *  entry\r
 231      *  that\r
 232      *  last\r
 233      *  (offset)\r
 234      *  position\r
 235      *  in\r
 236      *  sequence\r
 237      *  maps to\r
 238      *  \r
 239      * \r
 240      * @return int\r
 241      * @return the value of field 'end'.\r
 242      */\r
 243     public int getEnd()\r
 244     {\r
 245         return this._end;\r
 246     } //-- int getEnd() \r
 247 \r
 248     /**\r
 249      * Returns the value of field 'from'. The field 'from' has the\r
 250      * following description: Offset\r
 251      *  to\r
 252      *  first\r
 253      *  position\r
 254      *  in\r
 255      *  dataset\r
 256      *  sequence\r
 257      *  record\r
 258      *  that\r
 259      *  this\r
 260      *  database\r
 261      *  entry\r
 262      *  maps\r
 263      *  to\r
 264      *  \r
 265      * \r
 266      * @return int\r
 267      * @return the value of field 'from'.\r
 268      */\r
 269     public int getFrom()\r
 270     {\r
 271         return this._from;\r
 272     } //-- int getFrom() \r
 273 \r
 274     /**\r
 275      * Returns the value of field 'start'. The field 'start' has\r
 276      * the following description: Offset\r
 277      *  to first\r
 278      *  last\r
 279      *  position\r
 280      *  in\r
 281      *  database\r
 282      *  entry\r
 283      *  that\r
 284      *  first\r
 285      *  (or\r
 286      *  offset)\r
 287      *  position\r
 288      *  in\r
 289      *  sequence\r
 290      *  maps to\r
 291      *  \r
 292      * \r
 293      * @return int\r
 294      * @return the value of field 'start'.\r
 295      */\r
 296     public int getStart()\r
 297     {\r
 298         return this._start;\r
 299     } //-- int getStart() \r
 300 \r
 301     /**\r
 302      * Returns the value of field 'to'. The field 'to' has the\r
 303      * following description: Offset\r
 304      *  to\r
 305      *  last\r
 306      *  position\r
 307      *  in\r
 308      *  dataset\r
 309      *  sequence\r
 310      *  record\r
 311      *  that\r
 312      *  this\r
 313      *  database\r
 314      *  entry\r
 315      *  maps\r
 316      *  to\r
 317      *  \r
 318      * \r
 319      * @return int\r
 320      * @return the value of field 'to'.\r
 321      */\r
 322     public int getTo()\r
 323     {\r
 324         return this._to;\r
 325     } //-- int getTo() \r
 326 \r
 327     /**\r
 328      * Method hasEnd\r
 329      * \r
 330      * \r
 331      * \r
 332      * @return boolean\r
 333      */\r
 334     public boolean hasEnd()\r
 335     {\r
 336         return this._has_end;\r
 337     } //-- boolean hasEnd() \r
 338 \r
 339     /**\r
 340      * Method hasFrom\r
 341      * \r
 342      * \r
 343      * \r
 344      * @return boolean\r
 345      */\r
 346     public boolean hasFrom()\r
 347     {\r
 348         return this._has_from;\r
 349     } //-- boolean hasFrom() \r
 350 \r
 351     /**\r
 352      * Method hasStart\r
 353      * \r
 354      * \r
 355      * \r
 356      * @return boolean\r
 357      */\r
 358     public boolean hasStart()\r
 359     {\r
 360         return this._has_start;\r
 361     } //-- boolean hasStart() \r
 362 \r
 363     /**\r
 364      * Method hasTo\r
 365      * \r
 366      * \r
 367      * \r
 368      * @return boolean\r
 369      */\r
 370     public boolean hasTo()\r
 371     {\r
 372         return this._has_to;\r
 373     } //-- boolean hasTo() \r
 374 \r
 375     /**\r
 376      * Method isValid\r
 377      * \r
 378      * \r
 379      * \r
 380      * @return boolean\r
 381      */\r
 382     public boolean isValid()\r
 383     {\r
 384         try {\r
 385             validate();\r
 386         }\r
 387         catch (org.exolab.castor.xml.ValidationException vex) {\r
 388             return false;\r
 389         }\r
 390         return true;\r
 391     } //-- boolean isValid() \r
 392 \r
 393     /**\r
 394      * Method marshal\r
 395      * \r
 396      * \r
 397      * \r
 398      * @param out\r
 399      */\r
 400     public void marshal(java.io.Writer out)\r
 401         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 402     {\r
 403         \r
 404         Marshaller.marshal(this, out);\r
 405     } //-- void marshal(java.io.Writer) \r
 406 \r
 407     /**\r
 408      * Method marshal\r
 409      * \r
 410      * \r
 411      * \r
 412      * @param handler\r
 413      */\r
 414     public void marshal(org.xml.sax.ContentHandler handler)\r
 415         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 416     {\r
 417         \r
 418         Marshaller.marshal(this, handler);\r
 419     } //-- void marshal(org.xml.sax.ContentHandler) \r
 420 \r
 421     /**\r
 422      * Sets the value of field 'end'. The field 'end' has the\r
 423      * following description: Offset\r
 424      *  to last\r
 425      *  position\r
 426      *  in\r
 427      *  database\r
 428      *  entry\r
 429      *  that\r
 430      *  last\r
 431      *  (offset)\r
 432      *  position\r
 433      *  in\r
 434      *  sequence\r
 435      *  maps to\r
 436      *  \r
 437      * \r
 438      * @param end the value of field 'end'.\r
 439      */\r
 440     public void setEnd(int end)\r
 441     {\r
 442         this._end = end;\r
 443         this._has_end = true;\r
 444     } //-- void setEnd(int) \r
 445 \r
 446     /**\r
 447      * Sets the value of field 'from'. The field 'from' has the\r
 448      * following description: Offset\r
 449      *  to\r
 450      *  first\r
 451      *  position\r
 452      *  in\r
 453      *  dataset\r
 454      *  sequence\r
 455      *  record\r
 456      *  that\r
 457      *  this\r
 458      *  database\r
 459      *  entry\r
 460      *  maps\r
 461      *  to\r
 462      *  \r
 463      * \r
 464      * @param from the value of field 'from'.\r
 465      */\r
 466     public void setFrom(int from)\r
 467     {\r
 468         this._from = from;\r
 469         this._has_from = true;\r
 470     } //-- void setFrom(int) \r
 471 \r
 472     /**\r
 473      * Sets the value of field 'start'. The field 'start' has the\r
 474      * following description: Offset\r
 475      *  to first\r
 476      *  last\r
 477      *  position\r
 478      *  in\r
 479      *  database\r
 480      *  entry\r
 481      *  that\r
 482      *  first\r
 483      *  (or\r
 484      *  offset)\r
 485      *  position\r
 486      *  in\r
 487      *  sequence\r
 488      *  maps to\r
 489      *  \r
 490      * \r
 491      * @param start the value of field 'start'.\r
 492      */\r
 493     public void setStart(int start)\r
 494     {\r
 495         this._start = start;\r
 496         this._has_start = true;\r
 497     } //-- void setStart(int) \r
 498 \r
 499     /**\r
 500      * Sets the value of field 'to'. The field 'to' has the\r
 501      * following description: Offset\r
 502      *  to\r
 503      *  last\r
 504      *  position\r
 505      *  in\r
 506      *  dataset\r
 507      *  sequence\r
 508      *  record\r
 509      *  that\r
 510      *  this\r
 511      *  database\r
 512      *  entry\r
 513      *  maps\r
 514      *  to\r
 515      *  \r
 516      * \r
 517      * @param to the value of field 'to'.\r
 518      */\r
 519     public void setTo(int to)\r
 520     {\r
 521         this._to = to;\r
 522         this._has_to = true;\r
 523     } //-- void setTo(int) \r
 524 \r
 525     /**\r
 526      * Method unmarshal\r
 527      * \r
 528      * \r
 529      * \r
 530      * @param reader\r
 531      * @return Map\r
 532      */\r
 533     public static org.vamsas.objects.core.Map unmarshal(java.io.Reader reader)\r
 534         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 535     {\r
 536         return (org.vamsas.objects.core.Map) Unmarshaller.unmarshal(org.vamsas.objects.core.Map.class, reader);\r
 537     } //-- org.vamsas.objects.core.Map unmarshal(java.io.Reader) \r
 538 \r
 539     /**\r
 540      * Method validate\r
 541      * \r
 542      */\r
 543     public void validate()\r
 544         throws org.exolab.castor.xml.ValidationException\r
 545     {\r
 546         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 547         validator.validate(this);\r
 548     } //-- void validate() \r
 549 \r
 550 }\r