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 _eigenMatrix.
  42    */
  43   private jalview.schemabinding.version2.EigenMatrix _eigenMatrix;
  44
  45   // ----------------/
  46   // - Constructors -/
  47   // ----------------/
  48
  49   public PcaDataType()
  50   {
  51     super();
  52   }
  53
  54   // -----------/
  55   // - Methods -/
  56   // -----------/
  57
  58   /**
  59    * Returns the value of field 'eigenMatrix'.
  60    *
  61    * @return the value of field 'EigenMatrix'.
  62    */
  63   public jalview.schemabinding.version2.EigenMatrix getEigenMatrix()
  64   {
  65     return this._eigenMatrix;
  66   }
  67
  68   /**
  69    * Returns the value of field 'pairwiseMatrix'.
  70    *
  71    * @return the value of field 'PairwiseMatrix'.
  72    */
  73   public jalview.schemabinding.version2.PairwiseMatrix getPairwiseMatrix()
  74   {
  75     return this._pairwiseMatrix;
  76   }
  77
  78   /**
  79    * Returns the value of field 'tridiagonalMatrix'.
  80    *
  81    * @return the value of field 'TridiagonalMatrix'.
  82    */
  83   public jalview.schemabinding.version2.TridiagonalMatrix getTridiagonalMatrix()
  84   {
  85     return this._tridiagonalMatrix;
  86   }
  87
  88   /**
  89    * Method isValid.
  90    *
  91    * @return true if this object is valid according to the schema
  92    */
  93   public boolean isValid()
  94   {
  95     try
  96     {
  97       validate();
  98     } catch (org.exolab.castor.xml.ValidationException vex)
  99     {
 100       return false;
 101     }
 102     return true;
 103   }
 104
 105   /**
 106    *
 107    *
 108    * @param out
 109    * @throws org.exolab.castor.xml.MarshalException
 110    *           if object is null or if any SAXException is thrown during
 111    *           marshaling
 112    * @throws org.exolab.castor.xml.ValidationException
 113    *           if this object is an invalid instance according to the schema
 114    */
 115   public void marshal(final java.io.Writer out)
 116           throws org.exolab.castor.xml.MarshalException,
 117           org.exolab.castor.xml.ValidationException
 118   {
 119     Marshaller.marshal(this, out);
 120   }
 121
 122   /**
 123    *
 124    *
 125    * @param handler
 126    * @throws java.io.IOException
 127    *           if an IOException occurs during marshaling
 128    * @throws org.exolab.castor.xml.ValidationException
 129    *           if this object is an invalid instance according to the schema
 130    * @throws org.exolab.castor.xml.MarshalException
 131    *           if object is null or if any SAXException is thrown during
 132    *           marshaling
 133    */
 134   public void marshal(final org.xml.sax.ContentHandler handler)
 135           throws java.io.IOException,
 136           org.exolab.castor.xml.MarshalException,
 137           org.exolab.castor.xml.ValidationException
 138   {
 139     Marshaller.marshal(this, handler);
 140   }
 141
 142   /**
 143    * Sets the value of field 'eigenMatrix'.
 144    *
 145    * @param eigenMatrix
 146    *          the value of field 'eigenMatrix'.
 147    */
 148   public void setEigenMatrix(
 149           final jalview.schemabinding.version2.EigenMatrix eigenMatrix)
 150   {
 151     this._eigenMatrix = eigenMatrix;
 152   }
 153
 154   /**
 155    * Sets the value of field 'pairwiseMatrix'.
 156    *
 157    * @param pairwiseMatrix
 158    *          the value of field 'pairwiseMatrix'.
 159    */
 160   public void setPairwiseMatrix(
 161           final jalview.schemabinding.version2.PairwiseMatrix pairwiseMatrix)
 162   {
 163     this._pairwiseMatrix = pairwiseMatrix;
 164   }
 165
 166   /**
 167    * Sets the value of field 'tridiagonalMatrix'.
 168    *
 169    * @param tridiagonalMatrix
 170    *          the value of field 'tridiagonalMatrix'.
 171    */
 172   public void setTridiagonalMatrix(
 173           final jalview.schemabinding.version2.TridiagonalMatrix tridiagonalMatrix)
 174   {
 175     this._tridiagonalMatrix = tridiagonalMatrix;
 176   }
 177
 178   /**
 179    * Method unmarshal.
 180    *
 181    * @param reader
 182    * @throws org.exolab.castor.xml.MarshalException
 183    *           if object is null or if any SAXException is thrown during
 184    *           marshaling
 185    * @throws org.exolab.castor.xml.ValidationException
 186    *           if this object is an invalid instance according to the schema
 187    * @return the unmarshaled jalview.schemabinding.version2.PcaDataType
 188    */
 189   public static jalview.schemabinding.version2.PcaDataType unmarshal(
 190           final java.io.Reader reader)
 191           throws org.exolab.castor.xml.MarshalException,
 192           org.exolab.castor.xml.ValidationException
 193   {
 194     return (jalview.schemabinding.version2.PcaDataType) Unmarshaller
 195             .unmarshal(jalview.schemabinding.version2.PcaDataType.class,
 196                     reader);
 197   }
 198
 199   /**
 200    *
 201    *
 202    * @throws org.exolab.castor.xml.ValidationException
 203    *           if this object is an invalid instance according to the schema
 204    */
 205   public void validate() throws org.exolab.castor.xml.ValidationException
 206   {
 207     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 208     validator.validate(this);
 209   }
 210
 211 }