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    * The text report of the calculation
  32    *
  33    */
  34   private java.lang.String _details;
  35
  36   /**
  37    * Field _pairwiseMatrix.
  38    */
  39   private jalview.schemabinding.version2.PairwiseMatrix _pairwiseMatrix;
  40
  41   /**
  42    * Field _eigenMatrix.
  43    */
  44   private jalview.schemabinding.version2.EigenMatrix _eigenMatrix;
  45
  46   /**
  47    * Field _eigenMatrixD.
  48    */
  49   private jalview.schemabinding.version2.EigenMatrixD _eigenMatrixD;
  50
  51   /**
  52    * Field _eigenMatrixE.
  53    */
  54   private jalview.schemabinding.version2.EigenMatrixE _eigenMatrixE;
  55
  56   // ----------------/
  57   // - Constructors -/
  58   // ----------------/
  59
  60   public PcaDataType()
  61   {
  62     super();
  63   }
  64
  65   // -----------/
  66   // - Methods -/
  67   // -----------/
  68
  69   /**
  70    * Returns the value of field 'details'. The field 'details' has the following
  71    * description: The text report of the calculation
  72    *
  73    *
  74    * @return the value of field 'Details'.
  75    */
  76   public java.lang.String getDetails()
  77   {
  78     return this._details;
  79   }
  80
  81   /**
  82    * Returns the value of field 'eigenMatrix'.
  83    *
  84    * @return the value of field 'EigenMatrix'.
  85    */
  86   public jalview.schemabinding.version2.EigenMatrix getEigenMatrix()
  87   {
  88     return this._eigenMatrix;
  89   }
  90
  91   /**
  92    * Returns the value of field 'eigenMatrixD'.
  93    *
  94    * @return the value of field 'EigenMatrixD'.
  95    */
  96   public jalview.schemabinding.version2.EigenMatrixD getEigenMatrixD()
  97   {
  98     return this._eigenMatrixD;
  99   }
 100
 101   /**
 102    * Returns the value of field 'eigenMatrixE'.
 103    *
 104    * @return the value of field 'EigenMatrixE'.
 105    */
 106   public jalview.schemabinding.version2.EigenMatrixE getEigenMatrixE()
 107   {
 108     return this._eigenMatrixE;
 109   }
 110
 111   /**
 112    * Returns the value of field 'pairwiseMatrix'.
 113    *
 114    * @return the value of field 'PairwiseMatrix'.
 115    */
 116   public jalview.schemabinding.version2.PairwiseMatrix getPairwiseMatrix()
 117   {
 118     return this._pairwiseMatrix;
 119   }
 120
 121   /**
 122    * Method isValid.
 123    *
 124    * @return true if this object is valid according to the schema
 125    */
 126   public boolean isValid()
 127   {
 128     try
 129     {
 130       validate();
 131     } catch (org.exolab.castor.xml.ValidationException vex)
 132     {
 133       return false;
 134     }
 135     return true;
 136   }
 137
 138   /**
 139    *
 140    *
 141    * @param out
 142    * @throws org.exolab.castor.xml.MarshalException
 143    *           if object is null or if any SAXException is thrown during
 144    *           marshaling
 145    * @throws org.exolab.castor.xml.ValidationException
 146    *           if this object is an invalid instance according to the schema
 147    */
 148   public void marshal(final java.io.Writer out)
 149           throws org.exolab.castor.xml.MarshalException,
 150           org.exolab.castor.xml.ValidationException
 151   {
 152     Marshaller.marshal(this, out);
 153   }
 154
 155   /**
 156    *
 157    *
 158    * @param handler
 159    * @throws java.io.IOException
 160    *           if an IOException occurs during marshaling
 161    * @throws org.exolab.castor.xml.ValidationException
 162    *           if this object is an invalid instance according to the schema
 163    * @throws org.exolab.castor.xml.MarshalException
 164    *           if object is null or if any SAXException is thrown during
 165    *           marshaling
 166    */
 167   public void marshal(final org.xml.sax.ContentHandler handler)
 168           throws java.io.IOException,
 169           org.exolab.castor.xml.MarshalException,
 170           org.exolab.castor.xml.ValidationException
 171   {
 172     Marshaller.marshal(this, handler);
 173   }
 174
 175   /**
 176    * Sets the value of field 'details'. The field 'details' has the following
 177    * description: The text report of the calculation
 178    *
 179    *
 180    * @param details
 181    *          the value of field 'details'.
 182    */
 183   public void setDetails(final java.lang.String details)
 184   {
 185     this._details = details;
 186   }
 187
 188   /**
 189    * Sets the value of field 'eigenMatrix'.
 190    *
 191    * @param eigenMatrix
 192    *          the value of field 'eigenMatrix'.
 193    */
 194   public void setEigenMatrix(
 195           final jalview.schemabinding.version2.EigenMatrix eigenMatrix)
 196   {
 197     this._eigenMatrix = eigenMatrix;
 198   }
 199
 200   /**
 201    * Sets the value of field 'eigenMatrixD'.
 202    *
 203    * @param eigenMatrixD
 204    *          the value of field 'eigenMatrixD'.
 205    */
 206   public void setEigenMatrixD(
 207           final jalview.schemabinding.version2.EigenMatrixD eigenMatrixD)
 208   {
 209     this._eigenMatrixD = eigenMatrixD;
 210   }
 211
 212   /**
 213    * Sets the value of field 'eigenMatrixE'.
 214    *
 215    * @param eigenMatrixE
 216    *          the value of field 'eigenMatrixE'.
 217    */
 218   public void setEigenMatrixE(
 219           final jalview.schemabinding.version2.EigenMatrixE eigenMatrixE)
 220   {
 221     this._eigenMatrixE = eigenMatrixE;
 222   }
 223
 224   /**
 225    * Sets the value of field 'pairwiseMatrix'.
 226    *
 227    * @param pairwiseMatrix
 228    *          the value of field 'pairwiseMatrix'.
 229    */
 230   public void setPairwiseMatrix(
 231           final jalview.schemabinding.version2.PairwiseMatrix pairwiseMatrix)
 232   {
 233     this._pairwiseMatrix = pairwiseMatrix;
 234   }
 235
 236   /**
 237    * Method unmarshal.
 238    *
 239    * @param reader
 240    * @throws org.exolab.castor.xml.MarshalException
 241    *           if object is null or if any SAXException is thrown during
 242    *           marshaling
 243    * @throws org.exolab.castor.xml.ValidationException
 244    *           if this object is an invalid instance according to the schema
 245    * @return the unmarshaled jalview.schemabinding.version2.PcaDataType
 246    */
 247   public static jalview.schemabinding.version2.PcaDataType unmarshal(
 248           final java.io.Reader reader)
 249           throws org.exolab.castor.xml.MarshalException,
 250           org.exolab.castor.xml.ValidationException
 251   {
 252     return (jalview.schemabinding.version2.PcaDataType) Unmarshaller
 253             .unmarshal(jalview.schemabinding.version2.PcaDataType.class,
 254                     reader);
 255   }
 256
 257   /**
 258    *
 259    *
 260    * @throws org.exolab.castor.xml.ValidationException
 261    *           if this object is an invalid instance according to the schema
 262    */
 263   public void validate() throws org.exolab.castor.xml.ValidationException
 264   {
 265     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 266     validator.validate(this);
 267   }
 268
 269 }