org.apache.poi.ss.formula.functions

Class AverageIf

java.lang.Object

org.apache.poi.ss.formula.functions.AverageIf

All Implemented Interfaces:

FreeRefFunction

public class AverageIf
extends Object

Handler for singular AverageIf which has different operand handling than the generic AverageIfs version.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	Baseifs.Aggregator Implements the details of a specific aggregation function

Field Summary

Fields

Modifier and Type	Field and Description
static FreeRefFunction	instance

Constructor Summary

Constructors

Constructor and Description
AverageIf()

Method Summary

Modifier and Type	Method and Description
protected ValueEval	aggregateMatchingCells(Baseifs.Aggregator aggregator, AreaEval sumRange, AreaEval testRange, CountUtils.I_MatchPredicate mp)
protected static AreaEval	convertRangeArg(ValueEval eval)
protected Baseifs.Aggregator	createAggregator()
ValueEval	evaluate(ValueEval[] args, OperationEvaluationContext ec)
protected boolean	hasInitialRange() Implementations must be stateless.

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static final FreeRefFunction instance

Constructor Detail

AverageIf

public AverageIf()

Method Detail

evaluate

public ValueEval evaluate(ValueEval[] args,
                          OperationEvaluationContext ec)

Specified by:

evaluate in interface FreeRefFunction

Parameters:

args - the pre-evaluated arguments for this function. args is never null, nor are any of its elements.

ec - primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.

Returns:

never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).

aggregateMatchingCells

protected ValueEval aggregateMatchingCells(Baseifs.Aggregator aggregator,
                                           AreaEval sumRange,
                                           AreaEval testRange,
                                           CountUtils.I_MatchPredicate mp)
                                    throws EvaluationException

Throws:

EvaluationException

hasInitialRange

protected boolean hasInitialRange()

Implementations must be stateless.

Returns:

true if there should be a range argument before the criteria pairs

createAggregator

protected Baseifs.Aggregator createAggregator()

convertRangeArg

protected static AreaEval convertRangeArg(ValueEval eval)
                                   throws EvaluationException

Throws:

EvaluationException