applied LGPLv3 and source code formatting.
[vamsas.git] / src / uk / ac / vamsas / objects / core / Map.java
index 561589c..06ea745 100644 (file)
 /*\r
- * This class was automatically generated with \r
- * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
- * Schema.\r
- * $Id$\r
+ * This file is part of the Vamsas Client version 0.1. \r
+ * Copyright 2009 by Jim Procter, Iain Milne, Pierre Marguerite, \r
+ *  Andrew Waterhouse and Dominik Lindner.\r
+ * \r
+ * Earlier versions have also been incorporated into Jalview version 2.4 \r
+ * since 2008, and TOPALi version 2 since 2007.\r
+ * \r
+ * The Vamsas Client is free software: you can redistribute it and/or modify\r
+ * it under the terms of the GNU Lesser General Public License as published by\r
+ * the Free Software Foundation, either version 3 of the License, or\r
+ * (at your option) any later version.\r
+ *  \r
+ * The Vamsas Client is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU Lesser General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU Lesser General Public License\r
+ * along with the Vamsas Client.  If not, see <http://www.gnu.org/licenses/>.\r
  */\r
-\r
 package uk.ac.vamsas.objects.core;\r
 \r
-  //---------------------------------/\r
- //- Imported classes and packages -/\r
+//---------------------------------/\r
+//- Imported classes and packages -/\r
 //---------------------------------/\r
 \r
 import org.exolab.castor.xml.Marshaller;\r
 import org.exolab.castor.xml.Unmarshaller;\r
 \r
 /**\r
- * the local mapType maps from the parent\r
- *  sequence coordinate frame to the reference\r
- *  frame defined by the dbRef element.\r
- *  The mapped mapType is the mapped range defined\r
- *  on the dbRef element's reference frame.\r
- *  Conventionally, the unit attribute defaults to 1, or\r
- *  will be inferred from the local sequence's\r
- *  dictionary type and any dictionary type associated\r
- *  with the database being mapped to. \r
- *  However, it may be used to avoid ambiguity.\r
- *  \r
+ * the local mapType maps from the parent sequence coordinate frame to the\r
+ * reference frame defined by the dbRef element. The mapped mapType is the\r
+ * mapped range defined on the dbRef element's reference frame. Conventionally,\r
+ * the unit attribute defaults to 1, or will be inferred from the local\r
+ * sequence's dictionary type and any dictionary type associated with the\r
+ * database being mapped to. However, it may be used to avoid ambiguity.\r
+ * \r
  * \r
  * @version $Revision$ $Date$\r
  */\r
