/*
 * 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;

/**
 * Class DoubleMatrix.
 * 
 * @version $Revision$ $Date$
 */
public class DoubleMatrix implements java.io.Serializable
{

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

  /**
   * Field _rows.
   */
  private int _rows;

  /**
   * keeps track of state for field: _rows
   */
  private boolean _has_rows;

  /**
   * Field _columns.
   */
  private int _columns;

  /**
   * keeps track of state for field: _columns
   */
  private boolean _has_columns;

  /**
   * Field _rowList.
   */
  private java.util.Vector _rowList;

  /**
   * Field _d.
   */
  private jalview.schemabinding.version2.D _d;

  /**
   * Field _e.
   */
  private jalview.schemabinding.version2.E _e;

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

  public DoubleMatrix()
  {
    super();
    this._rowList = new java.util.Vector();
  }

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

  /**
   * 
   * 
   * @param vRow
   * @throws java.lang.IndexOutOfBoundsException
   *           if the index given is outside the bounds of the collection
   */
  public void addRow(final jalview.schemabinding.version2.Row vRow)
          throws java.lang.IndexOutOfBoundsException
  {
    this._rowList.addElement(vRow);
  }

  /**
   * 
   * 
   * @param index
   * @param vRow
   * @throws java.lang.IndexOutOfBoundsException
   *           if the index given is outside the bounds of the collection
   */
  public void addRow(final int index,
          final jalview.schemabinding.version2.Row vRow)
          throws java.lang.IndexOutOfBoundsException
  {
    this._rowList.add(index, vRow);
  }

  /**
   */
  public void deleteColumns()
  {
    this._has_columns = false;
  }

  /**
   */
  public void deleteRows()
  {
    this._has_rows = false;
  }

  /**
   * Method enumerateRow.
   * 
   * @return an Enumeration over all jalview.schemabinding.version2.Row elements
   */
  public java.util.Enumeration enumerateRow()
  {
    return this._rowList.elements();
  }

  /**
   * Returns the value of field 'columns'.
   * 
   * @return the value of field 'Columns'.
   */
  public int getColumns()
  {
    return this._columns;
  }

  /**
   * Returns the value of field 'd'.
   * 
   * @return the value of field 'D'.
   */
  public jalview.schemabinding.version2.D getD()
  {
    return this._d;
  }

  /**
   * Returns the value of field 'e'.
   * 
   * @return the value of field 'E'.
   */
  public jalview.schemabinding.version2.E getE()
  {
    return this._e;
  }

  /**
   * Method getRow.
   * 
   * @param index
   * @throws java.lang.IndexOutOfBoundsException
   *           if the index given is outside the bounds of the collection
   * @return the value of the jalview.schemabinding.version2.Row at the given
   *         index
   */
  public jalview.schemabinding.version2.Row getRow(final int index)
          throws java.lang.IndexOutOfBoundsException
  {
    // check bounds for index
    if (index < 0 || index >= this._rowList.size())
    {
      throw new IndexOutOfBoundsException("getRow: Index value '" + index
              + "' not in range [0.." + (this._rowList.size() - 1) + "]");
    }

    return (jalview.schemabinding.version2.Row) _rowList.get(index);
  }

  /**
   * Method getRow.Returns the contents of the collection in an Array.
   * <p>
   * Note: Just in case the collection contents are changing in another thread,
   * we pass a 0-length Array of the correct type into the API call. This way we
   * <i>know</i> that the Array returned is of exactly the correct length.
   * 
   * @return this collection as an Array
   */
  public jalview.schemabinding.version2.Row[] getRow()
  {
    jalview.schemabinding.version2.Row[] array = new jalview.schemabinding.version2.Row[0];
    return (jalview.schemabinding.version2.Row[]) this._rowList
            .toArray(array);
  }

  /**
   * Method getRowCount.
   * 
   * @return the size of this collection
   */
  public int getRowCount()
  {
    return this._rowList.size();
  }

  /**
   * Returns the value of field 'rows'.
   * 
   * @return the value of field 'Rows'.
   */
  public int getRows()
  {
    return this._rows;
  }

  /**
   * Method hasColumns.
   * 
   * @return true if at least one Columns has been added
   */
  public boolean hasColumns()
  {
    return this._has_columns;
  }

  /**
   * Method hasRows.
   * 
   * @return true if at least one Rows has been added
   */
  public boolean hasRows()
  {
    return this._has_rows;
  }

  /**
   * 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);
  }

  /**
   */
  public void removeAllRow()
  {
    this._rowList.clear();
  }

  /**
   * Method removeRow.
   * 
   * @param vRow
   * @return true if the object was removed from the collection.
   */
  public boolean removeRow(final jalview.schemabinding.version2.Row vRow)
  {
    boolean removed = _rowList.remove(vRow);
    return removed;
  }

  /**
   * Method removeRowAt.
   * 
   * @param index
   * @return the element removed from the collection
   */
  public jalview.schemabinding.version2.Row removeRowAt(final int index)
  {
    java.lang.Object obj = this._rowList.remove(index);
    return (jalview.schemabinding.version2.Row) obj;
  }

  /**
   * Sets the value of field 'columns'.
   * 
   * @param columns
   *          the value of field 'columns'.
   */
  public void setColumns(final int columns)
  {
    this._columns = columns;
    this._has_columns = true;
  }

  /**
   * Sets the value of field 'd'.
   * 
   * @param d
   *          the value of field 'd'.
   */
  public void setD(final jalview.schemabinding.version2.D d)
  {
    this._d = d;
  }

  /**
   * Sets the value of field 'e'.
   * 
   * @param e
   *          the value of field 'e'.
   */
  public void setE(final jalview.schemabinding.version2.E e)
  {
    this._e = e;
  }

  /**
   * 
   * 
   * @param index
   * @param vRow
   * @throws java.lang.IndexOutOfBoundsException
   *           if the index given is outside the bounds of the collection
   */
  public void setRow(final int index,
          final jalview.schemabinding.version2.Row vRow)
          throws java.lang.IndexOutOfBoundsException
  {
    // check bounds for index
    if (index < 0 || index >= this._rowList.size())
    {
      throw new IndexOutOfBoundsException("setRow: Index value '" + index
              + "' not in range [0.." + (this._rowList.size() - 1) + "]");
    }

    this._rowList.set(index, vRow);
  }

  /**
   * 
   * 
   * @param vRowArray
   */
  public void setRow(final jalview.schemabinding.version2.Row[] vRowArray)
  {
    // -- copy array
    _rowList.clear();

    for (int i = 0; i < vRowArray.length; i++)
    {
      this._rowList.add(vRowArray[i]);
    }
  }

  /**
   * Sets the value of field 'rows'.
   * 
   * @param rows
   *          the value of field 'rows'.
   */
  public void setRows(final int rows)
  {
    this._rows = rows;
    this._has_rows = true;
  }

  /**
   * 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.DoubleMatrix
   */
  public static jalview.schemabinding.version2.DoubleMatrix unmarshal(
          final java.io.Reader reader)
          throws org.exolab.castor.xml.MarshalException,
          org.exolab.castor.xml.ValidationException
  {
    return (jalview.schemabinding.version2.DoubleMatrix) Unmarshaller
            .unmarshal(jalview.schemabinding.version2.DoubleMatrix.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);
  }

}