/*
 * This class was automatically generated with 
 * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
 * Schema.
 * $Id$
 */

package jalview.schemabinding.version2;

//---------------------------------/
//- Imported classes and packages -/
//---------------------------------/

import org.exolab.castor.xml.Marshaller;
import org.exolab.castor.xml.Unmarshaller;

/**
 * The results of a PCA calculation
 * 
 * 
 * @version $Revision$ $Date$
 */
public class PcaDataType implements java.io.Serializable
{

  // --------------------------/
  // - Class/Member Variables -/
  // --------------------------/

  /**
   * Field _pairwiseMatrix.
   */
  private jalview.schemabinding.version2.PairwiseMatrix _pairwiseMatrix;

  /**
   * Field _tridiagonalMatrix.
   */
  private jalview.schemabinding.version2.TridiagonalMatrix _tridiagonalMatrix;

  /**
   * Field _eigenMatrix.
   */
  private jalview.schemabinding.version2.EigenMatrix _eigenMatrix;

  // ----------------/
  // - Constructors -/
  // ----------------/

  public PcaDataType()
  {
    super();
  }

  // -----------/
  // - Methods -/
  // -----------/

  /**
   * Returns the value of field 'eigenMatrix'.
   * 
   * @return the value of field 'EigenMatrix'.
   */
  public jalview.schemabinding.version2.EigenMatrix getEigenMatrix()
  {
    return this._eigenMatrix;
  }

  /**
   * Returns the value of field 'pairwiseMatrix'.
   * 
   * @return the value of field 'PairwiseMatrix'.
   */
  public jalview.schemabinding.version2.PairwiseMatrix getPairwiseMatrix()
  {
    return this._pairwiseMatrix;
  }

  /**
   * Returns the value of field 'tridiagonalMatrix'.
   * 
   * @return the value of field 'TridiagonalMatrix'.
   */
  public jalview.schemabinding.version2.TridiagonalMatrix getTridiagonalMatrix()
  {
    return this._tridiagonalMatrix;
  }

  /**
   * Method isValid.
   * 
   * @return true if this object is valid according to the schema
   */
  public boolean isValid()
  {
    try
    {
      validate();
    } catch (org.exolab.castor.xml.ValidationException vex)
    {
      return false;
    }
    return true;
  }

  /**
   * 
   * 
   * @param out
   * @throws org.exolab.castor.xml.MarshalException
   *           if object is null or if any SAXException is thrown during
   *           marshaling
   * @throws org.exolab.castor.xml.ValidationException
   *           if this object is an invalid instance according to the schema
   */
  public void marshal(final java.io.Writer out)
          throws org.exolab.castor.xml.MarshalException,
          org.exolab.castor.xml.ValidationException
  {
    Marshaller.marshal(this, out);
  }

  /**
   * 
   * 
   * @param handler
   * @throws java.io.IOException
   *           if an IOException occurs during marshaling
   * @throws org.exolab.castor.xml.ValidationException
   *           if this object is an invalid instance according to the schema
   * @throws org.exolab.castor.xml.MarshalException
   *           if object is null or if any SAXException is thrown during
   *           marshaling
   */
  public void marshal(final org.xml.sax.ContentHandler handler)
          throws java.io.IOException,
          org.exolab.castor.xml.MarshalException,
          org.exolab.castor.xml.ValidationException
  {
    Marshaller.marshal(this, handler);
  }

  /**
   * Sets the value of field 'eigenMatrix'.
   * 
   * @param eigenMatrix
   *          the value of field 'eigenMatrix'.
   */
  public void setEigenMatrix(
          final jalview.schemabinding.version2.EigenMatrix eigenMatrix)
  {
    this._eigenMatrix = eigenMatrix;
  }

  /**
   * Sets the value of field 'pairwiseMatrix'.
   * 
   * @param pairwiseMatrix
   *          the value of field 'pairwiseMatrix'.
   */
  public void setPairwiseMatrix(
          final jalview.schemabinding.version2.PairwiseMatrix pairwiseMatrix)
  {
    this._pairwiseMatrix = pairwiseMatrix;
  }

  /**
   * Sets the value of field 'tridiagonalMatrix'.
   * 
   * @param tridiagonalMatrix
   *          the value of field 'tridiagonalMatrix'.
   */
  public void setTridiagonalMatrix(
          final jalview.schemabinding.version2.TridiagonalMatrix tridiagonalMatrix)
  {
    this._tridiagonalMatrix = tridiagonalMatrix;
  }

  /**
   * Method unmarshal.
   * 
   * @param reader
   * @throws org.exolab.castor.xml.MarshalException
   *           if object is null or if any SAXException is thrown during
   *           marshaling
   * @throws org.exolab.castor.xml.ValidationException
   *           if this object is an invalid instance according to the schema
   * @return the unmarshaled jalview.schemabinding.version2.PcaDataType
   */
  public static jalview.schemabinding.version2.PcaDataType unmarshal(
          final java.io.Reader reader)
          throws org.exolab.castor.xml.MarshalException,
          org.exolab.castor.xml.ValidationException
  {
    return (jalview.schemabinding.version2.PcaDataType) Unmarshaller
            .unmarshal(jalview.schemabinding.version2.PcaDataType.class,
                    reader);
  }

  /**
   * 
   * 
   * @throws org.exolab.castor.xml.ValidationException
   *           if this object is an invalid instance according to the schema
   */
  public void validate() throws org.exolab.castor.xml.ValidationException
  {
    org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
    validator.validate(this);
  }

}