content: /* ===========================================================
   * JFreeChart : a free chart library for the Java(tm) platform
   * ===========================================================
   *
   * (C) Copyright 2000-2012, 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
   * USA.
   *
   * [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
   * Other names may be trademarks of their respective owners.]
   *
   * ---------------------------------
   * SymbolicXYItemLabelGenerator.java
   * ---------------------------------
   * (C) Copyright 2001-2012, by Anthony Boulestreau and Contributors.
   *
   * Original Author:  Anthony Boulestreau;
   * Contributor(s):   David Gilbert (for Object Refinery Limited);
   *
   * Changes
   * -------
   * 29-Mar-2002 : Version 1, contributed by Anthony Boulestreau (DG);
   * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG);
   * 23-Mar-2003 : Implemented Serializable (DG);
   * 13-Aug-2003 : Implemented Cloneable (DG);
   * 17-Nov-2003 : Implemented PublicCloneable (DG);
   * 25-Feb-2004 : Renamed XYToolTipGenerator --> XYItemLabelGenerator (DG);
   * 19-Jan-2005 : Now accesses primitives only from dataset (DG);
   * 20-Apr-2005 : Renamed XYLabelGenerator --> XYItemLabelGenerator (DG);
   * 02-Feb-2007 : Removed author tags all over JFreeChart sources (DG);
   * 31-Mar-2008 : Added hashCode() method to appease FindBugs (DG);
   * 17-Jun-2012 : Removed JCommon dependencies (DG);
   *
   */
  
  package org.jfree.chart.labels;
  
  import java.io.Serializable;
  
  import org.jfree.chart.util.PublicCloneable;
  import org.jfree.data.time.RegularTimePeriod;
  import org.jfree.data.time.TimeSeriesCollection;
  import org.jfree.data.xy.XYDataset;
  import org.jfree.data.xy.XisSymbolic;
  import org.jfree.data.xy.YisSymbolic;
  
  /**
   * A standard item label generator for plots that use data from an
   * {@link XYDataset}.
   */
  public class SymbolicXYItemLabelGenerator implements XYItemLabelGenerator,
          XYToolTipGenerator, Cloneable, PublicCloneable, Serializable {
  
      /** For serialization. */
      private static final long serialVersionUID = 3963400354475494395L;
  
      /**
       * Generates a tool tip text item for a particular item within a series.
       *
       * @param data  the dataset.
       * @param series  the series number (zero-based index).
       * @param item  the item number (zero-based index).
       *
       * @return The tool tip text (possibly <code>null</code>).
       */
      @Override
      public String generateToolTip(XYDataset data, int series, int item) {
  
          String xStr, yStr;
          if (data instanceof YisSymbolic) {
              yStr = ((YisSymbolic) data).getYSymbolicValue(series, item);
          }
          else {
              double y = data.getYValue(series, item);
              yStr = Double.toString(round(y, 2));
          }
          if (data instanceof XisSymbolic) {
              xStr = ((XisSymbolic) data).getXSymbolicValue(series, item);
          }
          else if (data instanceof TimeSeriesCollection) {
              RegularTimePeriod p
                  = ((TimeSeriesCollection) data).getSeries(series)
                      .getTimePeriod(item);
              xStr = p.toString();
          }
          else {
              double x = data.getXValue(series, item);
              xStr = Double.toString(round(x, 2));
          }
          return "X: " + xStr + ", Y: " + yStr;
      }
  
      /**
       * Generates a label for the specified item. The label is typically a
       * formatted version of the data value, but any text can be used.
       *
       * @param dataset  the dataset (<code>null</code> not permitted).
       * @param series  the series index (zero-based).
       * @param category  the category index (zero-based).
       *
       * @return The label (possibly <code>null</code>).
       */
      @Override
      public String generateLabel(XYDataset dataset, int series, int category) {
          return null;  //TODO: implement this method properly
      }
  
      /**
      * Round a double value.
      *
      * @param value  the value.
      * @param nb  the exponent.
      *
      * @return The rounded value.
      */
      private static double round(double value, int nb) {
          if (nb <= 0) {
              return Math.floor(value + 0.5d);
          }
          double p = Math.pow(10, nb);
          double tempval = Math.floor(value * p + 0.5d);
          return tempval / p;
      }
  
      /**
       * Returns an independent copy of the generator.
       *
       * @return A clone.
       *
       * @throws CloneNotSupportedException if cloning is not supported.
       */
      @Override
      public Object clone() throws CloneNotSupportedException {
          return super.clone();
      }
  
      /**
       * Tests if this object is equal to another.
       *
       * @param obj  the other object.
       *
       * @return A boolean.
       */
      @Override
      public boolean equals(Object obj) {
          if (obj == this) {
              return true;
          }
          if (obj instanceof SymbolicXYItemLabelGenerator) {
              return true;
          }
          return false;
      }
  
      /**
       * Returns a hash code for this instance.
       *
       * @return A hash code.
       */
      @Override
      public int hashCode() {
          int result = 127;
          return result;
      }
  
  }
  