/*\r
- * This class was automatically generated with\r
- * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
- * Schema.\r
- * $Id$\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)\r
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
+ * \r
+ * This file is part of Jalview.\r
+ * \r
+ * Jalview is free software: you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License \r
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
+ * \r
+ * Jalview is distributed in the hope that it will be useful, but \r
+ * WITHOUT ANY WARRANTY; without even the implied warranty \r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ * PURPOSE. See the GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.\r
*/\r
-\r
package jalview.schemabinding.version2;\r
\r
//---------------------------------/\r
//- Imported classes and packages -/\r
//---------------------------------/\r
\r
-import java.util.*;\r
-\r
-import org.exolab.castor.xml.*;\r
+import org.exolab.castor.xml.Marshaller;\r
+import org.exolab.castor.xml.Unmarshaller;\r
\r
/**\r
* Class Feature.\r
- *\r
+ * \r
* @version $Revision$ $Date$\r
*/\r
-public class Feature\r
- implements java.io.Serializable\r
+public class Feature implements java.io.Serializable\r
{\r
\r
- //--------------------------/\r
- //- Class/Member Variables -/\r
- //--------------------------/\r
+ // --------------------------/\r
+ // - Class/Member Variables -/\r
+ // --------------------------/\r
\r
/**\r
- * Field _begin\r
+ * Field _begin.\r
*/\r
private int _begin;\r
\r
private boolean _has_begin;\r
\r
/**\r
- * Field _end\r
+ * Field _end.\r
*/\r
private int _end;\r
\r
private boolean _has_end;\r
\r
/**\r
- * Field _type\r
+ * Field _type.\r
*/\r
private java.lang.String _type;\r
\r
/**\r
- * Field _description\r
+ * Field _description.\r
*/\r
private java.lang.String _description;\r
\r
/**\r
- * Field _status\r
+ * Field _status.\r
*/\r
private java.lang.String _status;\r
\r
/**\r
- * Field _featureGroup\r
+ * Field _featureGroup.\r
*/\r
private java.lang.String _featureGroup;\r
\r
/**\r
- * Field _score\r
+ * Field _score.\r
*/\r
private float _score;\r
\r
private boolean _has_score;\r
\r
/**\r
- * Field _otherDataList\r
+ * Field _otherDataList.\r
*/\r
private java.util.Vector _otherDataList;\r
\r
- //----------------/\r
- //- Constructors -/\r
- //----------------/\r
+ // ----------------/\r
+ // - Constructors -/\r
+ // ----------------/\r
\r
public Feature()\r
{\r
super();\r
- _otherDataList = new Vector();\r
- } //-- jalview.schemabinding.version2.Feature()\r
+ this._otherDataList = new java.util.Vector();\r
+ }\r
\r
- //-----------/\r
- //- Methods -/\r
- //-----------/\r
+ // -----------/\r
+ // - Methods -/\r
+ // -----------/\r
\r
/**\r
- * Method addOtherData\r
- *\r
- *\r
- *\r
+ * \r
+ * \r
* @param vOtherData\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
*/\r
- public void addOtherData(jalview.schemabinding.version2.OtherData vOtherData)\r
- throws java.lang.IndexOutOfBoundsException\r
+ public void addOtherData(\r
+ final jalview.schemabinding.version2.OtherData vOtherData)\r
+ throws java.lang.IndexOutOfBoundsException\r
{\r
- _otherDataList.addElement(vOtherData);\r
- } //-- void addOtherData(jalview.schemabinding.version2.OtherData)\r
+ this._otherDataList.addElement(vOtherData);\r
+ }\r
\r
/**\r
- * Method addOtherData\r
- *\r
- *\r
- *\r
+ * \r
+ * \r
* @param index\r
* @param vOtherData\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
*/\r
- public void addOtherData(int index,\r
- jalview.schemabinding.version2.OtherData vOtherData)\r
- throws java.lang.IndexOutOfBoundsException\r
+ public void addOtherData(final int index,\r
+ final jalview.schemabinding.version2.OtherData vOtherData)\r
+ throws java.lang.IndexOutOfBoundsException\r
{\r
- _otherDataList.insertElementAt(vOtherData, index);\r
- } //-- void addOtherData(int, jalview.schemabinding.version2.OtherData)\r
+ this._otherDataList.add(index, vOtherData);\r
+ }\r
\r
/**\r
- * Method deleteBegin\r
- *\r
- */\r
+ */\r
public void deleteBegin()\r
{\r
this._has_begin = false;\r
- } //-- void deleteBegin()\r
+ }\r
\r
/**\r
- * Method deleteEnd\r
- *\r
- */\r
+ */\r
public void deleteEnd()\r
{\r
this._has_end = false;\r
- } //-- void deleteEnd()\r
+ }\r
\r
/**\r
- * Method deleteScore\r
- *\r
- */\r
+ */\r
public void deleteScore()\r
{\r
this._has_score = false;\r
- } //-- void deleteScore()\r
+ }\r
\r
/**\r
- * Method enumerateOtherData\r
- *\r
- *\r
- *\r
- * @return Enumeration\r
+ * Method enumerateOtherData.\r
+ * \r
+ * @return an Enumeration over all jalview.schemabinding.version2.OtherData\r
+ * elements\r
*/\r
public java.util.Enumeration enumerateOtherData()\r
{\r
- return _otherDataList.elements();\r
- } //-- java.util.Enumeration enumerateOtherData()\r
+ return this._otherDataList.elements();\r
+ }\r
\r
/**\r
* Returns the value of field 'begin'.\r
- *\r
- * @return int\r
- * @return the value of field 'begin'.\r
+ * \r
+ * @return the value of field 'Begin'.\r
*/\r
public int getBegin()\r
{\r
return this._begin;\r
- } //-- int getBegin()\r
+ }\r
\r
/**\r
* Returns the value of field 'description'.\r
- *\r
- * @return String\r
- * @return the value of field 'description'.\r
+ * \r
+ * @return the value of field 'Description'.\r
*/\r
public java.lang.String getDescription()\r
{\r
return this._description;\r
- } //-- java.lang.String getDescription()\r
+ }\r
\r
/**\r
* Returns the value of field 'end'.\r
- *\r
- * @return int\r
- * @return the value of field 'end'.\r
+ * \r
+ * @return the value of field 'End'.\r
*/\r
public int getEnd()\r
{\r
return this._end;\r
- } //-- int getEnd()\r
+ }\r
\r
/**\r
* Returns the value of field 'featureGroup'.\r
- *\r
- * @return String\r
- * @return the value of field 'featureGroup'.\r
+ * \r
+ * @return the value of field 'FeatureGroup'.\r
*/\r
public java.lang.String getFeatureGroup()\r
{\r
return this._featureGroup;\r
- } //-- java.lang.String getFeatureGroup()\r
+ }\r
\r
/**\r
- * Method getOtherData\r
- *\r
- *\r
- *\r
+ * Method getOtherData.\r
+ * \r
* @param index\r
- * @return OtherData\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
+ * @return the value of the jalview.schemabinding.version2.OtherData at the\r
+ * given index\r
*/\r
- public jalview.schemabinding.version2.OtherData getOtherData(int index)\r
- throws java.lang.IndexOutOfBoundsException\r
+ public jalview.schemabinding.version2.OtherData getOtherData(\r
+ final int index) throws java.lang.IndexOutOfBoundsException\r
{\r
- //-- check bounds for index\r
- if ( (index < 0) || (index > _otherDataList.size()))\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._otherDataList.size())\r
{\r
- throw new IndexOutOfBoundsException();\r
+ throw new IndexOutOfBoundsException("getOtherData: Index value '"\r
+ + index + "' not in range [0.."\r
+ + (this._otherDataList.size() - 1) + "]");\r
}\r
\r
- return (jalview.schemabinding.version2.OtherData) _otherDataList.elementAt(\r
- index);\r
- } //-- jalview.schemabinding.version2.OtherData getOtherData(int)\r
+ return (jalview.schemabinding.version2.OtherData) _otherDataList\r
+ .get(index);\r
+ }\r
\r
/**\r
- * Method getOtherData\r
- *\r
- *\r
- *\r
- * @return OtherData\r
+ * Method getOtherData.Returns the contents of the collection in an Array.\r
+ * <p>\r
+ * Note: Just in case the collection contents are changing in another thread,\r
+ * we pass a 0-length Array of the correct type into the API call. This way we\r
+ * <i>know</i> that the Array returned is of exactly the correct length.\r
+ * \r
+ * @return this collection as an Array\r
*/\r
public jalview.schemabinding.version2.OtherData[] getOtherData()\r
{\r
- int size = _otherDataList.size();\r
- jalview.schemabinding.version2.OtherData[] mArray = new jalview.\r
- schemabinding.version2.OtherData[size];\r
- for (int index = 0; index < size; index++)\r
- {\r
- mArray[index] = (jalview.schemabinding.version2.OtherData) _otherDataList.\r
- elementAt(index);\r
- }\r
- return mArray;\r
- } //-- jalview.schemabinding.version2.OtherData[] getOtherData()\r
+ jalview.schemabinding.version2.OtherData[] array = new jalview.schemabinding.version2.OtherData[0];\r
+ return (jalview.schemabinding.version2.OtherData[]) this._otherDataList\r
+ .toArray(array);\r
+ }\r
\r
/**\r
- * Method getOtherDataCount\r
- *\r
- *\r
- *\r
- * @return int\r
+ * Method getOtherDataCount.\r
+ * \r
+ * @return the size of this collection\r
*/\r
public int getOtherDataCount()\r
{\r
- return _otherDataList.size();\r
- } //-- int getOtherDataCount()\r
+ return this._otherDataList.size();\r
+ }\r
\r
/**\r
* Returns the value of field 'score'.\r
- *\r
- * @return float\r
- * @return the value of field 'score'.\r
+ * \r
+ * @return the value of field 'Score'.\r
*/\r
public float getScore()\r
{\r
return this._score;\r
- } //-- float getScore()\r
+ }\r
\r
/**\r
* Returns the value of field 'status'.\r
- *\r
- * @return String\r
- * @return the value of field 'status'.\r
+ * \r
+ * @return the value of field 'Status'.\r
*/\r
public java.lang.String getStatus()\r
{\r
return this._status;\r
- } //-- java.lang.String getStatus()\r
+ }\r
\r
/**\r
* Returns the value of field 'type'.\r
- *\r
- * @return String\r
- * @return the value of field 'type'.\r
+ * \r
+ * @return the value of field 'Type'.\r
*/\r
public java.lang.String getType()\r
{\r
return this._type;\r
- } //-- java.lang.String getType()\r
+ }\r
\r
/**\r
- * Method hasBegin\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method hasBegin.\r
+ * \r
+ * @return true if at least one Begin has been added\r
*/\r
public boolean hasBegin()\r
{\r
return this._has_begin;\r
- } //-- boolean hasBegin()\r
+ }\r
\r
/**\r
- * Method hasEnd\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method hasEnd.\r
+ * \r
+ * @return true if at least one End has been added\r
*/\r
public boolean hasEnd()\r
{\r
return this._has_end;\r
- } //-- boolean hasEnd()\r
+ }\r
\r
/**\r
- * Method hasScore\r
- *\r
- *\r
- *\r
- * @return boolean\r
+ * Method hasScore.\r
+ * \r
+ * @return true if at least one Score has been added\r
*/\r
public boolean hasScore()\r
{\r
return this._has_score;\r
- } //-- boolean hasScore()\r
+ }\r
\r
/**\r
- * Method isValid\r
- *\r
- *\r
- *\r
- * @return boolean\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
{\r
validate();\r
- }\r
- catch (org.exolab.castor.xml.ValidationException vex)\r
+ } catch (org.exolab.castor.xml.ValidationException vex)\r
{\r
return false;\r
}\r
return true;\r
- } //-- boolean isValid()\r
+ }\r
\r
/**\r
- * Method marshal\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(java.io.Writer out)\r
- throws org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\r
+ public void marshal(final java.io.Writer out)\r
+ throws org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
{\r
-\r
Marshaller.marshal(this, out);\r
- } //-- void marshal(java.io.Writer)\r
+ }\r
\r
/**\r
- * Method marshal\r
- *\r
- *\r
- *\r
+ * \r
+ * \r
* @param handler\r
- */\r
- public void marshal(org.xml.sax.ContentHandler handler)\r
- throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\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,\r
+ org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
{\r
-\r
Marshaller.marshal(this, handler);\r
- } //-- void marshal(org.xml.sax.ContentHandler)\r
+ }\r
\r
/**\r
- * Method removeAllOtherData\r
- *\r
- */\r
+ */\r
public void removeAllOtherData()\r
{\r
- _otherDataList.removeAllElements();\r
- } //-- void removeAllOtherData()\r
+ this._otherDataList.clear();\r
+ }\r
+\r
+ /**\r
+ * Method removeOtherData.\r
+ * \r
+ * @param vOtherData\r
+ * @return true if the object was removed from the collection.\r
+ */\r
+ public boolean removeOtherData(\r
+ final jalview.schemabinding.version2.OtherData vOtherData)\r
+ {\r
+ boolean removed = _otherDataList.remove(vOtherData);\r
+ return removed;\r
+ }\r
\r
/**\r
- * Method removeOtherData\r
- *\r
- *\r
- *\r
+ * Method removeOtherDataAt.\r
+ * \r
* @param index\r
- * @return OtherData\r
+ * @return the element removed from the collection\r
*/\r
- public jalview.schemabinding.version2.OtherData removeOtherData(int index)\r
+ public jalview.schemabinding.version2.OtherData removeOtherDataAt(\r
+ final int index)\r
{\r
- java.lang.Object obj = _otherDataList.elementAt(index);\r
- _otherDataList.removeElementAt(index);\r
+ java.lang.Object obj = this._otherDataList.remove(index);\r
return (jalview.schemabinding.version2.OtherData) obj;\r
- } //-- jalview.schemabinding.version2.OtherData removeOtherData(int)\r
+ }\r
\r
/**\r
* Sets the value of field 'begin'.\r
- *\r
- * @param begin the value of field 'begin'.\r
+ * \r
+ * @param begin\r
+ * the value of field 'begin'.\r
*/\r
- public void setBegin(int begin)\r
+ public void setBegin(final int begin)\r
{\r
this._begin = begin;\r
this._has_begin = true;\r
- } //-- void setBegin(int)\r
+ }\r
\r
/**\r
* Sets the value of field 'description'.\r
- *\r
- * @param description the value of field 'description'.\r
+ * \r
+ * @param description\r
+ * the value of field 'description'.\r
*/\r
- public void setDescription(java.lang.String description)\r
+ public void setDescription(final java.lang.String description)\r
{\r
this._description = description;\r
- } //-- void setDescription(java.lang.String)\r
+ }\r
\r
/**\r
* Sets the value of field 'end'.\r
- *\r
- * @param end the value of field 'end'.\r
+ * \r
+ * @param end\r
+ * the value of field 'end'.\r
*/\r
- public void setEnd(int end)\r
+ public void setEnd(final int end)\r
{\r
this._end = end;\r
this._has_end = true;\r
- } //-- void setEnd(int)\r
+ }\r
\r
/**\r
* Sets the value of field 'featureGroup'.\r
- *\r
- * @param featureGroup the value of field 'featureGroup'.\r
+ * \r
+ * @param featureGroup\r
+ * the value of field 'featureGroup'.\r
*/\r
- public void setFeatureGroup(java.lang.String featureGroup)\r
+ public void setFeatureGroup(final java.lang.String featureGroup)\r
{\r
this._featureGroup = featureGroup;\r
- } //-- void setFeatureGroup(java.lang.String)\r
+ }\r
\r
/**\r
- * Method setOtherData\r
- *\r
- *\r
- *\r
+ * \r
+ * \r
* @param index\r
* @param vOtherData\r
+ * @throws java.lang.IndexOutOfBoundsException\r
+ * if the index given is outside the bounds of the collection\r
*/\r
- public void setOtherData(int index,\r
- jalview.schemabinding.version2.OtherData vOtherData)\r
- throws java.lang.IndexOutOfBoundsException\r
+ public void setOtherData(final int index,\r
+ final jalview.schemabinding.version2.OtherData vOtherData)\r
+ throws java.lang.IndexOutOfBoundsException\r
{\r
- //-- check bounds for index\r
- if ( (index < 0) || (index > _otherDataList.size()))\r
+ // check bounds for index\r
+ if (index < 0 || index >= this._otherDataList.size())\r
{\r
- throw new IndexOutOfBoundsException();\r
+ throw new IndexOutOfBoundsException("setOtherData: Index value '"\r
+ + index + "' not in range [0.."\r
+ + (this._otherDataList.size() - 1) + "]");\r
}\r
- _otherDataList.setElementAt(vOtherData, index);\r
- } //-- void setOtherData(int, jalview.schemabinding.version2.OtherData)\r
+\r
+ this._otherDataList.set(index, vOtherData);\r
+ }\r
\r
/**\r
- * Method setOtherData\r
- *\r
- *\r
- *\r
- * @param otherDataArray\r
+ * \r
+ * \r
+ * @param vOtherDataArray\r
*/\r
- public void setOtherData(jalview.schemabinding.version2.OtherData[]\r
- otherDataArray)\r
+ public void setOtherData(\r
+ final jalview.schemabinding.version2.OtherData[] vOtherDataArray)\r
{\r
- //-- copy array\r
- _otherDataList.removeAllElements();\r
- for (int i = 0; i < otherDataArray.length; i++)\r
+ // -- copy array\r
+ _otherDataList.clear();\r
+\r
+ for (int i = 0; i < vOtherDataArray.length; i++)\r
{\r
- _otherDataList.addElement(otherDataArray[i]);\r
+ this._otherDataList.add(vOtherDataArray[i]);\r
}\r
- } //-- void setOtherData(jalview.schemabinding.version2.OtherData)\r
+ }\r
\r
/**\r
* Sets the value of field 'score'.\r
- *\r
- * @param score the value of field 'score'.\r
+ * \r
+ * @param score\r
+ * the value of field 'score'.\r
*/\r
- public void setScore(float score)\r
+ public void setScore(final float score)\r
{\r
this._score = score;\r
this._has_score = true;\r
- } //-- void setScore(float)\r
+ }\r
\r
/**\r
* Sets the value of field 'status'.\r
- *\r
- * @param status the value of field 'status'.\r
+ * \r
+ * @param status\r
+ * the value of field 'status'.\r
*/\r
- public void setStatus(java.lang.String status)\r
+ public void setStatus(final java.lang.String status)\r
{\r
this._status = status;\r
- } //-- void setStatus(java.lang.String)\r
+ }\r
\r
/**\r
* Sets the value of field 'type'.\r
- *\r
- * @param type the value of field 'type'.\r
+ * \r
+ * @param type\r
+ * the value of field 'type'.\r
*/\r
- public void setType(java.lang.String type)\r
+ public void setType(final java.lang.String type)\r
{\r
this._type = type;\r
- } //-- void setType(java.lang.String)\r
+ }\r
\r
/**\r
- * Method unmarshal\r
- *\r
- *\r
- *\r
+ * Method unmarshal.\r
+ * \r
* @param reader\r
- * @return Object\r
- */\r
- public static java.lang.Object unmarshal(java.io.Reader reader)\r
- throws org.exolab.castor.xml.MarshalException,\r
- org.exolab.castor.xml.ValidationException\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 jalview.schemabinding.version2.Featur\r
+ */\r
+ public static jalview.schemabinding.version2.Feature unmarshal(\r
+ final java.io.Reader reader)\r
+ throws org.exolab.castor.xml.MarshalException,\r
+ org.exolab.castor.xml.ValidationException\r
{\r
return (jalview.schemabinding.version2.Feature) Unmarshaller.unmarshal(\r
- jalview.schemabinding.version2.Feature.class, reader);\r
- } //-- java.lang.Object unmarshal(java.io.Reader)\r
+ jalview.schemabinding.version2.Feature.class, reader);\r
+ }\r
\r
/**\r
- * Method validate\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()\r
- throws org.exolab.castor.xml.ValidationException\r
+ public void validate() throws org.exolab.castor.xml.ValidationException\r
{\r
- org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.\r
- Validator();\r
+ org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
validator.validate(this);\r
- } //-- void validate()\r
+ }\r
\r
}\r