/* ===========================================================

 * JFreeChart : a free chart library for the Java(tm) platform

 * ===========================================================

 *

 * (C) Copyright 2000-2004, by Object Refinery Limited and Contributors.

 *

 * Project Info:  http://www.jfree.org/jfreechart/index.html

 *

 * This library is free software; you can redistribute it and/or modify it under the terms

 * of the GNU Lesser General Public License as published by the Free Software Foundation;

 * either version 2.1 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

 * See the GNU Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public License along with this

 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,

 * Boston, MA 02111-1307, USA.

 *

 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

 * in the United States and other countries.]

 *

 * ------------------

 * ContourEntity.java

 * ------------------

 * (C) Copyright 2002-2004, by David M. O'Donnell and Contributors.

 *

 * Original Author:  David M. O'Donnell;

 * Contributor(s):   David Gilbert (for Object Refinery Limited);

 *

 * $Id: ContourEntity.java,v 1.1 2004/08/31 14:32:37 mungady Exp $

 *

 * Changes

 * -------

 * 26-Nov-2002 : Version 1 contributed by David M. O'Donnell (DG);

 * 20-May-2004 : Added equals() and clone() methods and implemented Serializable (DG);

 *

 */



package org.jfree.chart.entity;



import java.awt.Shape;

import java.io.Serializable;



/**

 * Represents an item on a contour chart.

 *

 * @author David M. O'Donnell

 */

public class ContourEntity extends ChartEntity implements Cloneable, Serializable {



    /** Holds the index into the dataset for this entity. */

    private int index = -1;



    /**

     * Constructor for ContourEntity.

     *

     * @param area  the area.

     * @param toolTipText  the tooltip text.

     */

    public ContourEntity(Shape area, String toolTipText) {

        super(area, toolTipText);

    }



    /**

     * Constructor for ContourEntity.

     *

     * @param area  the area.

     * @param toolTipText  the tooltip text.

     * @param urlText  the URL text.

     */

    public ContourEntity(Shape area, String toolTipText, String urlText) {

        super(area, toolTipText, urlText);

    }



    /**

     * Returns the index.

     *

     * @return The index.

     */

    public int getIndex() {

        return this.index;

    }



    /**

     * Sets the index.

     *

     * @param index  the index.

     */

    public void setIndex(int index) {

        this.index = index;

    }



    /**

     * Tests the entity for equality with an arbitrary object.

     * 

     * @param obj  the object (<code>null</code> permitted).

     * 

     * @return A boolean.

     */

    public boolean equals(Object obj) {

        if (obj == this) {

            return true;   

        }

        if (obj instanceof ContourEntity && super.equals(obj)) {

            ContourEntity ce = (ContourEntity) obj;

            if (this.index != ce.index) {

                return false;   

            }

            return true;

        }

        return false;

    }

    

    /**

     * Returns a clone of the entity.

     * 

     * @return A clone.

     * 

     * @throws CloneNotSupportedException if cloning is not supported.

     */

    public Object clone() throws CloneNotSupportedException {

        return super.clone();

    }

    

}

