/*\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
\r
/**\r
* Discrete symbol - possibly graphically represented\r
- * \r
+ * \r
* \r
* @version $Revision$ $Date$\r
*/\r
-public class Glyph extends uk.ac.vamsas.client.Vobject \r
-implements java.io.Serializable\r
-{\r
+public class Glyph extends uk.ac.vamsas.client.Vobject implements\r
+ java.io.Serializable {\r
\r
+ // --------------------------/\r
+ // - Class/Member Variables -/\r
+ // --------------------------/\r
\r
- //--------------------------/\r
- //- Class/Member Variables -/\r
- //--------------------------/\r
+ /**\r
+ * internal content storage\r
+ */\r
+ private java.lang.String _content = "";\r
\r
- /**\r
- * internal content storage\r
- */\r
- private java.lang.String _content = "";\r
+ /**\r
+ * specifies the symbol dictionary for this glyph - eg utf8 (the default),\r
+ * aasecstr_3 or kd_hydrophobicity - the content is not validated so\r
+ * applications must ensure they gracefully deal with invalid entries here\r
+ */\r
+ private java.lang.String _dict = "utf8";\r
\r
- /**\r
- * specifies the symbol dictionary for this\r
- * glyph - eg utf8 (the default), aasecstr_3 or\r
- * kd_hydrophobicity - the content is not validated so\r
- * applications must ensure they gracefully deal with\r
- * invalid entries here \r
- */\r
- private java.lang.String _dict = "utf8";\r
+ // ----------------/\r
+ // - Constructors -/\r
+ // ----------------/\r
\r
+ public Glyph() {\r
+ super();\r
+ setContent("");\r
+ setDict("utf8");\r
+ }\r
\r
- //----------------/\r
- //- Constructors -/\r
- //----------------/\r
+ // -----------/\r
+ // - Methods -/\r
+ // -----------/\r
\r
- public Glyph() {\r
- super();\r
- setContent("");\r
- setDict("utf8");\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
- //-----------/\r
- //- Methods -/\r
- //-----------/\r
+ if (obj instanceof Glyph) {\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
+ Glyph temp = (Glyph) obj;\r
+ boolean thcycle;\r
+ boolean tmcycle;\r
+ if (this._content != null) {\r
+ if (temp._content == null)\r
+ return false;\r
+ if (this._content != temp._content) {\r
+ thcycle = org.castor.util.CycleBreaker.startingToCycle(this._content);\r
+ tmcycle = org.castor.util.CycleBreaker.startingToCycle(temp._content);\r
+ if (thcycle != tmcycle) {\r
+ if (!thcycle) {\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(this._content);\r
+ }\r
+ ;\r
+ if (!tmcycle) {\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(temp._content);\r
+ }\r
+ ;\r
return false;\r
- \r
- if (obj instanceof Glyph) {\r
- \r
- Glyph temp = (Glyph)obj;\r
- boolean thcycle;\r
- boolean tmcycle;\r
- if (this._content != null) {\r
- if (temp._content == null) return false;\r
- if (this._content != temp._content) {\r
- thcycle=org.castor.util.CycleBreaker.startingToCycle(this._content);\r
- tmcycle=org.castor.util.CycleBreaker.startingToCycle(temp._content);\r
- if (thcycle!=tmcycle) {\r
- if (!thcycle) { org.castor.util.CycleBreaker.releaseCycleHandle(this._content); };\r
- if (!tmcycle) { org.castor.util.CycleBreaker.releaseCycleHandle(temp._content); };\r
- return false;\r
- }\r
- if (!thcycle) {\r
- if (!this._content.equals(temp._content)) {\r
- org.castor.util.CycleBreaker.releaseCycleHandle(this._content);\r
- org.castor.util.CycleBreaker.releaseCycleHandle(temp._content);\r
- return false;\r
- }\r
- org.castor.util.CycleBreaker.releaseCycleHandle(this._content);\r
- org.castor.util.CycleBreaker.releaseCycleHandle(temp._content);\r
- }\r
- }\r
- } else if (temp._content != null)\r
- return false;\r
- if (this._dict != null) {\r
- if (temp._dict == null) return false;\r
- if (this._dict != temp._dict) {\r
- thcycle=org.castor.util.CycleBreaker.startingToCycle(this._dict);\r
- tmcycle=org.castor.util.CycleBreaker.startingToCycle(temp._dict);\r
- if (thcycle!=tmcycle) {\r
- if (!thcycle) { org.castor.util.CycleBreaker.releaseCycleHandle(this._dict); };\r
- if (!tmcycle) { org.castor.util.CycleBreaker.releaseCycleHandle(temp._dict); };\r
- return false;\r
- }\r
- if (!thcycle) {\r
- if (!this._dict.equals(temp._dict)) {\r
- org.castor.util.CycleBreaker.releaseCycleHandle(this._dict);\r
- org.castor.util.CycleBreaker.releaseCycleHandle(temp._dict);\r
- return false;\r
- }\r
- org.castor.util.CycleBreaker.releaseCycleHandle(this._dict);\r
- org.castor.util.CycleBreaker.releaseCycleHandle(temp._dict);\r
- }\r
- }\r
- } else if (temp._dict != null)\r
- return false;\r
- return true;\r
+ }\r
+ if (!thcycle) {\r
+ if (!this._content.equals(temp._content)) {\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(this._content);\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(temp._content);\r
+ return false;\r
+ }\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(this._content);\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(temp._content);\r
+ }\r
}\r
+ } else if (temp._content != null)\r
return false;\r
+ if (this._dict != null) {\r
+ if (temp._dict == null)\r
+ return false;\r
+ if (this._dict != temp._dict) {\r
+ thcycle = org.castor.util.CycleBreaker.startingToCycle(this._dict);\r
+ tmcycle = org.castor.util.CycleBreaker.startingToCycle(temp._dict);\r
+ if (thcycle != tmcycle) {\r
+ if (!thcycle) {\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(this._dict);\r
+ }\r
+ ;\r
+ if (!tmcycle) {\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(temp._dict);\r
+ }\r
+ ;\r
+ return false;\r
+ }\r
+ if (!thcycle) {\r
+ if (!this._dict.equals(temp._dict)) {\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(this._dict);\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(temp._dict);\r
+ return false;\r
+ }\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(this._dict);\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(temp._dict);\r
+ }\r
+ }\r
+ } else if (temp._dict != null)\r
+ return false;\r
+ return true;\r
}\r
+ return false;\r
+ }\r
\r
- /**\r
- * Returns the value of field 'content'. The field 'content'\r
- * has the following description: internal content storage\r
- * \r
- * @return the value of field 'Content'.\r
- */\r
- public java.lang.String getContent(\r
- ) {\r
- return this._content;\r
- }\r
+ /**\r
+ * Returns the value of field 'content'. The field 'content' has the following\r
+ * description: internal content storage\r
+ * \r
+ * @return the value of field 'Content'.\r
+ */\r
+ public java.lang.String getContent() {\r
+ return this._content;\r
+ }\r
\r
- /**\r
- * Returns the value of field 'dict'. The field 'dict' has the\r
- * following description: specifies the symbol dictionary for\r
- * this\r
- * glyph - eg utf8 (the default), aasecstr_3 or\r
- * kd_hydrophobicity - the content is not validated so\r
- * applications must ensure they gracefully deal with\r
- * invalid entries here \r
- * \r
- * @return the value of field 'Dict'.\r
- */\r
- public java.lang.String getDict(\r
- ) {\r
- return this._dict;\r
- }\r
+ /**\r
+ * Returns the value of field 'dict'. The field 'dict' has the following\r
+ * description: specifies the symbol dictionary for this glyph - eg utf8 (the\r
+ * default), aasecstr_3 or kd_hydrophobicity - the content is not validated so\r
+ * applications must ensure they gracefully deal with invalid entries here\r
+ * \r
+ * @return the value of field 'Dict'.\r
+ */\r
+ public java.lang.String getDict() {\r
+ return this._dict;\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 (_content != null\r
- && !org.castor.util.CycleBreaker.startingToCycle(_content)) {\r
- result = 37 * result + _content.hashCode();\r
- org.castor.util.CycleBreaker.releaseCycleHandle(_content);\r
- }\r
- if (_dict != null\r
- && !org.castor.util.CycleBreaker.startingToCycle(_dict)) {\r
- result = 37 * result + _dict.hashCode();\r
- org.castor.util.CycleBreaker.releaseCycleHandle(_dict);\r
- }\r
- \r
- return result;\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
- /**\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
+ long tmp;\r
+ if (_content != null\r
+ && !org.castor.util.CycleBreaker.startingToCycle(_content)) {\r
+ result = 37 * result + _content.hashCode();\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(_content);\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
+ if (_dict != null && !org.castor.util.CycleBreaker.startingToCycle(_dict)) {\r
+ result = 37 * result + _dict.hashCode();\r
+ org.castor.util.CycleBreaker.releaseCycleHandle(_dict);\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
+ return result;\r
+ }\r
\r
- /**\r
- * Sets the value of field 'content'. The field 'content' has\r
- * the following description: internal content storage\r
- * \r
- * @param content the value of field 'content'.\r
- */\r
- public void setContent(\r
- final java.lang.String content) {\r
- this._content = content;\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
- * Sets the value of field 'dict'. The field 'dict' has the\r
- * following description: specifies the symbol dictionary for\r
- * this\r
- * glyph - eg utf8 (the default), aasecstr_3 or\r
- * kd_hydrophobicity - the content is not validated so\r
- * applications must ensure they gracefully deal with\r
- * invalid entries here \r
- * \r
- * @param dict the value of field 'dict'.\r
- */\r
- public void setDict(\r
- final java.lang.String dict) {\r
- this._dict = dict;\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
- * 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.Glyph\r
- */\r
- public static uk.ac.vamsas.objects.core.Glyph 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.Glyph) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Glyph.class, reader);\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
- * \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
- }\r
+ /**\r
+ * Sets the value of field 'content'. The field 'content' has the following\r
+ * description: internal content storage\r
+ * \r
+ * @param content\r
+ * the value of field 'content'.\r
+ */\r
+ public void setContent(final java.lang.String content) {\r
+ this._content = content;\r
+ }\r
+\r
+ /**\r
+ * Sets the value of field 'dict'. The field 'dict' has the following\r
+ * description: specifies the symbol dictionary for this glyph - eg utf8 (the\r
+ * default), aasecstr_3 or kd_hydrophobicity - the content is not validated so\r
+ * applications must ensure they gracefully deal with invalid entries here\r
+ * \r
+ * @param dict\r
+ * the value of field 'dict'.\r
+ */\r
+ public void setDict(final java.lang.String dict) {\r
+ this._dict = dict;\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.Glyph\r
+ */\r
+ public static uk.ac.vamsas.objects.core.Glyph 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.Glyph) Unmarshaller.unmarshal(\r
+ uk.ac.vamsas.objects.core.Glyph.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