com.jrefinery.report
Class ReportDefinition

java.lang.Object
  extended bycom.jrefinery.report.ReportDefinition
All Implemented Interfaces:
java.lang.Cloneable

public class ReportDefinition
extends java.lang.Object
implements java.lang.Cloneable

A report definition. This the working copy of the JFreeReport object. This object is not serializable, as it is used internally.

Author:
Thomas Morgner.

Constructor Summary
ReportDefinition(JFreeReport report)
          Creates a report definition from a report object.
 
Method Summary
 java.lang.Object clone()
          Creates and returns a copy of this object.
 Group getGroup(int count)
          Returns the group at the specified index or null, if there is no such group.
 int getGroupCount()
          Returns the number of groups in this report.
 GroupList getGroups()
          Returns the list of groups for the report.
 ItemBand getItemBand()
          Returns the item band.
 PageFooter getPageFooter()
          Returns the page footer.
 PageHeader getPageHeader()
          Returns the page header.
 ReportProperties getProperties()
          Returns the report properties.
 ReportConfiguration getReportConfiguration()
          Returns the report configuration.
 ReportFooter getReportFooter()
          Returns the report footer.
 ReportHeader getReportHeader()
          Returns the report header.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportDefinition

public ReportDefinition(JFreeReport report)
                 throws java.lang.CloneNotSupportedException
Creates a report definition from a report object.

Parameters:
report - the report.
Throws:
java.lang.CloneNotSupportedException - if there is a problem cloning.
Method Detail

getGroups

public GroupList getGroups()
Returns the list of groups for the report.

Returns:
The list of groups.

getReportHeader

public ReportHeader getReportHeader()
Returns the report header.

Returns:
The report header.

getReportFooter

public ReportFooter getReportFooter()
Returns the report footer.

Returns:
The report footer.

getPageHeader

public PageHeader getPageHeader()
Returns the page header.

Returns:
The page header.

getPageFooter

public PageFooter getPageFooter()
Returns the page footer.

Returns:
The page footer.

getItemBand

public ItemBand getItemBand()
Returns the item band.

Returns:
The item band.

getProperties

public ReportProperties getProperties()
Returns the report properties.

Returns:
The report properties.

getReportConfiguration

public ReportConfiguration getReportConfiguration()
Returns the report configuration.

Returns:
The report configuration.

getGroupCount

public int getGroupCount()
Returns the number of groups in this report.

Every report has at least one group defined.

Returns:
the group count.

getGroup

public Group getGroup(int count)
Returns the group at the specified index or null, if there is no such group.

Parameters:
count - the group index.
Returns:
the requested group.
Throws:
java.lang.IllegalArgumentException - if the count is negative.
java.lang.IndexOutOfBoundsException - if the count is greater than the number of defined groups.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Creates and returns a copy of this object.

Returns:
a clone of this instance.
Throws:
java.lang.CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.
See Also:
Cloneable