Package org.pentaho.reporting.engine.classic.core.function

Class ConditionalItemSumFunction

java.lang.Object

org.pentaho.reporting.engine.classic.core.function.AbstractExpression

org.pentaho.reporting.engine.classic.core.function.AbstractFunction

org.pentaho.reporting.engine.classic.core.function.ItemSumFunction

org.pentaho.reporting.engine.classic.core.function.ConditionalItemSumFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, ReportListener, AggregationFunction, Expression, FieldAggregationFunction, Function

public class ConditionalItemSumFunction
extends ItemSumFunction

Deprecated.

Filter the values by using a plain formula.

A item sum function that only sums up the current value, if the value read from the conditionField is the same as the value from the conditionValue property.

Author:

Thomas Morgner

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pentaho.reporting.engine.classic.core.function.ItemSumFunction

ZERO

Constructor Summary

Constructors

Constructor	Description
ConditionalItemSumFunction()	Deprecated. Default Constructor.

Method Summary

Modifier and Type	Method	Description
String	getConditionField()	Deprecated. Returns the name of the data-row column from where to read the comparison value for the condition.
Object	getConditionValue()	Deprecated. Returns the static comparison value for the condition.
void	itemsAdvanced(ReportEvent event)	Deprecated. Receives notification that a row of data is being processed.
void	setConditionField(String conditionField)	Deprecated. Defines the name of the data-row column from where to read the comparison value for the condition.
void	setConditionValue(Object conditionValue)	Deprecated. Defines the static comparison value for the condition.

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.ItemSumFunction

clear, clone, getCrosstabFilterGroup, getField, getGroup, getInstance, getValue, groupStarted, reportInitialized, setCrosstabFilterGroup, setField, setGroup, summaryRowSelection

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction

groupFinished, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression

getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression

getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime

Methods inherited from interface org.pentaho.reporting.engine.classic.core.event.ReportListener

groupFinished, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted

Constructor Detail

ConditionalItemSumFunction

public ConditionalItemSumFunction()

Deprecated.

Default Constructor.

Method Detail

getConditionField

public String getConditionField()

Deprecated.

Returns the name of the data-row column from where to read the comparison value for the condition.

Returns:

a field name.

setConditionField

public void setConditionField(String conditionField)

Deprecated.

Defines the name of the data-row column from where to read the comparison value for the condition.

Parameters:

conditionField - a field name.

getConditionValue

public Object getConditionValue()

Deprecated.

Returns the static comparison value for the condition.

Returns:

the static value.

setConditionValue

public void setConditionValue(Object conditionValue)

Deprecated.

Defines the static comparison value for the condition.

Parameters:

conditionValue - the static value.

itemsAdvanced

public void itemsAdvanced(ReportEvent event)

Deprecated.

Receives notification that a row of data is being processed.

Specified by:

itemsAdvanced in interface ReportListener

Overrides:

itemsAdvanced in class ItemSumFunction

Parameters:

event - Information about the event.