Java Doc for AbstractReportDefinition.java in » Report » pentaho-report » org » jfree » report » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Report » pentaho report » org.jfree.report

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.jfree.report .AbstractReportDefinition

All known Subclasses:   org.jfree.report .SubReport,
AbstractReportDefinition
abstract public class AbstractReportDefinition implements Serializable,ReportDefinition(Code)
The AbstractReportDefinition serves as base-implementation for both the SubReport and the global JFreeReport instance. There's no point to subclass this class any further.
ReportDefinitions define the query string to "default" by default, change this to reflect the accepted queries in your data-source.
author:
   Thomas Morgner

Constructor Summary
protected AbstractReportDefinition()
     Creates a new instance.

Method Summary
public void addExpression(Expression function)
     Adds a function to the report's collection of expressions.
public void addGroup(Group group)
     Adds a group to the report.
public Object clone()
     Clones the report.
public DataRow getDataRow()
     Returns the current datarow assigned to this report definition.
public ExpressionCollection getExpressions()
     Returns the expressions for the report.
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.
public Group getGroupByName(String name)
     Searches a group by its defined name.
public int getGroupCount()
     Returns the number of groups in this report.
public GroupList getGroups()
     Returns a clone of the list of groups for the report.
public ItemBand getItemBand()
     Returns the report's item band.
public NoDataBand getNoDataBand()
     Returns the report's watermark band.
public PageFooter getPageFooter()
     Returns the page footer.
public PageHeader getPageHeader()
     Returns the page header.
public ReportProperties getProperties()
     Returns the report properties collection for this report.
public Object getProperty(String key)
     Returns the value of the property with the specified key.
Parameters:
  key - the key.
public String getQuery()
     Returns a new query or query-name that is used when retrieving the data from the data-factory.
public ReportFooter getReportFooter()
     Returns the page footer.
public ReportHeader getReportHeader()
     Returns the report header.
public StyleSheetCollection getStyleSheetCollection()
     Returns the stylesheet collection of this report.
public Watermark getWatermark()
     Returns the report's watermark band.
public void setExpressions(ExpressionCollection expressions)
     Sets the expressions for the report.
public void setGroups(GroupList groupList)
     Sets the groups for this report.
public void setItemBand(ItemBand band)
     Sets the item band for the report.
public void setNoDataBand(NoDataBand band)
     Sets the watermark band for the report.
public void setPageFooter(PageFooter footer)
     Sets the page footer.
public void setPageHeader(PageHeader header)
     Sets the page header.
public void setProperty(String key, Object value)
     Adds a property to the report.
If a property with the given name already exists, the property will be updated with the new value.
public void setQuery(String query)
     Defines a new query or query-name that is used when retrieving the data from the data-factory.
public void setReportFooter(ReportFooter footer)
     Sets the report footer.
public void setReportHeader(ReportHeader header)
     Sets the report header.
public void setWatermark(Watermark band)
     Sets the watermark band for the report.

Constructor Detail
AbstractReportDefinition
protected AbstractReportDefinition()(Code)
Creates a new instance. This initializes all properties to their defaults - especially for subreports you have to set sensible values before you can use them later.

Method Detail
addExpression
public void addExpression(Expression function)(Code)
Adds a function to the report's collection of expressions.
Parameters:
  function - the function.

addGroup
public void addGroup(Group group)(Code)
Adds a group to the report.
Parameters:
  group - the group.

clone
public Object clone() throws CloneNotSupportedException(Code)
Clones the report. the clone.
throws:
  CloneNotSupportedException - this should never happen.

getDataRow
public DataRow getDataRow()(Code)
Returns the current datarow assigned to this report definition. JFreeReport objects do not hold a working DataRow, as the final contents of the data cannot be known, until the reporting has started. the default implementation for non-processed reports.

getExpressions
public ExpressionCollection getExpressions()(Code)
Returns the expressions for the report. the expressions.

getGroup
public Group getGroup(int count)(Code)
Returns the group at the specified index or null, if there is no such group.
Parameters:
  count - the group index. the requested group.
