org.jfree.report.util
Class ReportProperties

java.lang.Object
  org.jfree.report.util.ReportProperties

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class ReportProperties

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable

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.

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.

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.

JFreeReport has defined properties to publish the current state of the report:

• JFreeReport.NAME_PROPERTY = "report.name"

  The name of the report as defined in JFreeReport.setName(). Changing this property in the ReportState will not affect the ReportDefinition object.

• REPORT_DATE_PROPERTY = "report.date"

  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.

• REPORT_PAGEFORMAT_PROPERTY = "report.pageformat"

  Contains the current PageFormat used for printing.

• REPORT_PAGECOUNT_PROPERTY = "report.pagecount"

  The number of pages for this report. This property is not available in the prepare run.

• REPORT_PREPARERUN_PROPERTY = "report.preparerun"

  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

  See Also:

  Serialized Form

  Constructor Summary

  ReportProperties()
  Default constructor.

  ReportProperties(ReportProperties props)
  Copy constructor.

  Method Summary

  void	clear() Removes all properties stored in this collection.
  java.lang.Object	clone() Clones the properties.
  boolean	containsKey(java.lang.String key) Checks whether the given key is stored in this collection of ReportProperties.
  boolean	containsMarkedProperties() Returns true, if there is at least one marked property.
  java.lang.Object	get(java.lang.String key) Retrieves the value stored for a key in this properties collection.
  java.lang.Object	get(java.lang.String key, java.lang.Object defaultValue) 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.
  boolean	isMarked(java.lang.String property) Returns true if the specified property is marked, and false otherwise.
  java.util.Iterator	keys() Returns all property keys as enumeration.
  void	put(java.lang.String key, java.lang.Object value) Adds a property to this properties collection.
  void	setMarked(java.lang.String property, boolean marked) Marks a property.

  Methods inherited from class java.lang.Object

  equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Constructor Detail

  ReportProperties

  public ReportProperties(ReportProperties props)

  Copy constructor.

  Parameters:

  props - an existing ReportProperties instance.

  ReportProperties

  public ReportProperties()

  Default constructor.

  Method Detail

  put

  public void put(java.lang.String key,
                  java.lang.Object value)

  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.

  Parameters:

  key - the property key.

  value - the property value.

  get

  public java.lang.Object get(java.lang.String key)

  Retrieves the value stored for a key in this properties collection.

  Parameters:

  key - the property key.

  Returns:

  The stored value, or null if the key does not exist in this collection.

  get

  public java.lang.Object get(java.lang.String key,
                              java.lang.Object defaultValue)

  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.

  Parameters:

  key - the property key.

  defaultValue - the default value to be returned when the key is not stored in this properties collection.

  Returns:

  The stored value, or the default value if the key does not exist in this collection.

  keys

  public java.util.Iterator keys()

  Returns all property keys as enumeration.

  Returns:

  an enumeration of the property keys.

  clear

  public void clear()

  Removes all properties stored in this collection.

  containsKey

  public boolean containsKey(java.lang.String key)

  Checks whether the given key is stored in this collection of ReportProperties.

  Parameters:

  key - the property key.

  Returns:

  true, if the given key is known.

  clone

  public java.lang.Object clone()
                         throws java.lang.CloneNotSupportedException

  Clones the properties.

  Returns:

  a copy of this ReportProperties object.

  Throws:

  java.lang.CloneNotSupportedException - this should never happen.

  setMarked

  public void setMarked(java.lang.String property,
                        boolean marked)

  Marks a property.

  Parameters:

  property - the property key.

  marked - boolean.

  isMarked

  public boolean isMarked(java.lang.String property)

  Returns true if the specified property is marked, and false otherwise.

  Parameters:

  property - the property key.

  Returns:

  true for marked properties, false otherwise.

  containsMarkedProperties

  public boolean containsMarkedProperties()

  Returns true, if there is at least one marked property.

  Returns:

  true, if there are some properties marked, false otherwise.