jfreereport.java

Java的Web报表库

/**
 * ========================================
 * JFreeReport : a free Java report library
 * ========================================
 *
 * Project Info:  http://www.jfree.org/jfreereport/index.html
 * Project Lead:  Thomas Morgner;
 *
 * (C) Copyright 2000-2003, by Simba Management Limited and Contributors.
 *
 * 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.
 *
 * ----------------
 * JFreeReport.java
 * ----------------
 * (C)opyright 2000-2003, by Simba Management Limited and Contributors.
 *
 * Original Author:  David Gilbert (for Simba Management Limited);
 * Contributor(s):   Thomas Morgner;
 *
 * $Id: JFreeReport.java,v 1.60.2.1 2003/08/24 14:18:00 taqua Exp $
 *
 * Changes (from 8-Feb-2002)
 * -------------------------
 * 08-Feb-2002 : Updated code to work with latest version of the JCommon class library (DG);
 * 04-Mar-2002 : Major changes to report engine to incorporate functions and different output
 *               targets (DG);
 * 24-Apr-2002 : ItemBand and Groups are Optional Elements, default Elements are created as needed
 * 01-May-2002 : Renamed addProperty to setProperty to create consistent naming among other
 *               property uses.
 * 07-May-2002 : Fixed bug where last row of data is left off the report if it is alone in a
 *               group, reported by Steven Feinstein (DG);
 * 10-May-2002 : Rewrote report-processing. All reportstate-changes are handled by ReportState
 *               Objects. Created AccessorMethods for Properties. (TM)
 * 11-May-2002 : All bands have to be initialized. Null is no longer allowed for pageHeader,
 *               pageFooter, reportHeader, reportFooter, itemBand, functionCollection.
 * 17-May-2002 : Fixed reportPropertyInitialisation and checked if the report is proceeding on
 *               print.
 * 26-May-2002 : Changed repagination behaviour. Reports are repaginated before printed, so that
 *               global initialisations can be done.
 * 05-Jun-2002 : Updated Javadoc comments (DG);
 * 08-Jun-2002 : The defaultPageFormat is now always filled (and used in PreviewFrame)
 * 19-Jun-2002 : more documentation
 * 03-Jul-2002 : Serializable and cloneable, Removed JFreeReportInfo field, it disrupts the
 *               serializable process
 * 26-Jul-2002 : Removed method "isLastItemInHigherGroups()". The same functionality is implemented
 *               in Group.isLastItemInGroup()
 * 05-Dec-2002 : Updated Javadocs (DG);
 * 03-Jan-2003 : More Javadocs (DG);
 * 05-Feb-2003 : Fixed serialisation problem
 */

package com.jrefinery.report;

import java.awt.print.PageFormat;
import java.awt.print.PrinterJob;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.util.Collection;
import java.util.Iterator;
import javax.swing.table.DefaultTableModel;
import javax.swing.table.TableModel;

import com.jrefinery.report.function.Expression;
import com.jrefinery.report.function.ExpressionCollection;
import com.jrefinery.report.function.Function;
import com.jrefinery.report.function.FunctionInitializeException;
import com.jrefinery.report.targets.style.StyleSheetCollection;
import com.jrefinery.report.util.ReportConfiguration;
import com.jrefinery.report.util.ReportProperties;
import com.jrefinery.report.util.SerializerHelper;

/**
 * This class co-ordinates the process of generating a report from a <code>TableModel</code>.
 * The report is made up of 'bands', which are used repeatedly as necessary to generate small
 * sections of the report.
 * <p>
 * Accessing the bands and the elements:
 * <p>
 * The different bands can be accessed using the main report definition (this class):
 * <ul>
 * <li>the report header and footer can be reached by using
 *     <code>getReportHeader()</code> and <code>getReportFooter()</code>
 * <li>the page header and page footer can be reached by using
 *     <code>getPageHeader()</code> and <code>getPageFooter()</code>
 * <li>the item band is reachable with <code>getItemBand()</code>
 * </ul>
 *
 * Groups can be queried using <code>getGroup(int groupLevel)</code>.  The group header and
 * footer are accessible through the group object, so use
 * <code>getGroup(int groupLevel).getGroupHeader()<code> and
 * <code>getGroup(int groupLevel).getGroupFooter()<code>.
 * <p>
 * Elements on a band can be reached by using <code>Band.getElement (String elementName)</code>
 * or by retrieving all elements using <code>Band.getElements()</code> and performing a search on
 * the returned list.
 * <p>
 * All report elements share the same stylesheet collection. Report elements
 * cannot be shared between two different report instances.
 *
 * @author David Gilbert
 * @author Thomas Morgner
 */
