Source for org.jfree.chart.plot.CombinedRangeCategoryPlot

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * ------------------------------
  28:  * CombinedRangeCategoryPlot.java
  29:  * ------------------------------
  30:  * (C) Copyright 2003-2006, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   Nicolas Brodu;
  34:  *
  35:  * $Id: CombinedRangeCategoryPlot.java,v 1.13.2.2 2006/09/13 10:32:36 mungady Exp $
  36:  *
  37:  * Changes:
  38:  * --------
  39:  * 16-May-2003 : Version 1 (DG);
  40:  * 08-Aug-2003 : Adjusted totalWeight in remove() method (DG);
  41:  * 19-Aug-2003 : Implemented Cloneable (DG);
  42:  * 11-Sep-2003 : Fix cloning support (subplots) (NB);
  43:  * 15-Sep-2003 : Implemented PublicCloneable.  Fixed errors in cloning and 
  44:  *               serialization (DG);
  45:  * 16-Sep-2003 : Changed ChartRenderingInfo --> PlotRenderingInfo (DG);
  46:  * 17-Sep-2003 : Updated handling of 'clicks' (DG);
  47:  * 04-May-2004 : Added getter/setter methods for 'gap' attributes (DG);
  48:  * 12-Nov-2004 : Implements the new Zoomable interface (DG);
  49:  * 25-Nov-2004 : Small update to clone() implementation (DG);
  50:  * 21-Feb-2005 : Fixed bug in remove() method (id = 1121172) (DG);
  51:  * 21-Feb-2005 : The getLegendItems() method now returns the fixed legend
  52:  *               items if set (DG);
  53:  * 05-May-2005 : Updated draw() method parameters (DG);
  54:  * 
  55:  */
  56:  
  57: package org.jfree.chart.plot;
  58: 
  59: import java.awt.Graphics2D;
  60: import java.awt.geom.Point2D;
  61: import java.awt.geom.Rectangle2D;
  62: import java.io.IOException;
  63: import java.io.ObjectInputStream;
  64: import java.io.Serializable;
  65: import java.util.Collections;
  66: import java.util.Iterator;
  67: import java.util.List;
  68: 
  69: import org.jfree.chart.LegendItemCollection;
  70: import org.jfree.chart.axis.AxisSpace;
  71: import org.jfree.chart.axis.AxisState;
  72: import org.jfree.chart.axis.NumberAxis;
  73: import org.jfree.chart.axis.ValueAxis;
  74: import org.jfree.chart.event.PlotChangeEvent;
  75: import org.jfree.chart.event.PlotChangeListener;
  76: import org.jfree.data.Range;
  77: import org.jfree.ui.RectangleEdge;
  78: import org.jfree.ui.RectangleInsets;
  79: import org.jfree.util.ObjectUtilities;
  80: import org.jfree.util.PublicCloneable;
  81: 
  82: /**
  83:  * A combined category plot where the range axis is shared.
  84:  */
  85: public class CombinedRangeCategoryPlot extends CategoryPlot 
  86:                                        implements Zoomable,
  87:                                                   Cloneable, PublicCloneable, 
  88:                                                   Serializable,
  89:                                                   PlotChangeListener {
  90: 
  91:     /** For serialization. */
  92:     private static final long serialVersionUID = 7260210007554504515L;
  93:     
  94:     /** Storage for the subplot references. */
  95:     private List subplots;
  96: 
  97:     /** Total weight of all charts. */
  98:     private int totalWeight;
  99: 
 100:     /** The gap between subplots. */
 101:     private double gap;
 102: 
 103:     /** Temporary storage for the subplot areas. */
 104:     private transient Rectangle2D[] subplotArea;  // TODO: move to plot state
 105: 
 106:     /**
 107:      * Default constructor.
 108:      */
 109:     public CombinedRangeCategoryPlot() {
 110:         this(new NumberAxis());
 111:     }
 112:     
 113:     /**
 114:      * Creates a new plot.
 115:      *
 116:      * @param rangeAxis  the shared range axis.
 117:      */
 118:     public CombinedRangeCategoryPlot(ValueAxis rangeAxis) {
 119:         super(null, null, rangeAxis, null);
 120:         this.subplots = new java.util.ArrayList();
 121:         this.totalWeight = 0;
 122:         this.gap = 5.0;
 123:     }
 124: 
 125:     /**
 126:      * Returns the space between subplots.
 127:      *
 128:      * @return The gap (in Java2D units).
 129:      */
 130:     public double getGap() {
 131:         return this.gap;
 132:     }
 133: 
 134:     /**
 135:      * Sets the amount of space between subplots and sends a 
 136:      * {@link PlotChangeEvent} to all registered listeners.
 137:      *
 138:      * @param gap  the gap between subplots (in Java2D units).
 139:      */
 140:     public void setGap(double gap) {
 141:         this.gap = gap;
 142:         notifyListeners(new PlotChangeEvent(this));
 143:     }
 144: 
 145:     /**
 146:      * Adds a subplot (with a default 'weight' of 1) and sends a 
 147:      * {@link PlotChangeEvent} to all registered listeners.
 148:      * <br><br>
 149:      * You must ensure that the subplot has a non-null domain axis.  The range
 150:      * axis for the subplot will be set to <code>null</code>.  
 151:      *
 152:      * @param subplot  the subplot (<code>null</code> not permitted).
 153:      */
 154:     public void add(CategoryPlot subplot) {
 155:         // defer argument checking
 156:         add(subplot, 1);
 157:     }
 158: 
 159:     /**
 160:      * Adds a subplot and sends a {@link PlotChangeEvent} to all registered 
 161:      * listeners.
 162:      * <br><br>
 163:      * You must ensure that the subplot has a non-null domain axis.  The range
 164:      * axis for the subplot will be set to <code>null</code>.  
 165:      *
 166:      * @param subplot  the subplot (<code>null</code> not permitted).
 167:      * @param weight  the weight (must be >= 1).
 168:      */
 169:     public void add(CategoryPlot subplot, int weight) {
 170:         if (subplot == null) {
 171:             throw new IllegalArgumentException("Null 'subplot' argument.");
 172:         }
 173:         if (weight <= 0) {
 174:             throw new IllegalArgumentException("Require weight >= 1.");
 175:         }
 176:         // store the plot and its weight
 177:         subplot.setParent(this);
 178:         subplot.setWeight(weight);
 179:         subplot.setInsets(new RectangleInsets(0.0, 0.0, 0.0, 0.0));
 180:         subplot.setRangeAxis(null);
 181:         subplot.setOrientation(getOrientation());
 182:         subplot.addChangeListener(this);
 183:         this.subplots.add(subplot);
 184:         this.totalWeight += weight;
 185:         
 186:         // configure the range axis...
 187:         ValueAxis axis = getRangeAxis();
 188:         if (axis != null) {
 189:             axis.configure();
 190:         }
 191:         notifyListeners(new PlotChangeEvent(this));
 192:     }
 193: 
 194:     /**
 195:      * Removes a subplot from the combined chart.
 196:      *
 197:      * @param subplot  the subplot (<code>null</code> not permitted).
 198:      */
 199:     public void remove(CategoryPlot subplot) {
 200:         if (subplot == null) {
 201:             throw new IllegalArgumentException(" Null 'subplot' argument.");   
 202:         }
 203:         int position = -1;
 204:         int size = this.subplots.size();
 205:         int i = 0;
 206:         while (position == -1 && i < size) {
 207:             if (this.subplots.get(i) == subplot) {
 208:                 position = i;
 209:             }
 210:             i++;
 211:         }
 212:         if (position != -1) {
 213:             this.subplots.remove(position);
 214:             subplot.setParent(null);
 215:             subplot.removeChangeListener(this);
 216:             this.totalWeight -= subplot.getWeight();
 217:         
 218:             ValueAxis range = getRangeAxis();
 219:             if (range != null) {
 220:                 range.configure();
 221:             }
 222: 
 223:             ValueAxis range2 = getRangeAxis(1);
 224:             if (range2 != null) {
 225:                 range2.configure();
 226:             }
 227:             notifyListeners(new PlotChangeEvent(this));
 228:         }
 229:     }
 230: 
 231:     /**
 232:      * Returns the list of subplots.
 233:      *
 234:      * @return The list (unmodifiable).
 235:      */
 236:     public List getSubplots() {
 237:         return Collections.unmodifiableList(this.subplots);
 238:     }
 239: 
 240:     /**
 241:      * Calculates the space required for the axes.
 242:      * 
 243:      * @param g2  the graphics device.
 244:      * @param plotArea  the plot area.
 245:      * 
 246:      * @return The space required for the axes.
 247:      */
 248:     protected AxisSpace calculateAxisSpace(Graphics2D g2, 
 249:                                            Rectangle2D plotArea) {
 250:         
 251:         AxisSpace space = new AxisSpace();  
 252:         PlotOrientation orientation = getOrientation();
 253:         
 254:         // work out the space required by the domain axis...
 255:         AxisSpace fixed = getFixedRangeAxisSpace();
 256:         if (fixed != null) {
 257:             if (orientation == PlotOrientation.VERTICAL) {
 258:                 space.setLeft(fixed.getLeft());
 259:                 space.setRight(fixed.getRight());
 260:             }
 261:             else if (orientation == PlotOrientation.HORIZONTAL) {
 262:                 space.setTop(fixed.getTop());
 263:                 space.setBottom(fixed.getBottom());                
 264:             }
 265:         }
 266:         else {
 267:             ValueAxis valueAxis = getRangeAxis();
 268:             RectangleEdge valueEdge = Plot.resolveRangeAxisLocation(
 269:                     getRangeAxisLocation(), orientation);
 270:             if (valueAxis != null) {
 271:                 space = valueAxis.reserveSpace(g2, this, plotArea, valueEdge, 
 272:                         space);
 273:             }
 274:         }
 275:         
 276:         Rectangle2D adjustedPlotArea = space.shrink(plotArea, null);
 277:         // work out the maximum height or width of the non-shared axes...
 278:         int n = this.subplots.size();
 279: 
 280:         // calculate plotAreas of all sub-plots, maximum vertical/horizontal 
 281:         // axis width/height
 282:         this.subplotArea = new Rectangle2D[n];
 283:         double x = adjustedPlotArea.getX();
 284:         double y = adjustedPlotArea.getY();
 285:         double usableSize = 0.0;
 286:         if (orientation == PlotOrientation.VERTICAL) {
 287:             usableSize = adjustedPlotArea.getWidth() - this.gap * (n - 1);
 288:         }
 289:         else if (orientation == PlotOrientation.HORIZONTAL) {
 290:             usableSize = adjustedPlotArea.getHeight() - this.gap * (n - 1);
 291:         }
 292: 
 293:         for (int i = 0; i < n; i++) {
 294:             CategoryPlot plot = (CategoryPlot) this.subplots.get(i);
 295: 
 296:             // calculate sub-plot area
 297:             if (orientation == PlotOrientation.VERTICAL) {
 298:                 double w = usableSize * plot.getWeight() / this.totalWeight;
 299:                 this.subplotArea[i] = new Rectangle2D.Double(x, y, w, 
 300:                         adjustedPlotArea.getHeight());
 301:                 x = x + w + this.gap;
 302:             }
 303:             else if (orientation == PlotOrientation.HORIZONTAL) {
 304:                 double h = usableSize * plot.getWeight() / this.totalWeight;
 305:                 this.subplotArea[i] = new Rectangle2D.Double(x, y, 
 306:                         adjustedPlotArea.getWidth(), h);
 307:                 y = y + h + this.gap;
 308:             }
 309: 
 310:             AxisSpace subSpace = plot.calculateDomainAxisSpace(g2, 
 311:                     this.subplotArea[i], null);
 312:             space.ensureAtLeast(subSpace);
 313: 
 314:         }
 315: 
 316:         return space;
 317:     }
 318: 
 319:     /**
 320:      * Draws the plot on a Java 2D graphics device (such as the screen or a 
 321:      * printer).  Will perform all the placement calculations for each 
 322:      * sub-plots and then tell these to draw themselves.
 323:      *
 324:      * @param g2  the graphics device.
 325:      * @param area  the area within which the plot (including axis labels)
 326:      *              should be drawn.
 327:      * @param anchor  the anchor point (<code>null</code> permitted).
 328:      * @param parentState  the parent state.
 329:      * @param info  collects information about the drawing (<code>null</code> 
 330:      *              permitted).
 331:      */
 332:     public void draw(Graphics2D g2, Rectangle2D area, Point2D anchor,
 333:                      PlotState parentState,
 334:                      PlotRenderingInfo info) {
 335: 
 336:         // set up info collection...
 337:         if (info != null) {
 338:             info.setPlotArea(area);
 339:         }
 340: 
 341:         // adjust the drawing area for plot insets (if any)...
 342:         RectangleInsets insets = getInsets();
 343:         insets.trim(area);
 344: 
 345:         // calculate the data area...
 346:         AxisSpace space = calculateAxisSpace(g2, area);
 347:         Rectangle2D dataArea = space.shrink(area, null);
 348: 
 349:         // set the width and height of non-shared axis of all sub-plots
 350:         setFixedDomainAxisSpaceForSubplots(space);
 351: 
 352:         // draw the shared axis
 353:         ValueAxis axis = getRangeAxis();
 354:         RectangleEdge rangeEdge = getRangeAxisEdge();
 355:         double cursor = RectangleEdge.coordinate(dataArea, rangeEdge);
 356:         AxisState state = axis.draw(g2, cursor, area, dataArea, rangeEdge, 
 357:                 info);
 358:         if (parentState == null) {
 359:             parentState = new PlotState();
 360:         }
 361:         parentState.getSharedAxisStates().put(axis, state);
 362:         
 363:         // draw all the charts
 364:         for (int i = 0; i < this.subplots.size(); i++) {
 365:             CategoryPlot plot = (CategoryPlot) this.subplots.get(i);
 366:             PlotRenderingInfo subplotInfo = null;
 367:             if (info != null) {
 368:                 subplotInfo = new PlotRenderingInfo(info.getOwner());
 369:                 info.addSubplotInfo(subplotInfo);
 370:             }
 371:             plot.draw(g2, this.subplotArea[i], null, parentState, subplotInfo);
 372:         }
 373: 
 374:         if (info != null) {
 375:             info.setDataArea(dataArea);
 376:         }
 377: 
 378:     }
 379: 
 380:     /**
 381:      * Sets the orientation for the plot (and all the subplots).
 382:      * 
 383:      * @param orientation  the orientation.
 384:      */
 385:     public void setOrientation(PlotOrientation orientation) {
 386: 
 387:         super.setOrientation(orientation);
 388: 
 389:         Iterator iterator = this.subplots.iterator();
 390:         while (iterator.hasNext()) {
 391:             CategoryPlot plot = (CategoryPlot) iterator.next();
 392:             plot.setOrientation(orientation);
 393:         }
 394: 
 395:     }
 396:     
 397:     /**
 398:       * Returns the range for the axis.  This is the combined range of all the
 399:       * subplots.
 400:       *
 401:       * @param axis  the axis.
 402:       *
 403:       * @return The range.
 404:       */
 405:      public Range getDataRange(ValueAxis axis) {
 406: 
 407:          Range result = null;
 408:          if (this.subplots != null) {
 409:              Iterator iterator = this.subplots.iterator();
 410:              while (iterator.hasNext()) {
 411:                  CategoryPlot subplot = (CategoryPlot) iterator.next();
 412:                  result = Range.combine(result, subplot.getDataRange(axis));
 413:              }
 414:          }
 415:          return result;
 416: 
 417:      }
 418: 
 419:     /**
 420:      * Returns a collection of legend items for the plot.
 421:      *
 422:      * @return The legend items.
 423:      */
 424:     public LegendItemCollection getLegendItems() {
 425:         LegendItemCollection result = getFixedLegendItems();
 426:         if (result == null) {
 427:             result = new LegendItemCollection();
 428:             if (this.subplots != null) {
 429:                 Iterator iterator = this.subplots.iterator();
 430:                 while (iterator.hasNext()) {
 431:                     CategoryPlot plot = (CategoryPlot) iterator.next();
 432:                     LegendItemCollection more = plot.getLegendItems();
 433:                     result.addAll(more);
 434:                 }
 435:             }
 436:         }
 437:         return result;
 438:     }
 439:     
 440:     /**
 441:      * Sets the size (width or height, depending on the orientation of the 
 442:      * plot) for the domain axis of each subplot.
 443:      *
 444:      * @param space  the space.
 445:      */
 446:     protected void setFixedDomainAxisSpaceForSubplots(AxisSpace space) {
 447: 
 448:         Iterator iterator = this.subplots.iterator();
 449:         while (iterator.hasNext()) {
 450:             CategoryPlot plot = (CategoryPlot) iterator.next();
 451:             plot.setFixedDomainAxisSpace(space);
 452:         }
 453: 
 454:     }
 455: 
 456:     /**
 457:      * Handles a 'click' on the plot by updating the anchor value.
 458:      *
 459:      * @param x  x-coordinate of the click.
 460:      * @param y  y-coordinate of the click.
 461:      * @param info  information about the plot's dimensions.
 462:      *
 463:      */
 464:     public void handleClick(int x, int y, PlotRenderingInfo info) {
 465: 
 466:         Rectangle2D dataArea = info.getDataArea();
 467:         if (dataArea.contains(x, y)) {
 468:             for (int i = 0; i < this.subplots.size(); i++) {
 469:                 CategoryPlot subplot = (CategoryPlot) this.subplots.get(i);
 470:                 PlotRenderingInfo subplotInfo = info.getSubplotInfo(i);
 471:                 subplot.handleClick(x, y, subplotInfo);
 472:             }
 473:         }
 474: 
 475:     }
 476: 
 477:     /**
 478:      * Receives a {@link PlotChangeEvent} and responds by notifying all 
 479:      * listeners.
 480:      * 
 481:      * @param event  the event.
 482:      */
 483:     public void plotChanged(PlotChangeEvent event) {
 484:         notifyListeners(event);
 485:     }
 486: 
 487:     /** 
 488:      * Tests the plot for equality with an arbitrary object.
 489:      * 
 490:      * @param obj  the object (<code>null</code> permitted).
 491:      * 
 492:      * @return <code>true</code> or <code>false</code>.
 493:      */
 494:     public boolean equals(Object obj) {
 495:         if (obj == this) {
 496:             return true;
 497:         }
 498:         if (!(obj instanceof CombinedRangeCategoryPlot)) {
 499:             return false;
 500:         }
 501:         if (!super.equals(obj)) {
 502:             return false;
 503:         }
 504:         CombinedRangeCategoryPlot that = (CombinedRangeCategoryPlot) obj;
 505:         if (!ObjectUtilities.equal(this.subplots, that.subplots)) {
 506:             return false;
 507:         }
 508:         if (this.totalWeight != that.totalWeight) {
 509:             return false;
 510:         }
 511:         if (this.gap != that.gap) {
 512:             return false;
 513:         }
 514:         return true;       
 515:     }
 516: 
 517:     /**
 518:      * Returns a clone of the plot.
 519:      * 
 520:      * @return A clone.
 521:      * 
 522:      * @throws CloneNotSupportedException  this class will not throw this 
 523:      *         exception, but subclasses (if any) might.
 524:      */
 525:     public Object clone() throws CloneNotSupportedException {
 526:         CombinedRangeCategoryPlot result 
 527:             = (CombinedRangeCategoryPlot) super.clone(); 
 528:         result.subplots = (List) ObjectUtilities.deepClone(this.subplots);
 529:         for (Iterator it = result.subplots.iterator(); it.hasNext();) {
 530:             Plot child = (Plot) it.next();
 531:             child.setParent(result);
 532:         }
 533:         
 534:         // after setting up all the subplots, the shared range axis may need 
 535:         // reconfiguring
 536:         ValueAxis rangeAxis = result.getRangeAxis();
 537:         if (rangeAxis != null) {
 538:             rangeAxis.configure();
 539:         }
 540:         
 541:         return result;
 542:     }
 543: 
 544:     /**
 545:      * Provides serialization support.
 546:      *
 547:      * @param stream  the input stream.
 548:      *
 549:      * @throws IOException  if there is an I/O error.
 550:      * @throws ClassNotFoundException  if there is a classpath problem.
 551:      */
 552:     private void readObject(ObjectInputStream stream) 
 553:         throws IOException, ClassNotFoundException {
 554: 
 555:         stream.defaultReadObject();
 556:         
 557:         // the range axis is deserialized before the subplots, so its value 
 558:         // range is likely to be incorrect...
 559:         ValueAxis rangeAxis = getRangeAxis();
 560:         if (rangeAxis != null) {
 561:             rangeAxis.configure();
 562:         }
 563:         
 564:     }
 565: 
 566: }