Java Doc for PercentageExpression.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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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.PercentageExpression

All known Subclasses:   org.jfree.report.function.ItemColumnQuotientExpression,
PercentageExpression
public class PercentageExpression extends AbstractExpression (Code)
Computes the percentage for a column in relation to a base column.

The function undestands two parameters. The dividend parameter is required and denotes the name of an ItemBand-field which is used as dividend. The divisor parameter is required and denotes the name of an ItemBand-field which is uses as divisor.

If either the divident or the divisor are not numeric, the expression will return null.

The formula used is as follows:

 Percent := divident / divisor
 

If the flag useDifference is set, the difference between base and subject is used instead.

 Percent := (divisor - divident) / divisor
 

author:
   Heiko Evermann
author:
   Thomas Morgner



Constructor Summary
public  PercentageExpression()
     Constructs a new function.

Method Summary
public  StringgetDividend()
     Returns the field used as dividend by the function.
public  StringgetDivisor()
     Returns the field used as divisor by the function.
public  intgetRoundingMode()
     Returns the defined rounding mode.
public  intgetScale()
     Returns the scale for the divide-operation.
public  ObjectgetValue()
     Return the current function value.
public  booleanisUseDifference()
     Returns whether the difference between divident and divisor should be used as real divisor.
public  voidsetDividend(String dividend)
     Sets the field name to be used as dividend for the function.
public  voidsetDivisor(String divisor)
     Sets the field name to be used as divisor for the function.
public  voidsetRoundingMode(int roundingMode)
     Defines the rounding mode.
public  voidsetScale(int scale)
     Defines the scale for the divide-operation.
public  voidsetUseDifference(boolean useDifference)
     Defines whether the difference between divident and divisor should be used as real divisor.


Constructor Detail
PercentageExpression
public PercentageExpression()(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.




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 is calculated as the quotient of two columns: the dividend column and the divisor column. If the divisor is zero, the return value is "n/a"; The quotient




isUseDifference
public boolean isUseDifference()(Code)
Returns whether the difference between divident and divisor should be used as real divisor. true, if the difference is used, false if the divident is used directly.



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.




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.




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)



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.



setUseDifference
public void setUseDifference(boolean useDifference)(Code)
Defines whether the difference between divident and divisor should be used as real divisor.
Parameters:
  useDifference - true, if the difference is used, false if the divident is used directly.



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
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.