CategoryChart.java

/*
 * Class:        CategoryChart
 * Description:  
 * Environment:  Java
 * Software:     SSJ 
 * Copyright (C) 2001  Pierre L'Ecuyer and Universite de Montreal
 * Organization: DIRO, Universite de Montreal
 * @author       
 * @since
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package umontreal.ssj.charts;
 
import org.jfree.chart.JFreeChart;
import javax.swing.JFrame;

public abstract class CategoryChart {
 
   protected Axis YAxis;
   protected SSJCategorySeriesCollection dataset;
   protected JFreeChart chart;
   protected boolean latexDocFlag = true;
 
   protected boolean autoRange;
   protected double[] manualRange;
 
   protected boolean grid = false;
   protected double ystepGrid;
 
   final protected double BOR = 0.1;

   public JFreeChart getJFreeChart() {
      return chart;
   }

   public Axis getYAxis() {
      return YAxis;
   }

   public abstract JFrame view(int width, int height);

   public String getTitle() {
      return chart.getTitle().getText();
   }

   public void setTitle(String title) {
      chart.setTitle(title);
   }

   public void setAutoRange() {
      autoRange = true;
 
      double BorneMin = Math.abs((dataset.getRangeBounds())[0]);
      double BorneMax = Math.abs((dataset.getRangeBounds())[1]);
 
      double max = Math.max(BorneMin, BorneMax) * BOR;
      YAxis.getAxis().setLowerBound(BorneMin - max);
      YAxis.getAxis().setUpperBound(BorneMax + max);
      YAxis.setLabelsAuto();
   }

   private void setManualRange(double[] range) {
      if (range.length != 2)
         throw new IllegalArgumentException("range must have the format: [ymin, ymax]");
      autoRange = false;
      YAxis.getAxis().setLowerBound(Math.min(range[0], range[1]));
      YAxis.getAxis().setUpperBound(Math.max(range[0], range[1]));
   }

   public void enableGrid(double xstep, double ystep) {
      this.grid = true;
      this.ystepGrid = ystep;
   }

   public void disableGrid() {
      this.grid = false;
   }


   public abstract String toLatex(double width, double height);

   public void setLatexDocFlag(boolean flag) {
      latexDocFlag = flag;
   }
 
   protected double computeYScale(double position) {
      double[] bounds = new double[2];
      bounds[0] = YAxis.getAxis().getLowerBound();
      bounds[1] = YAxis.getAxis().getUpperBound();
 
      if (position < bounds[0])
         bounds[0] = position;
      if (position > bounds[1])
         bounds[1] = position;
      bounds[0] -= position;
      bounds[1] -= position;
      return computeScale(bounds);
   }
 
   protected double computeScale(double[] bounds) {
      int tenPowerRatio = 0;
      // echelle < 1 si les valeurs sont grandes
      while (bounds[1] > 1000 || bounds[0] < -1000) {
         bounds[1] /= 10;
         bounds[0] /= 10;
         tenPowerRatio++;
      }
      // echelle > 1 si les valeurs sont petites
      while (bounds[1] < 100 && bounds[0] > -100) {
         bounds[1] *= 10;
         bounds[0] *= 10;
         tenPowerRatio--;
      }
      return 1 / Math.pow(10, tenPowerRatio);
   }
}