public class JFreeReport implements JFreeReportConstants, Cloneable, Serializable
{
  /** Information about the JFreeReport class library. */
  private static JFreeReportInfo info;

  /** The table model containing the data for the report. */
  private TableModel data;

  /** The page format for the report (determines the page size, and therefore the report width). */
  private transient PageFormat defaultPageFormat;

  /** Storage for arbitrary properties that a user can assign to the report. */
  private ReportProperties properties;

  /** Storage for the functions in the report. */
  private ExpressionCollection functions;

  /** Storage for the expressions in the report. */
  private ExpressionCollection expressions;

  /** An ordered list of report groups (each group defines its own header and footer). */
  private GroupList groups;

  /** The report header band (if not null, printed once at the start of the report). */
  private ReportHeader reportHeader;

  /** The report footer band (if not null, printed once at the end of the report). */
  private ReportFooter reportFooter;

  /** The page header band (if not null, printed at the start of every page). */
  private PageHeader pageHeader;

  /** The page footer band (if not null, printed at the end of every page). */
  private PageFooter pageFooter;

  /** The item band - used once for each row of data. */
  private ItemBand itemBand;

  /** The report configuration. */
  private ReportConfiguration reportConfiguration;

  /** The stylesheet collection used for this report. */
  private StyleSheetCollection styleSheetCollection;

  /**
   * The default constructor. Creates an empty but fully initialized report.
   */
  public JFreeReport()
  {
    this.reportConfiguration = new ReportConfiguration(ReportConfiguration.getGlobalConfig());
    this.properties = new ReportProperties();
    this.styleSheetCollection = new StyleSheetCollection();

    this.groups = new GroupList();
    checkGroups();
    this.groups.registerStyleSheetCollection(this.styleSheetCollection);

    this.reportHeader = new ReportHeader();
    this.reportHeader.registerStyleSheetCollection(this.styleSheetCollection);
    this.reportFooter = new ReportFooter();
    this.reportFooter.registerStyleSheetCollection(this.styleSheetCollection);
    this.pageHeader = new PageHeader();
    this.pageHeader.registerStyleSheetCollection(this.styleSheetCollection);
    this.pageFooter = new PageFooter();
    this.pageFooter.registerStyleSheetCollection(this.styleSheetCollection);
    this.itemBand = new ItemBand();
    this.itemBand.registerStyleSheetCollection(this.styleSheetCollection);

    this.data = new DefaultTableModel();
    this.functions = new ExpressionCollection();
    this.expressions = new ExpressionCollection();
    setDefaultPageFormat(null);
  }

  /**
   * Constructs a report with the specified attributes.
   *
   * @param name  the name of the report.
   * @param reportHeader  the report header <i>not null</i>.
   * @param reportFooter  the report footer <i>not null</i>.
   * @param pageHeader  the page header <i>not null</i>.
   * @param pageFooter  the page footer <i>not null</i>.
   * @param itemBand  the item band <i>not null</i>.
   * @param groups  the report groups <i>not null</i>.
   * @param functions  the report functions.
   * @param data  the data for the report <i>not null</i>.
   * @param defaultPageFormat  the default page format.
   *
   * @throws NullPointerException if one of the <i>not null</i>-parameters is null.
   * @throws FunctionInitializeException if any of the functions cannot be initialized.
   */
  public JFreeReport(
      final String name,
      final ReportHeader reportHeader,
      final ReportFooter reportFooter,
      final PageHeader pageHeader,
      final PageFooter pageFooter,
      final ItemBand itemBand,
      final GroupList groups,
      final Collection functions,
      final TableModel data,
      final PageFormat defaultPageFormat)
      throws FunctionInitializeException
  {
    this();
    setName(name);
    setReportHeader(reportHeader);
    setReportFooter(reportFooter);
    setPageHeader(pageHeader);
    setPageFooter(pageFooter);
    setData(data);
    setDefaultPageFormat(defaultPageFormat);

    setItemBand(itemBand);
    setGroups(groups);

    // store the functions in a Map using the function name as the key.

    setFunctions(new ExpressionCollection(functions));
  }

