Java Doc for TotalGroupSumQuotientFunction.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 .TotalGroupSumQuotientFunction

All known Subclasses:   org.jfree.report.function .TotalGroupSumQuotientPercentFunction,
TotalGroupSumQuotientFunction
public class TotalGroupSumQuotientFunction extends AbstractFunction (Code)
A report function that calculates the quotient of two summed fields (columns) from the report's 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 quotient for the entire report;

to calculate a quotient 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 tree parameters. The dividend parameter is required and denotes the name of an ItemBand-field which gets summed up as dividend. The divisor parameter is required and denotes the name of an ItemBand-field which gets summed up as divisor.
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 TotalGroupSumQuotientFunction()
     Constructs a new function.

Method Summary
public String getDividend()
     Returns the field used as dividend by the function.
public String getDivisor()
     Returns the field used as divisor by the function.
public String getGroup()
     Returns the name of the group to be totalled.
public int getRoundingMode()
     Returns the defined rounding mode.
public int getScale()
     Returns the scale for the divide-operation.
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 setDependencyLevel(int level)
     Defines the function's dependency level.
public void setDividend(String dividend)
     Sets the field name to be used as dividend for the function.
public void setDivisor(String divisor)
     Sets the field name to be used as divisor for the function.
public void setGroup(String group)
     Defines the name of the group to be totalled.
public void setRoundingMode(int roundingMode)
     Defines the rounding mode.
public void setRuntime(ExpressionRuntime runtime)
     Defines the ExpressionRune used in this expression.
public void setScale(int scale)
     Defines the scale for the divide-operation.

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

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

getDivisor
public String getDivisor()(Code)
Returns the field used as divisor 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.

getRoundingMode
public int getRoundingMode()(Code)
Returns the defined rounding mode. This influences the precision of the divide-operation. the rounding mode.
See Also:   java.math.BigDecimal.divide(java.math.BigDecimalint)

getScale
public int getScale()(Code)
Returns the scale for the divide-operation. The scale influences the precision of the division. the scale.

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.

setDependencyLevel
public void setDependencyLevel(int level)(Code)
Defines the function's dependency level. This method forwards all calls to the interal functions.
Parameters:
  level - the dependency level.
See Also:   Expression.getDependencyLevel

setDividend
public void setDividend(String dividend)(Code)
Sets the field name to be used as dividend for the function.
The field name corresponds to a column name in the report's data-row.
Parameters:
  dividend - the field name (null not permitted).

setDivisor
public void setDivisor(String divisor)(Code)
Sets the field name to be used as divisor for the function.
The field name corresponds to a column name in the report's data-row.
Parameters:
  divisor - the field name (null not permitted).

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.

setRoundingMode
public void setRoundingMode(int roundingMode)(Code)
Defines the rounding mode. This influences the precision of the divide-operation.
Parameters:
  roundingMode - the rounding mode.
See Also:   java.math.BigDecimal.divide(java.math.BigDecimalint)

setRuntime
public void setRuntime(ExpressionRuntime runtime)(Code)
Defines the ExpressionRune used in this expression. The ExpressionRuntime is set before the expression receives events or gets evaluated and is unset afterwards. Do not hold references on the runtime or you will create memory-leaks.
Parameters:
  runtime - the runtime information for the expression

setScale
public void setScale(int scale)(Code)
Defines the scale for the divide-operation. The scale influences the precision of the division.
Parameters:
  scale - the scale.

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.