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

 * 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.]

 *

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

 * SymbolicTickUnit.java

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

 * (C) Copyright 2002-2004, by Anthony Boulestreau.

 *

 * Original Author:  Anthony Boulestreau;

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

 *

 * $Id: SymbolicTickUnit.java,v 1.1 2004/08/31 14:30:24 mungady Exp $

 *

 * Changes

 * -------

 * 01-May-2002 : Version 1, creation of SymbolicTickUnit to work with VerticalSymbolicAxis and

 *               HorizontalSymbolicAxis (AB);

 * 01-Oct-2002 : Fixed errors reported by Checkstyle (DG):

 * 08-Nov-2002 : Moved to new package com.jrefinery.chart.axis (DG);

 * 26-Mar-2003 : Implemented Serializable (DG);

 * 03-Dec-2003 : There is no need for using lists here; replaced by String-array (TM);

 */



package org.jfree.chart.axis;



import java.io.Serializable;



/**

 * A symbolic tick unit.

 *

 * @author Anthony Boulestreau

 */

public class SymbolicTickUnit extends NumberTickUnit implements Serializable {



    /** The list of symbolic value to display instead of the numeric values */

    private String[] symbolicValue;



    /**

     * Creates a new symbolic tick unit.

     *

     * @param size  the size of the tick unit.

     * @param sv  the list of symbolic value to display instead of the numeric value.

     */

    public SymbolicTickUnit(double size, String[] sv) {

        super(size, null);

        this.symbolicValue = new String[sv.length];

        System.arraycopy(sv, 0, this.symbolicValue, 0, sv.length);

    }



    /**

     * Converts a value to a string, using the list of symbolic values.

     * ex: if the symbolic value list is ["up", "down"] then 0 is convert to

     * "up" and 1 to "down".

     *

     * @param value  value to convert.

     *

     * @return the symbolic value.

     */

    public String valueToString(double value) {



        if ((value < 0) || (value >= this.symbolicValue.length)) {

            throw new IllegalArgumentException (

                "The value " + value + " does not have a corresponding symbolic value");

        }

        return this.symbolicValue[(int) value];

    }



    /**

     * Returns the number of symbols in this unit.

     * 

     * @return the symbol count.

     */

    public int getSymbolCount() {

        return this.symbolicValue.length;

    }

    

}

