src/jalview/binding/JalviewModelSequence2Item.java

   1 /*\r
   2  * This class was automatically generated with\r
   3  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
   4  * Schema.\r
   5  * $Id$\r
   6  */\r
   7 \r
   8 /*\r
   9 * Jalview - A Sequence Alignment Editor and Viewer\r
  10 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
  11 *\r
  12 * This program is free software; you can redistribute it and/or\r
  13 * modify it under the terms of the GNU General Public License\r
  14 * as published by the Free Software Foundation; either version 2\r
  15 * of the License, or (at your option) any later version.\r
  16 *\r
  17 * This program is distributed in the hope that it will be useful,\r
  18 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  20 * GNU General Public License for more details.\r
  21 *\r
  22 * You should have received a copy of the GNU General Public License\r
  23 * along with this program; if not, write to the Free Software\r
  24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  25 */\r
  26 \r
  27 package jalview.binding;\r
  28 \r
  29   //---------------------------------/\r
  30  //- Imported classes and packages -/\r
  31 //---------------------------------/\r
  32 \r
  33 import java.io.Serializable;\r
  34 import java.util.Enumeration;\r
  35 import java.util.Vector;\r
  36 import org.exolab.castor.xml.Marshaller;\r
  37 import org.exolab.castor.xml.Unmarshaller;\r
  38 \r
  39 /**\r
  40  * Class JalviewModelSequence2Item.\r
  41  *\r
  42  * @version $Revision$ $Date$\r
  43  */\r
  44 public class JalviewModelSequence2Item implements java.io.Serializable {\r
  45 \r
  46 \r
  47       //--------------------------/\r
  48      //- Class/Member Variables -/\r
  49     //--------------------------/\r
  50 \r
  51     /**\r
  52      * Field _userColourSchemeList\r
  53      */\r
  54     private java.util.Vector _userColourSchemeList;\r
  55 \r
  56 \r
  57       //----------------/\r
  58      //- Constructors -/\r
  59     //----------------/\r
  60 \r
  61     public JalviewModelSequence2Item() {\r
  62         super();\r
  63         _userColourSchemeList = new Vector();\r
  64     } //-- jalview.binding.JalviewModelSequence2Item()\r
  65 \r
  66 \r
  67       //-----------/\r
  68      //- Methods -/\r
  69     //-----------/\r
  70 \r
  71     /**\r
  72      * Method addUserColourScheme\r
  73      *\r
  74      *\r
  75      *\r
  76      * @param vUserColourScheme\r
  77      */\r
  78     public void addUserColourScheme(jalview.binding.UserColourScheme vUserColourScheme)\r
  79         throws java.lang.IndexOutOfBoundsException\r
  80     {\r
  81         _userColourSchemeList.addElement(vUserColourScheme);\r
  82     } //-- void addUserColourScheme(jalview.binding.UserColourScheme)\r
  83 \r
  84     /**\r
  85      * Method addUserColourScheme\r
  86      *\r
  87      *\r
  88      *\r
  89      * @param index\r
  90      * @param vUserColourScheme\r
  91      */\r
  92     public void addUserColourScheme(int index, jalview.binding.UserColourScheme vUserColourScheme)\r
  93         throws java.lang.IndexOutOfBoundsException\r
  94     {\r
  95         _userColourSchemeList.insertElementAt(vUserColourScheme, index);\r
  96     } //-- void addUserColourScheme(int, jalview.binding.UserColourScheme)\r
  97 \r
  98     /**\r
  99      * Method enumerateUserColourScheme\r
 100      *\r
 101      *\r
 102      *\r
 103      * @return Enumeration\r
 104      */\r
 105     public java.util.Enumeration enumerateUserColourScheme()\r
 106     {\r
 107         return _userColourSchemeList.elements();\r
 108     } //-- java.util.Enumeration enumerateUserColourScheme()\r
 109 \r
 110     /**\r
 111      * Method getUserColourScheme\r
 112      *\r
 113      *\r
 114      *\r
 115      * @param index\r
 116      * @return UserColourScheme\r
 117      */\r
 118     public jalview.binding.UserColourScheme getUserColourScheme(int index)\r
 119         throws java.lang.IndexOutOfBoundsException\r
 120     {\r
 121         //-- check bounds for index\r
 122         if ((index < 0) || (index > _userColourSchemeList.size())) {\r
 123             throw new IndexOutOfBoundsException();\r
 124         }\r
 125 \r
 126         return (jalview.binding.UserColourScheme) _userColourSchemeList.elementAt(index);\r
 127     } //-- jalview.binding.UserColourScheme getUserColourScheme(int)\r
 128 \r
 129     /**\r
 130      * Method getUserColourScheme\r
 131      *\r
 132      *\r
 133      *\r
 134      * @return UserColourScheme\r
 135      */\r
 136     public jalview.binding.UserColourScheme[] getUserColourScheme()\r
 137     {\r
 138         int size = _userColourSchemeList.size();\r
 139         jalview.binding.UserColourScheme[] mArray = new jalview.binding.UserColourScheme[size];\r
 140         for (int index = 0; index < size; index++) {\r
 141             mArray[index] = (jalview.binding.UserColourScheme) _userColourSchemeList.elementAt(index);\r
 142         }\r
 143         return mArray;\r
 144     } //-- jalview.binding.UserColourScheme[] getUserColourScheme()\r
 145 \r
 146     /**\r
 147      * Method getUserColourSchemeCount\r
 148      *\r
 149      *\r
 150      *\r
 151      * @return int\r
 152      */\r
 153     public int getUserColourSchemeCount()\r
 154     {\r
 155         return _userColourSchemeList.size();\r
 156     } //-- int getUserColourSchemeCount()\r
 157 \r
 158     /**\r
 159      * Method removeAllUserColourScheme\r
 160      *\r
 161      */\r
 162     public void removeAllUserColourScheme()\r
 163     {\r
 164         _userColourSchemeList.removeAllElements();\r
 165     } //-- void removeAllUserColourScheme()\r
 166 \r
 167     /**\r
 168      * Method removeUserColourScheme\r
 169      *\r
 170      *\r
 171      *\r
 172      * @param index\r
 173      * @return UserColourScheme\r
 174      */\r
 175     public jalview.binding.UserColourScheme removeUserColourScheme(int index)\r
 176     {\r
 177         java.lang.Object obj = _userColourSchemeList.elementAt(index);\r
 178         _userColourSchemeList.removeElementAt(index);\r
 179         return (jalview.binding.UserColourScheme) obj;\r
 180     } //-- jalview.binding.UserColourScheme removeUserColourScheme(int)\r
 181 \r
 182     /**\r
 183      * Method setUserColourScheme\r
 184      *\r
 185      *\r
 186      *\r
 187      * @param index\r
 188      * @param vUserColourScheme\r
 189      */\r
 190     public void setUserColourScheme(int index, jalview.binding.UserColourScheme vUserColourScheme)\r
 191         throws java.lang.IndexOutOfBoundsException\r
 192     {\r
 193         //-- check bounds for index\r
 194         if ((index < 0) || (index > _userColourSchemeList.size())) {\r
 195             throw new IndexOutOfBoundsException();\r
 196         }\r
 197         _userColourSchemeList.setElementAt(vUserColourScheme, index);\r
 198     } //-- void setUserColourScheme(int, jalview.binding.UserColourScheme)\r
 199 \r
 200     /**\r
 201      * Method setUserColourScheme\r
 202      *\r
 203      *\r
 204      *\r
 205      * @param userColourSchemeArray\r
 206      */\r
 207     public void setUserColourScheme(jalview.binding.UserColourScheme[] userColourSchemeArray)\r
 208     {\r
 209         //-- copy array\r
 210         _userColourSchemeList.removeAllElements();\r
 211         for (int i = 0; i < userColourSchemeArray.length; i++) {\r
 212             _userColourSchemeList.addElement(userColourSchemeArray[i]);\r
 213         }\r
 214     } //-- void setUserColourScheme(jalview.binding.UserColourScheme)\r
 215 \r
 216 }\r