reportproperties.java

swing编写的库存管理程序。毕业设计类

/**
 * ========================================
 * 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.
 *
 * ---------------------
 * ReportProperties.java
 * ---------------------
 * (C)opyright 2000-2003, by Simba Management Limited and Contributors.
 *
 * Original Author:  David Gilbert (for Simba Management Limited);
 * Contributor(s):   Thomas Morgner;
 *
 * $Id: ReportProperties.java,v 1.4 2003/08/25 14:29:34 taqua Exp $
 *
 * Changes
 * -------
 * 26-May-2002 : Created ReportProperties as a small scale hashtable with protected string keys.
 *               This implementation guarantees that all keys are strings.
 * 09-Jun-2002 : Documentation
 * 05-Dec-2002 : Updated Javadocs (DG);
 * 16-Jan-2003 : BugFix: Properties could not be marked when no value was set.
 */

package org.jfree.report.util;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Iterator;
import java.util.TreeSet;

/**
 * The report properties is a hashtable with string keys. ReportProperties are bound to
 * a report as a general purpose storage. ReportProperties bound to a JFreeReport object
 * are visible to all generated report-state chains. A ReportState will inherit all
 * ReportProperties bound to the JFreeReport-object when the ReportState.StartState object is
 * created.  Properties bound to the report definition after the report state is created are not
 * visible to the ReportState and its children.
 * <p>
 * ReportProperties bound to a ReportState are not visible to the report definition (the
 * JFreeReport object), but are visible to all ReportStates of that ReportState-chain.
 * So when you add a property at the end of a report run to a ReportState, the value of
 * this property will be visible to all ReportStates when the report is restarted at a certain
 * point.
 * <p>
 * ReportProperties can be seen as a stateless shared report internal storage area. All functions
 * have access to the properties by using the ReportState.getProperty() and
 * ReportState.setProperty() functions.
 * <p>
 * JFreeReport has defined properties to publish the current state of the report:
 * <ul>
 * <li><code>JFreeReport.NAME_PROPERTY = "report.name"</code><p>
 * The name of the report as defined in JFreeReport.setName(). Changing this property in the
 * ReportState will not affect the ReportDefinition object.
 * <li><code>REPORT_DATE_PROPERTY = "report.date"</code><p>
 * A java.lang.Date object containing the timestamp when this reportchain was created. This
 * denotes the moment of the pagination, and changes when the report is repaginated.
 * <li><code>REPORT_PAGEFORMAT_PROPERTY = "report.pageformat"</code><p>
 * Contains the current PageFormat used for printing.
 * <li><code>REPORT_PAGECOUNT_PROPERTY = "report.pagecount"</code><p>
 * The number of pages for this report. <b>This property is not available in the prepare run.</b>
 * <li><code>REPORT_PREPARERUN_PROPERTY = "report.preparerun"</code><p>
 * The prepare run is invoked on repagination. This run collects the restart states for every
 * page of the report. When printing or displaying selected pages of the report, these saved
 * states are used as restarting points for the report generation. The prepare-run is invoked only
 * once per PageFormat. Subsequent report printings are restarted on clones of the stored page
 * states.
 *
 * @author Thomas Morgner
 */
public class ReportProperties implements Serializable, Cloneable
{
  /** Storage for the properties. */
  private HashMap properties;

  /** Marked property names. */
  private TreeSet markedProperties;

  /**
   * Copy constructor.
   *
   * @param props  an existing ReportProperties instance.
   */
  public ReportProperties(final ReportProperties props)
  {
    this.properties = new HashMap(props.properties);
    this.markedProperties = new TreeSet();
  }

  /**
   * Default constructor.
   */
  public ReportProperties()
  {
    this.properties = new HashMap();
    this.markedProperties = new TreeSet();
    this.markedProperties = new TreeSet();
  }

  /**
   * Adds a property to this properties collection. If a property with the given name
   * exist, the property will be replaced with the new value. If the value is null, the
   * property will be removed.
   *
   * @param key  the property key.
   * @param value  the property value.
   */
  public void put(final String key, final Object value)
  {
    if (value == null)
    {
      this.properties.remove(key);
    }
    else
    {
      this.properties.put(key, value);
    }
  }

  /**
   * Retrieves the value stored for a key in this properties collection.
   *
   * @param key  the property key.
   *
   * @return The stored value, or <code>null</code> if the key does not exist in this collection.
   */
  public Object get(final String key)
  {
    return this.properties.get(key);
  }

  /**
   * Retrieves the value stored for a key in this properties collection, and returning
   * the default value if the key was not stored in this properties collection.
   *
   * @param key  the property key.
   * @param defaultValue  the default value to be returned when the key is not stored in this
   *                      properties collection.
   *
   * @return The stored value, or the default value if the key does not exist in this collection.
   */
  public Object get(final String key, final Object defaultValue)
  {
    final Object o = this.properties.get(key);
    if (o == null)
    {
      return defaultValue;
    }
    return o;
  }

  /**
   * Returns all property keys as enumeration.
   *
   * @return an enumeration of the property keys.
   */
  public Iterator keys()
  {
    final TreeSet list = new TreeSet();
    list.addAll(this.properties.keySet());
    list.addAll(this.markedProperties);
    return list.iterator();
  }

  /**
   * Removes all properties stored in this collection.
   */
  public void clear()
  {
    this.properties.clear();
  }

  /**
   * Checks whether the given key is stored in this collection of ReportProperties.
   *
   * @param key  the property key.
   *
   * @return true, if the given key is known.
   */
  public boolean containsKey(final String key)
  {
    return this.properties.containsKey(key);
  }

  /**
   * Clones the properties.
   *
   * @return a copy of this ReportProperties object.
   *
   * @throws CloneNotSupportedException this should never happen.
   */
  public Object clone() throws CloneNotSupportedException
  {
    final ReportProperties p = (ReportProperties) super.clone();
    p.properties = (HashMap) this.properties.clone();
    p.markedProperties = (TreeSet) this.markedProperties.clone();
    return p;
  }

  /**
   * Marks a property.
   *
   * @param property  the property key.
   * @param marked  boolean.
   */
  public void setMarked(final String property, final boolean marked)
  {
    if (marked)
    {
      this.markedProperties.add(property);
    }
    else
    {
      this.markedProperties.remove(property);
    }
  }

  /**
   * Returns true if the specified property is marked, and false otherwise.
   *
   * @param property  the property key.
   *
   * @return true for marked properties, false otherwise.
   */
  public boolean isMarked(final String property)
  {
    return this.markedProperties.contains(property);
  }

  /**
   * Returns true, if there is at least one marked property.
   *
   * @return true, if there are some properties marked, false otherwise.
   */
  public boolean containsMarkedProperties()
  {
    return markedProperties.isEmpty() == false;
  }
}