-public class Map extends uk.ac.vamsas.objects.core.MapType \r
-implements java.io.Serializable\r
-{\r
-\r
-\r
-      //--------------------------/\r
-     //- Class/Member Variables -/\r
-    //--------------------------/\r
-\r
-    /**\r
-     * Field _id.\r
-     */\r
-    private java.lang.String _id;\r
-\r
-\r
-      //----------------/\r
-     //- Constructors -/\r
-    //----------------/\r
-\r
-    public Map() {\r
-        super();\r
-    }\r
-\r
-\r
-      //-----------/\r
-     //- Methods -/\r
-    //-----------/\r
-\r
-    /**\r
-     * Overrides the java.lang.Object.equals method.\r
-     * \r
-     * @param obj\r
-     * @return true if the objects are equal.\r
-     */\r
-    public boolean equals(\r
-            final java.lang.Object obj) {\r
-        if ( this == obj )\r
-            return true;\r
-        \r
-        if (super.equals(obj)==false)\r
+public class Map extends uk.ac.vamsas.objects.core.MapType implements\r
+    java.io.Serializable {\r
+\r
+  // --------------------------/\r
+  // - Class/Member Variables -/\r
+  // --------------------------/\r
+\r
+  /**\r
+   * Field _id.\r
+   */\r
+  private java.lang.String _id;\r
+\r
+  // ----------------/\r
+  // - Constructors -/\r
+  // ----------------/\r
+\r
+  public Map() {\r
+    super();\r
+  }\r
+\r
+  // -----------/\r
+  // - Methods -/\r
+  // -----------/\r
+\r
+  /**\r
+   * Overrides the java.lang.Object.equals method.\r
+   * \r
+   * @param obj\r
+   * @return true if the objects are equal.\r
+   */\r
+  public boolean equals(final java.lang.Object obj) {\r
+    if (this == obj)\r
+      return true;\r
+\r
+    if (super.equals(obj) == false)\r
+      return false;\r
+\r
+    if (obj instanceof Map) {\r
+\r
+      Map temp = (Map) obj;\r
+      boolean thcycle;\r
+      boolean tmcycle;\r
+      if (this._id != null) {\r
+        if (temp._id == null)\r
+          return false;\r
+        if (this._id != temp._id) {\r
+          thcycle = org.castor.util.CycleBreaker.startingToCycle(this._id);\r
+          tmcycle = org.castor.util.CycleBreaker.startingToCycle(temp._id);\r
+          if (thcycle != tmcycle) {\r
+            if (!thcycle) {\r
+              org.castor.util.CycleBreaker.releaseCycleHandle(this._id);\r
+            }\r
+            ;\r
+            if (!tmcycle) {\r
+              org.castor.util.CycleBreaker.releaseCycleHandle(temp._id);\r
+            }\r
+            ;\r
             return false;\r
-        \r
-        if (obj instanceof Map) {\r
-        \r
-            Map temp = (Map)obj;\r
-            boolean thcycle;\r
-            boolean tmcycle;\r
-            if (this._id != null) {\r
-                if (temp._id == null) return false;\r
-                if (this._id != temp._id) {\r
-                    thcycle=org.castor.util.CycleBreaker.startingToCycle(this._id);\r
-                    tmcycle=org.castor.util.CycleBreaker.startingToCycle(temp._id);\r
-                    if (thcycle!=tmcycle) {\r
-                        if (!thcycle) { org.castor.util.CycleBreaker.releaseCycleHandle(this._id); };\r
-                        if (!tmcycle) { org.castor.util.CycleBreaker.releaseCycleHandle(temp._id); };\r
-                        return false;\r
-                    }\r
-                    if (!thcycle) {\r
-                        if (!this._id.equals(temp._id)) {\r
-                            org.castor.util.CycleBreaker.releaseCycleHandle(this._id);\r
-                            org.castor.util.CycleBreaker.releaseCycleHandle(temp._id);\r
-                            return false;\r
-                        }\r
-                        org.castor.util.CycleBreaker.releaseCycleHandle(this._id);\r
-                        org.castor.util.CycleBreaker.releaseCycleHandle(temp._id);\r
-                    }\r
-                }\r
-            } else if (temp._id != null)\r
-                return false;\r
-            return true;\r
+          }\r
+          if (!thcycle) {\r
+            if (!this._id.equals(temp._id)) {\r
+              org.castor.util.CycleBreaker.releaseCycleHandle(this._id);\r
+              org.castor.util.CycleBreaker.releaseCycleHandle(temp._id);\r
+              return false;\r
+            }\r
+            org.castor.util.CycleBreaker.releaseCycleHandle(this._id);\r
+            org.castor.util.CycleBreaker.releaseCycleHandle(temp._id);\r
+          }\r
         }\r
+      } else if (temp._id != null)\r
         return false;\r
+      return true;\r
     }\r
-\r
-    /**\r
-     * Returns the value of field 'id'.\r
-     * \r
-     * @return the value of field 'Id'.\r
-     */\r
-    public java.lang.String getId(\r
-    ) {\r
-        return this._id;\r
-    }\r
-\r
-    /**\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
-        if (_id != null\r
-            && !org.castor.util.CycleBreaker.startingToCycle(_id)) {\r
-           result = 37 * result + _id.hashCode();\r
-           org.castor.util.CycleBreaker.releaseCycleHandle(_id);\r
-        }\r
-        \r
-        return result;\r
-    }\r
-\r
-    /**\r
-     * Method isValid.\r
-     * \r
-     * @return true if this object is valid according to the schema\r
-     */\r
-    public boolean isValid(\r
-    ) {\r
-        try {\r
-            validate();\r
-        } catch (org.exolab.castor.xml.ValidationException vex) {\r
-            return false;\r
-        }\r
-        return true;\r
-    }\r
-\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(\r
-            final java.io.Writer out)\r
-    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
-        Marshaller.marshal(this, out);\r
-    }\r
-\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(\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
-    }\r
-\r
-    /**\r
-     * Sets the value of field 'id'.\r
-     * \r
-     * @param id the value of field 'id'.\r
-     */\r
-    public void setId(\r
-            final java.lang.String id) {\r
-        this._id = id;\r
-    }\r
-\r
-    /**\r
-     * Method unmarshal.\r
-     * \r
-     * @param reader\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.MapType\r
-     */\r
-    public static uk.ac.vamsas.objects.core.MapType 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.MapType) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Map.class, reader);\r
+    return false;\r
+  }\r
+\r
+  /**\r
+   * Returns the value of field 'id'.\r
+   * \r
+   * @return the value of field 'Id'.\r
+   */\r
+  public java.lang.String getId() {\r
+    return this._id;\r
+  }\r
+\r
+  /**\r
+   * Overrides the java.lang.Object.hashCode method.\r
+   * <p>\r
+   * The following steps came from <b>Effective Java Programming Language\r
+   * Guide</b> by Joshua Bloch, Chapter 3\r
+   * \r
+   * @return a hash code value for the object.\r
+   */\r
+  public int hashCode() {\r
+    int result = super.hashCode();\r
+\r
+    long tmp;\r
+    if (_id != null && !org.castor.util.CycleBreaker.startingToCycle(_id)) {\r
+      result = 37 * result + _id.hashCode();\r
+      org.castor.util.CycleBreaker.releaseCycleHandle(_id);\r
     }\r
 \r
-    /**\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
-    )\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
+    return result;\r
+  }\r
+\r
+  /**\r
+   * Method isValid.\r
+   * \r
+   * @return true if this object is valid according to the schema\r
+   */\r
+  public boolean isValid() {\r
+    try {\r
+      validate();\r
+    } catch (org.exolab.castor.xml.ValidationException vex) {\r
+      return false;\r
     }\r
+    return true;\r
+  }\r
+\r
+  /**\r
+   * \r
+   * \r
+   * @param out\r
+   * @throws org.exolab.castor.xml.MarshalException\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
+   * @throws org.exolab.castor.xml.ValidationException\r
+   *           if this object is an invalid instance according to the schema\r
+   */\r
+  public void marshal(final java.io.Writer out)\r
+      throws org.exolab.castor.xml.MarshalException,\r
+      org.exolab.castor.xml.ValidationException {\r
+    Marshaller.marshal(this, out);\r
+  }\r
+\r
+  /**\r
+   * \r
+   * \r
+   * @param handler\r
+   * @throws java.io.IOException\r
+   *           if an IOException occurs during marshaling\r
+   * @throws org.exolab.castor.xml.ValidationException\r
+   *           if this object is an invalid instance according to the schema\r
+   * @throws org.exolab.castor.xml.MarshalException\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
+   */\r
+  public void marshal(final org.xml.sax.ContentHandler handler)\r
+      throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
+      org.exolab.castor.xml.ValidationException {\r
+    Marshaller.marshal(this, handler);\r
+  }\r
+\r
+  /**\r
+   * Sets the value of field 'id'.\r
+   * \r
+   * @param id\r
+   *          the value of field 'id'.\r
+   */\r
+  public void setId(final java.lang.String id) {\r
+    this._id = id;\r
+  }\r
+\r
+  /**\r
+   * Method unmarshal.\r
+   * \r
+   * @param reader\r
+   * @throws org.exolab.castor.xml.MarshalException\r
+   *           if object is null or if any SAXException is thrown during\r
+   *           marshaling\r
+   * @throws org.exolab.castor.xml.ValidationException\r
+   *           if this object is an invalid instance according to the schema\r
+   * @return the unmarshaled uk.ac.vamsas.objects.core.MapType\r
+   */\r
+  public static uk.ac.vamsas.objects.core.MapType unmarshal(\r
+      final java.io.Reader reader)\r
+      throws org.exolab.castor.xml.MarshalException,\r
+      org.exolab.castor.xml.ValidationException {\r
+    return (uk.ac.vamsas.objects.core.MapType) Unmarshaller.unmarshal(\r
+        uk.ac.vamsas.objects.core.Map.class, reader);\r
+  }\r
+\r
+  /**\r
+   * \r
+   * \r
+   * @throws org.exolab.castor.xml.ValidationException\r
+   *           if this object is an invalid instance according to the schema\r
+   */\r
+  public void validate() throws org.exolab.castor.xml.ValidationException {\r
+    org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
+    validator.validate(this);\r
+  }\r
 \r
 }\r