Top Description Methods
org.apache.poi.ss.formula.functions

public Interface IDStarAlgorithm

Known Direct Implementers
org.apache.poi.ss.formula.functions.DAverage, org.apache.poi.ss.formula.functions.DCount, org.apache.poi.ss.formula.functions.DCountA, org.apache.poi.ss.formula.functions.DGet, org.apache.poi.ss.formula.functions.DMax, org.apache.poi.ss.formula.functions.DMin, org.apache.poi.ss.formula.functions.DProduct, org.apache.poi.ss.formula.functions.DStdev, org.apache.poi.ss.formula.functions.DStdevp, org.apache.poi.ss.formula.functions.DSum, org.apache.poi.ss.formula.functions.DVar, org.apache.poi.ss.formula.functions.DVarp
Imports
org.apache.poi.ss.formula.eval.ValueEval

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 TypeMethod and Description
public default boolean

Returns:

whether the field value can evaluate to empty
allowEmptyMatchField
()

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

public ValueEval

Returns:

a ValueEval
getResult
()

Return a result ValueEval that will be the result of the calculation.

public boolean

Returns:

Whether we should continue iterating through the database.
processMatch
(ValueEval
ValueEval of the cell in the matching row. References will already be resolved.
eval
)

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

Method Detail

allowEmptyMatchFieldback to summary
public 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:boolean

whether the field value can evaluate to empty

getResultback to summary
public 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:ValueEval

a ValueEval

processMatchback to summary
public boolean processMatch(ValueEval eval)

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

Parameters
eval:ValueEval

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

Returns:boolean

Whether we should continue iterating through the database.