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

package uk.ac.vamsas.objects.core;

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

import java.io.IOException;
import java.io.Reader;
import java.io.Serializable;
import java.io.Writer;
import org.exolab.castor.xml.MarshalException;
import org.exolab.castor.xml.Marshaller;
import org.exolab.castor.xml.Unmarshaller;
import org.exolab.castor.xml.ValidationException;
import org.xml.sax.ContentHandler;

/**
 * a region from start to end, with flag for inclusivity of
 *  terminii 
 * 
 * @version $Revision$ $Date$
 */
public class Seg extends uk.ac.vamsas.client.Vobject 
implements java.io.Serializable
{


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

    /**
     * Field _start
     */
    private int _start;

    /**
     * keeps track of state for field: _start
     */
    private boolean _has_start;

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

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

    /**
     * when false, a consecutive range like 'start=1, end=2'
     *  means the region lying after position 1 and before position
     * 2
     *  
     */
    private boolean _inclusive;

    /**
     * keeps track of state for field: _inclusive
     */
    private boolean _has_inclusive;


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

    public Seg() 
     {
        super();
    } //-- uk.ac.vamsas.objects.core.Seg()


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

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

    /**
     * Method deleteInclusive
     * 
     */
    public void deleteInclusive()
    {
        this._has_inclusive= false;
    } //-- void deleteInclusive() 

    /**
     * Method deleteStart
     * 
     */
    public void deleteStart()
    {
        this._has_start= false;
    } //-- void deleteStart() 

    /**
     * Note: hashCode() has not been overriden
     * 
     * @param obj
     * @return boolean
     */
    public boolean equals(java.lang.Object obj)
    {
        if ( this == obj )
            return true;
        
        if (super.equals(obj)==false)
            return false;
        
        if (obj instanceof Seg) {
        
            Seg temp = (Seg)obj;
            if (this._start != temp._start)
                return false;
            if (this._has_start != temp._has_start)
                return false;
            if (this._end != temp._end)
                return false;
            if (this._has_end != temp._has_end)
                return false;
            if (this._inclusive != temp._inclusive)
                return false;
            if (this._has_inclusive != temp._has_inclusive)
                return false;
            return true;
        }
        return false;
    } //-- boolean equals(java.lang.Object) 

    /**
     * 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 'inclusive'. The field
     * 'inclusive' has the following description: when false, a
     * consecutive range like 'start=1, end=2'
     *  means the region lying after position 1 and before position
     * 2
     *  
     * 
     * @return boolean
     * @return the value of field 'inclusive'.
     */
    public boolean getInclusive()
    {
        return this._inclusive;
    } //-- boolean getInclusive() 

    /**
     * Returns the value of field 'start'.
     * 
     * @return int
     * @return the value of field 'start'.
     */
    public int getStart()
    {
        return this._start;
    } //-- int getStart() 

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

    /**
     * Method hasInclusive
     * 
     * 
     * 
     * @return boolean
     */
    public boolean hasInclusive()
    {
        return this._has_inclusive;
    } //-- boolean hasInclusive() 

    /**
     * Method hasStart
     * 
     * 
     * 
     * @return boolean
     */
    public boolean hasStart()
    {
        return this._has_start;
    } //-- boolean hasStart() 

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

    /**
     * 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 'inclusive'. The field 'inclusive'
     * has the following description: when false, a consecutive
     * range like 'start=1, end=2'
     *  means the region lying after position 1 and before position
     * 2
     *  
     * 
     * @param inclusive the value of field 'inclusive'.
     */
    public void setInclusive(boolean inclusive)
    {
        this._inclusive = inclusive;
        this._has_inclusive = true;
    } //-- void setInclusive(boolean) 

    /**
     * Sets the value of field 'start'.
     * 
     * @param start the value of field 'start'.
     */
    public void setStart(int start)
    {
        this._start = start;
        this._has_start = true;
    } //-- void setStart(int) 

    /**
     * Method unmarshal
     * 
     * 
     * 
     * @param reader
     * @return Seg
     */
    public static uk.ac.vamsas.objects.core.Seg unmarshal(java.io.Reader reader)
        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        return (uk.ac.vamsas.objects.core.Seg) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.Seg.class, reader);
    } //-- uk.ac.vamsas.objects.core.Seg 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() 

}