  /**
   * Constructs a report with the specified attributes.
   *
   * @param name  the name of the report.
   * @param reportHeader  the report header <i>not null</i>.
   * @param reportFooter  the report footer <i>not null</i>.
   * @param pageHeader  the page header <i>not null</i>.
   * @param pageFooter  the page footer <i>not null</i>.
   * @param itemBand  the item band <i>not null</i>.
   * @param groups  the report groups <i>not null</i>.
   * @param functions  the report functions.
   * @param expressions  the report expressions.
   * @param data  the data for the report <i>not null</i>.
   * @param defaultPageFormat  the default page format.
   *
   * @throws NullPointerException if one of the <i>not null</i>-parameters is null.
   * @throws FunctionInitializeException if any of the functions cannot be initialized.
   * <!-- changed expressions to fit functions parameter -->
   */
  public JFreeReport(
      final String name,
      final ReportHeader reportHeader,
      final ReportFooter reportFooter,
      final PageHeader pageHeader,
      final PageFooter pageFooter,
      final ItemBand itemBand,
      final GroupList groups,
      final Collection functions,
      final TableModel data,
      final PageFormat defaultPageFormat,
      final Collection expressions)
      throws FunctionInitializeException
  {
    this(name, reportHeader, reportFooter, pageHeader, pageFooter, itemBand,
        groups, functions, data, defaultPageFormat);
    setExpressions(new ExpressionCollection(expressions));
  }

  /**
   * Returns the name of the report.
   * <p>
   * You can reference the report name in your XML report template file using the key
   * '<code>report.name</code>'.
   *
   * @return the name.
   */
  public String getName()
  {
    final Object name = getProperty(NAME_PROPERTY);
    return String.valueOf(name);
  }

  /**
   * Sets the name of the report.
   * <P>
   * The report name is stored as a property (key: <code>NAME_PROPERTY = "report.name"</code>) of
   * the report.  If you supply <code>null</code> as the name, the property is removed.
   *
   * @param name  the name of the report.
   */
  public void setName(final String name)
  {
    setProperty(NAME_PROPERTY, name);
  }

  /**
   * Adds a property to the report. If a property with the given name
   * already exists, the property will be updated with the new value. If the
   * supplied value is <code>null</code>, the property will be removed.
   * <P>
   * Developers are free to add any properties they want to a report, and then display those
   * properties in the report.  For example, you might add a 'user.name' property, so that you
   * can display the username in the header of a report.
   *
   * @param key  the key.
   * @param value  the value.
   */
  public void setProperty(final String key, final Object value)
  {
    this.properties.put(key, value);
  }

  /**
   * Returns the report properties collection for this report.
   * <p>
   * These properties are inherited to all ReportStates generated for this report.
   *
   * @return the report properties.
   */
  public ReportProperties getProperties()
  {
    return properties;
  }

  /**
   * Returns the value of the property with the specified key.
   *
   * @param key  the key.
   *
   * @return the property value.
   */
  public Object getProperty(final String key)
  {
    if (key == null)
    {
      throw new NullPointerException();
    }
    return this.properties.get(key);
  }

  /**
   * Returns the value of the property with the specified key.
   *
   * @param key  the key.
   *
   * @return the property value.
   */
  public boolean isPropertyMarked(final String key)
  {
    return this.properties.isMarked(key);
  }

  /**
   * Returns the value of the property with the specified key.
   *
   * @param key  the key.
   * @param mark the new marking flag
   */
  public void setPropertyMarked(final String key, final boolean mark)
  {
    this.properties.setMarked(key, mark);
  }

  /**
   * Sets the report header.
   *
   * @param header  the report header (<code>null</code> not permitted).
   */
  public void setReportHeader(final ReportHeader header)
  {
    if (header == null)
    {
      throw new NullPointerException("JFreeReport.setReportHeader(...) : null not permitted.");
    }

    this.reportHeader.unregisterStyleSheetCollection(getStyleSheetCollection());
    this.reportHeader = header;
    this.reportHeader.registerStyleSheetCollection(getStyleSheetCollection());
  }

  /**
   * Returns the report header.
   *
   * @return the report header (never <code>null</code>).
   */
  public ReportHeader getReportHeader()
  {
    return reportHeader;
  }

  /**
   * Sets the report footer.
   *
   * @param footer  the report footer (<code>null</code> not permitted).
   */
  public void setReportFooter(final ReportFooter footer)
  {
    if (footer == null)
    {
      throw new NullPointerException("JFreeReport.setReportFooter(...) : null not permitted.");
    }

    this.reportFooter.unregisterStyleSheetCollection(getStyleSheetCollection());
    this.reportFooter = footer;
    this.reportFooter.registerStyleSheetCollection(getStyleSheetCollection());
  }

  /**
   * Returns the page footer.