/*!
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program 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.
*
* Copyright (c) 2002-2013 Pentaho Corporation..  All rights reserved.
*/

package org.pentaho.plugin.jfreereport.reportcharts;

import org.jfree.chart.labels.XYZToolTipGenerator;
import org.jfree.data.xy.XYDataset;
import org.jfree.data.xy.XYZDataset;
import org.pentaho.reporting.engine.classic.core.StaticDataRow;
import org.pentaho.reporting.engine.classic.core.function.ExpressionRuntime;
import org.pentaho.reporting.engine.classic.core.function.FormulaExpression;
import org.pentaho.reporting.engine.classic.core.function.GenericExpressionRuntime;
import org.pentaho.reporting.engine.classic.core.function.WrapperExpressionRuntime;
import org.pentaho.reporting.engine.classic.core.util.IntegerCache;

public class FormulaXYZTooltipGenerator implements XYZToolTipGenerator {
  private FormulaExpression formulaExpression;
  private ExpressionRuntime runtime;
  private static final String[] ADDITIONAL_COLUMN_KEYS = new String[] {
    "chart::x-value", "chart::y-value", "chart::z-value",
    "chart::series-index", "chart::series-key", "chart::series-count",
    "chart::item-index", "chart::item-count"
  };

  public FormulaXYZTooltipGenerator( final ExpressionRuntime runtime,
                                     final String formula ) {
    this.runtime = new GenericExpressionRuntime( runtime );
    this.formulaExpression = new FormulaExpression();
    this.formulaExpression.setFormula( formula );
  }

  /**
   * Generates the tooltip text for the specified item.
   *
   * @param dataset the dataset (<code>null</code> not permitted).
   * @param series  the series index (zero-based).
   * @param item    the item index (zero-based).
   * @return The tooltip text (possibly <code>null</code>).
   */
  public String generateToolTip( final XYDataset dataset, final int series, final int item ) {
    if ( dataset instanceof XYZDataset ) {
      return generateToolTip( (XYZDataset) dataset, series, item );
    }
    try {
      final Object[] values = new Object[] {
        dataset.getX( series, item ), dataset.getY( series, item ), null,
        IntegerCache.getInteger( series ), dataset.getSeriesKey( series ),
        IntegerCache.getInteger( dataset.getSeriesCount() ),
        IntegerCache.getInteger( item ), IntegerCache.getInteger( dataset.getItemCount( series ) )
      };
      formulaExpression.setRuntime( new WrapperExpressionRuntime
        ( new StaticDataRow( ADDITIONAL_COLUMN_KEYS, values ), runtime ) );
      final Object o = formulaExpression.getValue();
      if ( o == null ) {
        return null;
      }
      return String.valueOf( o );
    } finally {
      formulaExpression.setRuntime( null );
    }
  }

  /**
   * Generates a tool tip text item for a particular item within a series.
   *
   * @param dataset the dataset (<code>null</code> not permitted).
   * @param series  the series index (zero-based).
   * @param item    the item index (zero-based).
   * @return The tooltip text (possibly <code>null</code>).
   */
  public String generateToolTip( final XYZDataset dataset, final int series, final int item ) {
    try {
      final Object[] values = new Object[] {
        dataset.getX( series, item ), dataset.getY( series, item ), dataset.getZ( series, item ),
        IntegerCache.getInteger( series ), dataset.getSeriesKey( series ),
        IntegerCache.getInteger( dataset.getSeriesCount() ),
        IntegerCache.getInteger( item ), IntegerCache.getInteger( dataset.getItemCount( series ) )
      };
      formulaExpression.setRuntime( new WrapperExpressionRuntime
        ( new StaticDataRow( ADDITIONAL_COLUMN_KEYS, values ), runtime ) );
      final Object o = formulaExpression.getValue();
      if ( o == null ) {
        return null;
      }
      return String.valueOf( o );
    } finally {
      formulaExpression.setRuntime( null );
    }
  }


}