throws:
  IllegalArgumentException - if the count is negative.
throws:
  IndexOutOfBoundsException - if the count is greater than the number of defined groups.

getGroupByName
public Group getGroupByName(String name)(Code)
Searches a group by its defined name. This method returns null, if the group was not found.
Parameters:
  name - the name of the group. the group or null if not found.
See Also:   org.jfree.report.GroupList.getGroupByName

getGroupCount
public int getGroupCount()(Code)
Returns the number of groups in this report.
Every report has at least one group defined. the group count.

getGroups
public GroupList getGroups()(Code)
Returns a clone of the list of groups for the report. the group list.

getItemBand
public ItemBand getItemBand()(Code)
Returns the report's item band. the item band (never null).

getNoDataBand
public NoDataBand getNoDataBand()(Code)
Returns the report's watermark band. the watermark band (never null).

getPageFooter
public PageFooter getPageFooter()(Code)
Returns the page footer. the page footer (never null).

getPageHeader
public PageHeader getPageHeader()(Code)
Returns the page header. the page header (never null).

getProperties
public ReportProperties getProperties()(Code)
Returns the report properties collection for this report.
These properties are inherited to all ReportStates generated for this report. the report properties.

getProperty
public Object getProperty(String key)(Code)
Returns the value of the property with the specified key.
Parameters:
  key - the key. the property value.

getQuery
public String getQuery()(Code)
Returns a new query or query-name that is used when retrieving the data from the data-factory. the query-string.

getReportFooter
public ReportFooter getReportFooter()(Code)
Returns the page footer. the report footer (never null).

getReportHeader
public ReportHeader getReportHeader()(Code)
Returns the report header. the report header (never null).

getStyleSheetCollection
public StyleSheetCollection getStyleSheetCollection()(Code)
Returns the stylesheet collection of this report. The stylesheet collection is fixed for the report and all elements of the report. When a band or group is added to the report it will get registered with this stylesheet collection and cannot be used in an different report. the stylesheet collection of the report, never null.

getWatermark
public Watermark getWatermark()(Code)
Returns the report's watermark band. the watermark band (never null).

setExpressions
public void setExpressions(ExpressionCollection expressions)(Code)
Sets the expressions for the report.
Parameters:
  expressions - the expressions (null not permitted).

setGroups
public void setGroups(GroupList groupList)(Code)
Sets the groups for this report. If no list (null) or an empty list is given, an default group is created. This default group contains no elements and starts at the first record of the data and ends on the last record.
Parameters:
  groupList - the list of groups.

setItemBand
public void setItemBand(ItemBand band)(Code)
Sets the item band for the report.
Parameters:
  band - the new item band (null not permitted).

setNoDataBand
public void setNoDataBand(NoDataBand band)(Code)
Sets the watermark band for the report.
Parameters:
  band - the new watermark band (null not permitted).

setPageFooter
public void setPageFooter(PageFooter footer)(Code)
Sets the page footer.
Parameters:
  footer - the page footer (null not permitted).

setPageHeader
public void setPageHeader(PageHeader header)(Code)
Sets the page header.
Parameters:
  header - the page header (null not permitted).

setProperty
public void setProperty(String key, Object value)(Code)
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 null, the property will be removed.
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.
Parameters:
  key - the key.
Parameters:
  value - the value.

setQuery
public void setQuery(String query)(Code)
Defines a new query or query-name that is used when retrieving the data from the data-factory.
Parameters:
  query - the query-string.
See Also:   DataFactory.queryData(StringDataRow)

setReportFooter
public void setReportFooter(ReportFooter footer)(Code)
Sets the report footer.
Parameters:
  footer - the report footer (null not permitted).

setReportHeader
public void setReportHeader(ReportHeader header)(Code)
Sets the report header.
Parameters:
  header - the report header (null not permitted).

setWatermark
public void setWatermark(Watermark band)(Code)
Sets the watermark band for the report.
Parameters:
  band - the new watermark band (null not permitted).

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.