org.apache.poi.ss.formula.functions

Interface IDStarAlgorithm

All Known Implementing Classes:

DAverage, DCount, DCountA, DGet, DMax, DMin, DProduct, DStdev, DStdevp, DSum, DVar, DVarp

public interface IDStarAlgorithm

Interface specifying how an algorithm to be used by DStarRunner should look like. Each implementing class should correspond to one of the D* functions.

Method Summary

Modifier and Type	Method and Description
default boolean	allowEmptyMatchField() Whether the field value (the 2nd param in DCOUNT, DGET, etc.) can evaluate to empty.
ValueEval	getResult() Return a result ValueEval that will be the result of the calculation.
boolean	processMatch(ValueEval eval) Process a match that is found during a run through a database.

Method Detail

processMatch

boolean processMatch(ValueEval eval)

Process a match that is found during a run through a database.

Parameters:

eval - ValueEval of the cell in the matching row. References will already be resolved.

Returns:

Whether we should continue iterating through the database.

getResult

ValueEval getResult()

Return a result ValueEval that will be the result of the calculation. This is always called at the end of a run through the database.

Returns:

a ValueEval

allowEmptyMatchField

default boolean allowEmptyMatchField()

Whether the field value (the 2nd param in DCOUNT, DGET, etc.) can evaluate to empty. It is allowed to evaluate to empty for DCOUNT.

Returns:

whether the field value can evaluate to empty