src/jalview/schemabinding/version2/PcaDataType.java

   1 /*
   2  * This class was automatically generated with
   3  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
   4  * Schema.
   5  * $Id$
   6  */
   7
   8 package jalview.schemabinding.version2;
   9
  10 //---------------------------------/
  11 //- Imported classes and packages -/
  12 //---------------------------------/
  13
  14 import org.exolab.castor.xml.Marshaller;
  15 import org.exolab.castor.xml.Unmarshaller;
  16
  17 /**
  18  * The results of a PCA calculation
  19  *
  20  *
  21  * @version $Revision$ $Date$
  22  */
  23 public class PcaDataType implements java.io.Serializable
  24 {
  25
  26   // --------------------------/
  27   // - Class/Member Variables -/
  28   // --------------------------/
  29
  30   /**
  31    * Field _pairwiseMatrix.
  32    */
  33   private jalview.schemabinding.version2.PairwiseMatrix _pairwiseMatrix;
  34
  35   /**
  36    * Field _tridiagonalMatrix.
  37    */
  38   private jalview.schemabinding.version2.TridiagonalMatrix _tridiagonalMatrix;
  39
  40   /**
  41    * Field _tridiagonalD.
  42    */
  43   private jalview.schemabinding.version2.TridiagonalD _tridiagonalD;
  44
  45   /**
  46    * Field _tridiagonalE.
  47    */
  48   private jalview.schemabinding.version2.TridiagonalE _tridiagonalE;
  49
  50   /**
  51    * Field _eigenMatrix.
  52    */
  53   private jalview.schemabinding.version2.EigenMatrix _eigenMatrix;
  54
  55   /**
  56    * Field _eigenMatrixD.
  57    */
  58   private jalview.schemabinding.version2.EigenMatrixD _eigenMatrixD;
  59
  60   // ----------------/
  61   // - Constructors -/
  62   // ----------------/
  63
  64   public PcaDataType()
  65   {
  66     super();
  67   }
  68
  69   // -----------/
  70   // - Methods -/
  71   // -----------/
  72
  73   /**
  74    * Returns the value of field 'eigenMatrix'.
  75    *
  76    * @return the value of field 'EigenMatrix'.
  77    */
  78   public jalview.schemabinding.version2.EigenMatrix getEigenMatrix()
  79   {
  80     return this._eigenMatrix;
  81   }
  82
  83   /**
  84    * Returns the value of field 'eigenMatrixD'.
  85    *
  86    * @return the value of field 'EigenMatrixD'.
  87    */
  88   public jalview.schemabinding.version2.EigenMatrixD getEigenMatrixD()
  89   {
  90     return this._eigenMatrixD;
  91   }
  92
  93   /**
  94    * Returns the value of field 'pairwiseMatrix'.
  95    *
  96    * @return the value of field 'PairwiseMatrix'.
  97    */
  98   public jalview.schemabinding.version2.PairwiseMatrix getPairwiseMatrix()
  99   {
 100     return this._pairwiseMatrix;
 101   }
 102
 103   /**
 104    * Returns the value of field 'tridiagonalD'.
 105    *
 106    * @return the value of field 'TridiagonalD'.
 107    */
 108   public jalview.schemabinding.version2.TridiagonalD getTridiagonalD()
 109   {
 110     return this._tridiagonalD;
 111   }
 112
 113   /**
 114    * Returns the value of field 'tridiagonalE'.
 115    *
 116    * @return the value of field 'TridiagonalE'.
 117    */
 118   public jalview.schemabinding.version2.TridiagonalE getTridiagonalE()
 119   {
 120     return this._tridiagonalE;
 121   }
 122
 123   /**
 124    * Returns the value of field 'tridiagonalMatrix'.
 125    *
 126    * @return the value of field 'TridiagonalMatrix'.
 127    */
 128   public jalview.schemabinding.version2.TridiagonalMatrix getTridiagonalMatrix()
 129   {
 130     return this._tridiagonalMatrix;
 131   }
 132
 133   /**
 134    * Method isValid.
 135    *
 136    * @return true if this object is valid according to the schema
 137    */
 138   public boolean isValid()
 139   {
 140     try
 141     {
 142       validate();
 143     } catch (org.exolab.castor.xml.ValidationException vex)
 144     {
 145       return false;
 146     }
 147     return true;
 148   }
 149
 150   /**
 151    *
 152    *
 153    * @param out
 154    * @throws org.exolab.castor.xml.MarshalException
 155    *           if object is null or if any SAXException is thrown during
 156    *           marshaling
 157    * @throws org.exolab.castor.xml.ValidationException
 158    *           if this object is an invalid instance according to the schema
 159    */
 160   public void marshal(final java.io.Writer out)
 161           throws org.exolab.castor.xml.MarshalException,
 162           org.exolab.castor.xml.ValidationException
 163   {
 164     Marshaller.marshal(this, out);
 165   }
 166
 167   /**
 168    *
 169    *
 170    * @param handler
 171    * @throws java.io.IOException
 172    *           if an IOException occurs during marshaling
 173    * @throws org.exolab.castor.xml.ValidationException
 174    *           if this object is an invalid instance according to the schema
 175    * @throws org.exolab.castor.xml.MarshalException
 176    *           if object is null or if any SAXException is thrown during
 177    *           marshaling
 178    */
 179   public void marshal(final org.xml.sax.ContentHandler handler)
 180           throws java.io.IOException,
 181           org.exolab.castor.xml.MarshalException,
 182           org.exolab.castor.xml.ValidationException
 183   {
 184     Marshaller.marshal(this, handler);
 185   }
 186
 187   /**
 188    * Sets the value of field 'eigenMatrix'.
 189    *
 190    * @param eigenMatrix
 191    *          the value of field 'eigenMatrix'.
 192    */
 193   public void setEigenMatrix(
 194           final jalview.schemabinding.version2.EigenMatrix eigenMatrix)
 195   {
 196     this._eigenMatrix = eigenMatrix;
 197   }
 198
 199   /**
 200    * Sets the value of field 'eigenMatrixD'.
 201    *
 202    * @param eigenMatrixD
 203    *          the value of field 'eigenMatrixD'.
 204    */
 205   public void setEigenMatrixD(
 206           final jalview.schemabinding.version2.EigenMatrixD eigenMatrixD)
 207   {
 208     this._eigenMatrixD = eigenMatrixD;
 209   }
 210
 211   /**
 212    * Sets the value of field 'pairwiseMatrix'.
 213    *
 214    * @param pairwiseMatrix
 215    *          the value of field 'pairwiseMatrix'.
 216    */
 217   public void setPairwiseMatrix(
 218           final jalview.schemabinding.version2.PairwiseMatrix pairwiseMatrix)
 219   {
 220     this._pairwiseMatrix = pairwiseMatrix;
 221   }
 222
 223   /**
 224    * Sets the value of field 'tridiagonalD'.
 225    *
 226    * @param tridiagonalD
 227    *          the value of field 'tridiagonalD'.
 228    */
 229   public void setTridiagonalD(
 230           final jalview.schemabinding.version2.TridiagonalD tridiagonalD)
 231   {
 232     this._tridiagonalD = tridiagonalD;
 233   }
 234
 235   /**
 236    * Sets the value of field 'tridiagonalE'.
 237    *
 238    * @param tridiagonalE
 239    *          the value of field 'tridiagonalE'.
 240    */
 241   public void setTridiagonalE(
 242           final jalview.schemabinding.version2.TridiagonalE tridiagonalE)
 243   {
 244     this._tridiagonalE = tridiagonalE;
 245   }
 246
 247   /**
 248    * Sets the value of field 'tridiagonalMatrix'.
 249    *
 250    * @param tridiagonalMatrix
 251    *          the value of field 'tridiagonalMatrix'.
 252    */
 253   public void setTridiagonalMatrix(
 254           final jalview.schemabinding.version2.TridiagonalMatrix tridiagonalMatrix)
 255   {
 256     this._tridiagonalMatrix = tridiagonalMatrix;
 257   }
 258
 259   /**
 260    * Method unmarshal.
 261    *
 262    * @param reader
 263    * @throws org.exolab.castor.xml.MarshalException
 264    *           if object is null or if any SAXException is thrown during
 265    *           marshaling
 266    * @throws org.exolab.castor.xml.ValidationException
 267    *           if this object is an invalid instance according to the schema
 268    * @return the unmarshaled jalview.schemabinding.version2.PcaDataType
 269    */
 270   public static jalview.schemabinding.version2.PcaDataType unmarshal(
 271           final java.io.Reader reader)
 272           throws org.exolab.castor.xml.MarshalException,
 273           org.exolab.castor.xml.ValidationException
 274   {
 275     return (jalview.schemabinding.version2.PcaDataType) Unmarshaller
 276             .unmarshal(jalview.schemabinding.version2.PcaDataType.class,
 277                     reader);
 278   }
 279
 280   /**
 281    *
 282    *
 283    * @throws org.exolab.castor.xml.ValidationException
 284    *           if this object is an invalid instance according to the schema
 285    */
 286   public void validate() throws org.exolab.castor.xml.ValidationException
 287   {
 288     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 289     validator.validate(this);
 290   }
 291
 292 }