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

package jalview.schemabinding.version2;

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

import java.util.*;

import org.exolab.castor.xml.*;

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

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

  /**
   * Field _begin
   */
  private int _begin;

  /**
   * keeps track of state for field: _begin
   */
  private boolean _has_begin;

  /**
   * Field _end
   */
  private int _end;

  /**
   * keeps track of state for field: _end
   */
  private boolean _has_end;

  /**
   * Field _type
   */
  private java.lang.String _type;

  /**
   * Field _description
   */
  private java.lang.String _description;

  /**
   * Field _status
   */
  private java.lang.String _status;

  /**
   * Field _featureGroup
   */
  private java.lang.String _featureGroup;

  /**
   * Field _score
   */
  private float _score;

  /**
   * keeps track of state for field: _score
   */
  private boolean _has_score;

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

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

  public Feature()
  {
    super();
    _otherDataList = new Vector();
  } //-- jalview.schemabinding.version2.Feature()

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

  /**
   * Method addOtherData
   *
   *
   *
   * @param vOtherData
   */
  public void addOtherData(jalview.schemabinding.version2.OtherData vOtherData)
      throws java.lang.IndexOutOfBoundsException
  {
    _otherDataList.addElement(vOtherData);
  } //-- void addOtherData(jalview.schemabinding.version2.OtherData)

  /**
   * Method addOtherData
   *
   *
   *
   * @param index
   * @param vOtherData
   */
  public void addOtherData(int index,
                           jalview.schemabinding.version2.OtherData vOtherData)
      throws java.lang.IndexOutOfBoundsException
  {
    _otherDataList.insertElementAt(vOtherData, index);
  } //-- void addOtherData(int, jalview.schemabinding.version2.OtherData)

  /**
   * Method deleteBegin
   *
   */
  public void deleteBegin()
  {
    this._has_begin = false;
  } //-- void deleteBegin()

  /**
   * Method deleteEnd
   *
   */
  public void deleteEnd()
  {
    this._has_end = false;
  } //-- void deleteEnd()

  /**
   * Method deleteScore
   *
   */
  public void deleteScore()
  {
    this._has_score = false;
  } //-- void deleteScore()

  /**
   * Method enumerateOtherData
   *
   *
   *
   * @return Enumeration
   */
  public java.util.Enumeration enumerateOtherData()
  {
    return _otherDataList.elements();
  } //-- java.util.Enumeration enumerateOtherData()

  /**
   * Returns the value of field 'begin'.
   *
   * @return int
   * @return the value of field 'begin'.
   */
  public int getBegin()
  {
    return this._begin;
  } //-- int getBegin()

  /**
   * Returns the value of field 'description'.
   *
   * @return String
   * @return the value of field 'description'.
   */
  public java.lang.String getDescription()
  {
    return this._description;
  } //-- java.lang.String getDescription()

  /**
   * Returns the value of field 'end'.
   *
   * @return int
   * @return the value of field 'end'.
   */
  public int getEnd()
  {
    return this._end;
  } //-- int getEnd()

  /**
   * Returns the value of field 'featureGroup'.
   *
   * @return String
   * @return the value of field 'featureGroup'.
   */
  public java.lang.String getFeatureGroup()
  {
    return this._featureGroup;
  } //-- java.lang.String getFeatureGroup()

  /**
   * Method getOtherData
   *
   *
   *
   * @param index
   * @return OtherData
   */
  public jalview.schemabinding.version2.OtherData getOtherData(int index)
      throws java.lang.IndexOutOfBoundsException
  {
    //-- check bounds for index
    if ( (index < 0) || (index > _otherDataList.size()))
    {
      throw new IndexOutOfBoundsException();
    }

    return (jalview.schemabinding.version2.OtherData) _otherDataList.elementAt(
        index);
  } //-- jalview.schemabinding.version2.OtherData getOtherData(int)

  /**
   * Method getOtherData
   *
   *
   *
   * @return OtherData
   */
  public jalview.schemabinding.version2.OtherData[] getOtherData()
  {
    int size = _otherDataList.size();
    jalview.schemabinding.version2.OtherData[] mArray = new jalview.
        schemabinding.version2.OtherData[size];
    for (int index = 0; index < size; index++)
    {
      mArray[index] = (jalview.schemabinding.version2.OtherData) _otherDataList.
          elementAt(index);
    }
    return mArray;
  } //-- jalview.schemabinding.version2.OtherData[] getOtherData()

  /**
   * Method getOtherDataCount
   *
   *
   *
   * @return int
   */
  public int getOtherDataCount()
  {
    return _otherDataList.size();
  } //-- int getOtherDataCount()

  /**
   * Returns the value of field 'score'.
   *
   * @return float
   * @return the value of field 'score'.
   */
  public float getScore()
  {
    return this._score;
  } //-- float getScore()

  /**
   * Returns the value of field 'status'.
   *
   * @return String
   * @return the value of field 'status'.
   */
  public java.lang.String getStatus()
  {
    return this._status;
  } //-- java.lang.String getStatus()

  /**
   * Returns the value of field 'type'.
   *
   * @return String
   * @return the value of field 'type'.
   */
  public java.lang.String getType()
  {
    return this._type;
  } //-- java.lang.String getType()

  /**
   * Method hasBegin
   *
   *
   *
   * @return boolean
   */
  public boolean hasBegin()
  {
    return this._has_begin;
  } //-- boolean hasBegin()

  /**
   * Method hasEnd
   *
   *
   *
   * @return boolean
   */
  public boolean hasEnd()
  {
    return this._has_end;
  } //-- boolean hasEnd()

  /**
   * Method hasScore
   *
   *
   *
   * @return boolean
   */
  public boolean hasScore()
  {
    return this._has_score;
  } //-- boolean hasScore()

  /**
   * Method isValid
   *
   *
   *
   * @return boolean
   */
  public boolean isValid()
  {
    try
    {
      validate();
    }
    catch (org.exolab.castor.xml.ValidationException vex)
    {
      return false;
    }
    return true;
  } //-- boolean isValid()

  /**
   * Method marshal
   *
   *
   *
   * @param out
   */
  public void marshal(java.io.Writer out)
      throws org.exolab.castor.xml.MarshalException,
      org.exolab.castor.xml.ValidationException
  {

    Marshaller.marshal(this, out);
  } //-- void marshal(java.io.Writer)

  /**
   * Method marshal
   *
   *
   *
   * @param handler
   */
  public void marshal(org.xml.sax.ContentHandler handler)
      throws java.io.IOException, org.exolab.castor.xml.MarshalException,
      org.exolab.castor.xml.ValidationException
  {

    Marshaller.marshal(this, handler);
  } //-- void marshal(org.xml.sax.ContentHandler)

  /**
   * Method removeAllOtherData
   *
   */
  public void removeAllOtherData()
  {
    _otherDataList.removeAllElements();
  } //-- void removeAllOtherData()

  /**
   * Method removeOtherData
   *
   *
   *
   * @param index
   * @return OtherData
   */
  public jalview.schemabinding.version2.OtherData removeOtherData(int index)
  {
    java.lang.Object obj = _otherDataList.elementAt(index);
    _otherDataList.removeElementAt(index);
    return (jalview.schemabinding.version2.OtherData) obj;
  } //-- jalview.schemabinding.version2.OtherData removeOtherData(int)

  /**
   * Sets the value of field 'begin'.
   *
   * @param begin the value of field 'begin'.
   */
  public void setBegin(int begin)
  {
    this._begin = begin;
    this._has_begin = true;
  } //-- void setBegin(int)

  /**
   * Sets the value of field 'description'.
   *
   * @param description the value of field 'description'.
   */
  public void setDescription(java.lang.String description)
  {
    this._description = description;
  } //-- void setDescription(java.lang.String)

  /**
   * Sets the value of field 'end'.
   *
   * @param end the value of field 'end'.
   */
  public void setEnd(int end)
  {
    this._end = end;
    this._has_end = true;
  } //-- void setEnd(int)

  /**
   * Sets the value of field 'featureGroup'.
   *
   * @param featureGroup the value of field 'featureGroup'.
   */
  public void setFeatureGroup(java.lang.String featureGroup)
  {
    this._featureGroup = featureGroup;
  } //-- void setFeatureGroup(java.lang.String)

  /**
   * Method setOtherData
   *
   *
   *
   * @param index
   * @param vOtherData
   */
  public void setOtherData(int index,
                           jalview.schemabinding.version2.OtherData vOtherData)
      throws java.lang.IndexOutOfBoundsException
  {
    //-- check bounds for index
    if ( (index < 0) || (index > _otherDataList.size()))
    {
      throw new IndexOutOfBoundsException();
    }
    _otherDataList.setElementAt(vOtherData, index);
  } //-- void setOtherData(int, jalview.schemabinding.version2.OtherData)

  /**
   * Method setOtherData
   *
   *
   *
   * @param otherDataArray
   */
  public void setOtherData(jalview.schemabinding.version2.OtherData[]
                           otherDataArray)
  {
    //-- copy array
    _otherDataList.removeAllElements();
    for (int i = 0; i < otherDataArray.length; i++)
    {
      _otherDataList.addElement(otherDataArray[i]);
    }
  } //-- void setOtherData(jalview.schemabinding.version2.OtherData)

  /**
   * Sets the value of field 'score'.
   *
   * @param score the value of field 'score'.
   */
  public void setScore(float score)
  {
    this._score = score;
    this._has_score = true;
  } //-- void setScore(float)

  /**
   * Sets the value of field 'status'.
   *
   * @param status the value of field 'status'.
   */
  public void setStatus(java.lang.String status)
  {
    this._status = status;
  } //-- void setStatus(java.lang.String)

  /**
   * Sets the value of field 'type'.
   *
   * @param type the value of field 'type'.
   */
  public void setType(java.lang.String type)
  {
    this._type = type;
  } //-- void setType(java.lang.String)

  /**
   * Method unmarshal
   *
   *
   *
   * @param reader
   * @return Object
   */
  public static java.lang.Object unmarshal(java.io.Reader reader)
      throws org.exolab.castor.xml.MarshalException,
      org.exolab.castor.xml.ValidationException
  {
    return (jalview.schemabinding.version2.Feature) Unmarshaller.unmarshal(
        jalview.schemabinding.version2.Feature.class, reader);
  } //-- java.lang.Object unmarshal(java.io.Reader)

  /**
   * Method validate
   *
   */
  public void validate()
      throws org.exolab.castor.xml.ValidationException
  {
    org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.
        Validator();
    validator.validate(this);
  } //-- void validate()

}