Java Doc for TotalGroupSumFunction.java in » Report » pentaho-report » org » jfree » report » function » 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.function

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.jfree.report.function .AbstractExpression

org.jfree.report.function .AbstractFunction

org.jfree.report.function .TotalGroupSumFunction

TotalGroupSumFunction

public class TotalGroupSumFunction extends AbstractFunction (Code)

A report function that calculates the sum of one field (column) from the Data-Row. This function produces a global total. The total sum of the group is known when the group processing starts and the report is not performing a prepare-run. The sum is calculated in the prepare run and recalled in the printing run.

The function can be used in two ways:

to calculate a sum for the entire report;
to calculate a sum within a particular group;

This function expects its input values to be either java.lang.Number instances or Strings that can be parsed to java.lang.Number instances using a java.text.DecimalFormat.

The function undestands two parameters, the field parameter is required and denotes the name of an ItemBand-field which gets summed up.

The parameter group denotes the name of a group. When this group is started, the counter gets reseted to null. This parameter is optional.
author:
Thomas Morgner

Constructor Summary
public	TotalGroupSumFunction() Constructs a new function.

Method Summary
public String	getField() Returns the field used by the function.
public String	getGroup() Returns the name of the group to be totalled.
public Expression	getInstance() Return a completly separated copy of this function.
public Object	getValue() Return the current function value.
public void	groupStarted(ReportEvent event) Receives notification that a group has started.
public void	itemsAdvanced(ReportEvent event) Receives notification that a row of data is being processed.
public void	reportInitialized(ReportEvent event) Receives notification that the report has started.
public void	setField(String field) Sets the field name for the function.
public void	setGroup(String group) Defines the name of the group to be totalled.

Constructor Detail

TotalGroupSumFunction
public TotalGroupSumFunction()(Code)
	Constructs a new function. Initially the function has no name...be sure to assign one before using the function.

Method Detail

getField
public String getField()(Code)
	Returns the field used by the function. The field name corresponds to a column name in the report's data-row. The field name.

getGroup
public String getGroup()(Code)
	Returns the name of the group to be totalled. the group name.

getInstance
public Expression getInstance()(Code)
	Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function. a copy of this function.

getValue
public Object getValue()(Code)
	Return the current function value. The value depends (obviously) on the function implementation. For example, a page counting function will return the current page number. The value of the function.

groupStarted
public void groupStarted(ReportEvent event)(Code)
	Receives notification that a group has started. Parameters: event - the event.

itemsAdvanced
public void itemsAdvanced(ReportEvent event)(Code)
	Receives notification that a row of data is being processed. Parameters: event - the event.

reportInitialized
public void reportInitialized(ReportEvent event)(Code)
	Receives notification that the report has started. Parameters: event - the event.

setField
public void setField(String field)(Code)
	Sets the field name for the function. The field name corresponds to a column name in the report's data-row. Parameters: field - the field name.

setGroup
public void setGroup(String group)(Code)
	Defines the name of the group to be totalled. If the name is null, all groups are totalled. Parameters: group - the group name.

Methods inherited from org.jfree.report.function.AbstractFunction

public void groupFinished(ReportEvent event)(Code)(Java Doc)
public void groupStarted(ReportEvent event)(Code)(Java Doc)
public void itemsAdvanced(ReportEvent event)(Code)(Java Doc)
public void itemsFinished(ReportEvent event)(Code)(Java Doc)
public void itemsStarted(ReportEvent event)(Code)(Java Doc)
public void reportDone(ReportEvent event)(Code)(Java Doc)
public void reportFinished(ReportEvent event)(Code)(Java Doc)
public void reportInitialized(ReportEvent event)(Code)(Java Doc)
public void reportStarted(ReportEvent event)(Code)(Java Doc)

Methods inherited from org.jfree.report.function.AbstractExpression

public Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public DataRow getDataRow()(Code)(Java Doc)
public int getDependencyLevel()(Code)(Java Doc)
public Expression getInstance()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public Configuration getReportConfiguration()(Code)(Java Doc)
public ResourceBundleFactory getResourceBundleFactory()(Code)(Java Doc)
public ExpressionRuntime getRuntime()(Code)(Java Doc)
final public boolean isActive()(Code)(Java Doc)
public boolean isDeepTraversing()(Code)(Java Doc)
public boolean isPreserve()(Code)(Java Doc)
final public void setActive(boolean active)(Code)(Java Doc)
public void setDependencyLevel(int level)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setPreserve(boolean preserve)(Code)(Java Doc)
public void setRuntime(ExpressionRuntime runtime)(Code)(Java Doc)

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.