Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org » jfree » report » function » [javadoc | source]
org.jfree.report.function
public class: ColumnAverageExpression [javadoc | source]
java.lang.Object
   org.jfree.report.function.AbstractExpression
      org.jfree.report.function.ColumnAggregationExpression
         org.jfree.report.function.ColumnAverageExpression

All Implemented Interfaces:
    Expression, Serializable

Computes the horizontal average over all columns specified in the field-list. The average will be computed over all fields of the current data-row, it will not be computed for all rows in the group. For that use the org.jfree.report.function.ItemAvgFunction instead.

Non numeric and null-columns will be treated as zero for the task of summing up all members. Whether these fields are used counted as valid fields can be controlled with the 'onlyValidFields' flag.

Constructor:
 public ColumnAverageExpression() 
Method from org.jfree.report.function.ColumnAverageExpression Summary:
getRoundingMode,   getScale,   getValue,   isOnlyValidFields,   isReturnInfinity,   setOnlyValidFields,   setReturnInfinity,   setRoundingMode,   setScale
Methods from org.jfree.report.function.ColumnAggregationExpression:
getField,   getField,   getFieldCount,   getFieldValues,   getInstance,   setField,   setField
Methods from org.jfree.report.function.AbstractExpression:
clone,   getDataRow,   getDependencyLevel,   getInstance,   getName,   getReportConfiguration,   getResourceBundleFactory,   getRuntime,   isActive,   isDeepTraversing,   isPreserve,   setActive,   setDependencyLevel,   setName,   setPreserve,   setRuntime
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.report.function.ColumnAverageExpression Detail:
 public int getRoundingMode() 
    Returns the defined rounding mode. This influences the precision of the divide-operation.
 public int getScale() 
    Returns the scale for the divide-operation. The scale influences the precision of the division.
 public Object getValue() 
    Computes the horizontal average of all field in the field-list. The average will be computed over all fields of the current data-row, it will not be computed for all rows in the group. For that use the org.jfree.report.function.ItemAvgFunction instead.
 public boolean isOnlyValidFields() 
    Returns, whether non-numeric and null-values are ignored for the average-computation.
 public boolean isReturnInfinity() 
    Returns, whether the expression returns infinity if there are no valid fields. If set to false, this expression returns null instead.
 public  void setOnlyValidFields(boolean onlyValidFields) 
    Defines, whether non-numeric and null-values are ignored for the average-computation.
 public  void setReturnInfinity(boolean returnInfinity) 
    Defines, whether the expression returns infinity if there are no valid fields. If set to false, this expression returns null instead.
 public  void setRoundingMode(int roundingMode) 
    Defines the rounding mode. This influences the precision of the divide-operation.
 public  void setScale(int scale) 
    Defines the scale for the divide-operation. The scale influences the precision of the division.