Modifier and Type	Class and Description
public static enum	DStarRunner.DStarAlgorithmEnum Enum for convenience to identify and source implementations of the D* functions
private static enum	DStarRunner.operator

Modifier and Type	Field and Description
private final DStarRunner.DStarAlgorithmEnum	algoType

Access	Constructor and Description
public	DStarRunner(DStarRunner.DStarAlgorithmEnum to implement algorithm)

Method Summary

Modifier and Type	Method and Description
public ValueEval	evaluate(ValueEval[] the evaluated function arguments. Empty values are represented with `BlankEval` or `MissingArgEval`, never `null`. args, int row index of the cell containing the formula under evaluation srcRowIndex, int column index of the cell containing the formula under evaluation srcColumnIndex) Implements org.apache.poi.ss.formula.functions.Function.evaluate.
public ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval database, ValueEval filterColumn, ValueEval conditionDatabase) Implements org.apache.poi.ss.formula.functions.Function3Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`
private static boolean	Returns: Whether the row matches the conditions. fulfillsConditions(AreaEval Database. db, int The row in the database to check. row, AreaEval The condition database to use for checking. cdb) Checks a row in a database against a condition database.
private static int	Returns: Corresponding column number. getColumnForName(ValueEval Must not be a RefEval or AreaEval. Thus make sure resolveReference() is called on the value first! nameValueEval, AreaEval Database db)
private static int	Returns: Corresponding column number. getColumnForString(AreaEval Database. db, String Column heading. name) For a given database returns the column number for a column heading.
private static Double	getNumberFromValueEval(ValueEval value)
private static ValueEval	Returns: A ValueEval that is a NumberEval, StringEval, BoolEval, BlankEval or ErrorEval. resolveReference(AreaEval AreaEval from which the cell to resolve is retrieved. db, int Relative row in the AreaEval. dbRow, int Relative column in the AreaEval. dbCol) Resolve a ValueEval that's in an AreaEval.
private static boolean	Returns: Whether the condition holds. testNormalCondition(ValueEval The value to check. value, ValueEval The condition to check for. condition) Test a value against a simple (< > <= >= = starts-with) condition string.
private static boolean	Returns: whether the condition holds. testNumericCondition(ValueEval Value to check. valueEval, DStarRunner.operator Comparator to use. op, String Value to check against. condition) Test whether a value matches a numeric condition.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

algoType	back to summary
private final DStarRunner.DStarAlgorithmEnum algoType

Constructor Detail

DStarRunner	back to summary
public DStarRunner(DStarRunner.DStarAlgorithmEnum algorithm) Parameters algorithm:DStarRunner.DStarAlgorithmEnum to implement

Method Detail

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex) Implements org.apache.poi.ss.formula.functions.Function.evaluate. Parameters args:ValueEval[] Doc from org.apache.poi.ss.formula.functions.Function.evaluate. the evaluated function arguments. Empty values are represented with `BlankEval` or `MissingArgEval`, never `null`. srcRowIndex:int Doc from org.apache.poi.ss.formula.functions.Function.evaluate. row index of the cell containing the formula under evaluation srcColumnIndex:int Doc from org.apache.poi.ss.formula.functions.Function.evaluate. column index of the cell containing the formula under evaluation Returns:ValueEval Doc from org.apache.poi.ss.formula.functions.Function.evaluate. The evaluated result, possibly an `ErrorEval`, never `null` Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to `Double#NaN` be sure to translate the result to `ErrorEval#NUM_ERROR`.

public ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

Implements org.apache.poi.ss.formula.functions.Function.evaluate.

Parameters

args:ValueEval[]

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.

srcRowIndex:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

row index of the cell containing the formula under evaluation

srcColumnIndex:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

column index of the cell containing the formula under evaluation

Returns:ValueEval

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

The evaluated result, possibly an ErrorEval, never null

Note

- Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to Double#NaN be sure to translate the result to ErrorEval#NUM_ERROR.

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval database, ValueEval filterColumn, ValueEval conditionDatabase) Implements org.apache.poi.ss.formula.functions.Function3Arg.evaluate. Doc from org.apache.poi.ss.formula.functions.Function3Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`

public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval database, ValueEval filterColumn, ValueEval conditionDatabase)

Implements org.apache.poi.ss.formula.functions.Function3Arg.evaluate.

Doc from org.apache.poi.ss.formula.functions.Function3Arg.evaluate.

see Function#evaluate(ValueEval[], int, int)

fulfillsConditions	back to summary
private static boolean fulfillsConditions(AreaEval db, int row, AreaEval cdb) throws EvaluationException Checks a row in a database against a condition database. Parameters db:AreaEval Database. row:int The row in the database to check. cdb:AreaEval The condition database to use for checking. Returns:boolean Whether the row matches the conditions. Exceptions EvaluationException: If references could not be resolved or comparison operators and operands didn't match.

fulfillsConditions

back to summary

private static boolean fulfillsConditions(AreaEval db, int row, AreaEval cdb) throws EvaluationException

Checks a row in a database against a condition database.

Parameters

db:AreaEval: Database.
row:int: The row in the database to check.
cdb:AreaEval: The condition database to use for checking.

Returns:boolean

Whether the row matches the conditions.

Exceptions

EvaluationException:: If references could not be resolved or comparison operators and operands didn't match.

getColumnForName	back to summary
private static int getColumnForName(ValueEval nameValueEval, AreaEval db) throws EvaluationException Parameters nameValueEval:ValueEval Must not be a RefEval or AreaEval. Thus make sure resolveReference() is called on the value first! db:AreaEval Database Returns:int Corresponding column number. Exceptions EvaluationException: If it's not possible to turn all headings into strings.

getColumnForString	back to summary
private static int getColumnForString(AreaEval db, String name) For a given database returns the column number for a column heading. Comparison is case-insensitive. Parameters db:AreaEval Database. name:String Column heading. Returns:int Corresponding column number.

getColumnForString

back to summary

private static int getColumnForString(AreaEval db, String name)

For a given database returns the column number for a column heading. Comparison is case-insensitive.

Parameters

db:AreaEval: Database.
name:String: Column heading.

Returns:int

Corresponding column number.

getNumberFromValueEval	back to summary
private static Double getNumberFromValueEval(ValueEval value)

resolveReference	back to summary
private static ValueEval resolveReference(AreaEval db, int dbRow, int dbCol) Resolve a ValueEval that's in an AreaEval. Parameters db:AreaEval AreaEval from which the cell to resolve is retrieved. dbRow:int Relative row in the AreaEval. dbCol:int Relative column in the AreaEval. Returns:ValueEval A ValueEval that is a NumberEval, StringEval, BoolEval, BlankEval or ErrorEval.

resolveReference

back to summary

private static ValueEval resolveReference(AreaEval db, int dbRow, int dbCol)

Resolve a ValueEval that's in an AreaEval.

Parameters

db:AreaEval: AreaEval from which the cell to resolve is retrieved.
dbRow:int: Relative row in the AreaEval.
dbCol:int: Relative column in the AreaEval.

Returns:ValueEval

A ValueEval that is a NumberEval, StringEval, BoolEval, BlankEval or ErrorEval.

testNormalCondition	back to summary
private static boolean testNormalCondition(ValueEval value, ValueEval condition) throws EvaluationException Test a value against a simple (< > <= >= = starts-with) condition string. Parameters value:ValueEval The value to check. condition:ValueEval The condition to check for. Returns:boolean Whether the condition holds. Exceptions EvaluationException: If comparison operator and operands don't match.

testNormalCondition

back to summary

private static boolean testNormalCondition(ValueEval value, ValueEval condition) throws EvaluationException

Test a value against a simple (< > <= >= = starts-with) condition string.

Parameters

value:ValueEval: The value to check.
condition:ValueEval: The condition to check for.

Returns:boolean

Whether the condition holds.

Exceptions

EvaluationException:: If comparison operator and operands don't match.

testNumericCondition	back to summary
private static boolean testNumericCondition(ValueEval valueEval, DStarRunner.operator op, String condition) throws EvaluationException Test whether a value matches a numeric condition. Parameters valueEval:ValueEval Value to check. op:DStarRunner.operator Comparator to use. condition:String Value to check against. Returns:boolean whether the condition holds. Exceptions EvaluationException: If it's impossible to turn the condition into a number.

testNumericCondition

back to summary

private static boolean testNumericCondition(ValueEval valueEval, DStarRunner.operator op, String condition) throws EvaluationException

Test whether a value matches a numeric condition.

Parameters

valueEval:ValueEval: Value to check.
op:DStarRunner.operator: Comparator to use.
condition:String: Value to check against.

Returns:boolean

whether the condition holds.

Exceptions

EvaluationException:: If it's impossible to turn the condition into a number.

org.apache.poi.ss.formula.functions back to summary

public final Enum DStarRunner.DStarAlgorithmEnum

Class Inheritance

extends Enum<DStarRunner.DStarAlgorithmEnum>

java.lang.Object
java.lang.Enum
org.apache.poi.ss.formula.functions.DStarRunner.DStarAlgorithmEnum

Enum for convenience to identify and source implementations of the D* functions

Field Summary

Modifier and Type	Field and Description
public static final DStarRunner.DStarAlgorithmEnum	DAVERAGE
public static final DStarRunner.DStarAlgorithmEnum	DCOUNT
public static final DStarRunner.DStarAlgorithmEnum	DCOUNTA
public static final DStarRunner.DStarAlgorithmEnum	DGET
public static final DStarRunner.DStarAlgorithmEnum	DMAX
public static final DStarRunner.DStarAlgorithmEnum	DMIN
public static final DStarRunner.DStarAlgorithmEnum	DPRODUCT
public static final DStarRunner.DStarAlgorithmEnum	DSTDEV
public static final DStarRunner.DStarAlgorithmEnum	DSTDEVP
public static final DStarRunner.DStarAlgorithmEnum	DSUM
public static final DStarRunner.DStarAlgorithmEnum	DVAR
public static final DStarRunner.DStarAlgorithmEnum	DVARP
private final Supplier<IDStarAlgorithm>	implSupplier

Constructor Summary

Access	Constructor and Description
private	DStarAlgorithmEnum(Supplier<IDStarAlgorithm> implSupplier)

Method Summary

Modifier and Type	Method and Description
public IDStarAlgorithm	Returns: a new function implementation instance newInstance()
public static DStarRunner.DStarAlgorithmEnum	valueOf(String name)
public static DStarRunner.DStarAlgorithmEnum[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DAVERAGE	back to summary
public static final DStarRunner.DStarAlgorithmEnum DAVERAGE See Also `DAverage`

DCOUNT	back to summary
public static final DStarRunner.DStarAlgorithmEnum DCOUNT See Also `DCount`

DCOUNTA	back to summary
public static final DStarRunner.DStarAlgorithmEnum DCOUNTA See Also `DCountA`

DGET	back to summary
public static final DStarRunner.DStarAlgorithmEnum DGET See Also `DGet`

DMAX	back to summary
public static final DStarRunner.DStarAlgorithmEnum DMAX See Also `DMax`

DMIN	back to summary
public static final DStarRunner.DStarAlgorithmEnum DMIN See Also `DMin`

DPRODUCT	back to summary
public static final DStarRunner.DStarAlgorithmEnum DPRODUCT See Also `DProduct`

DSTDEV	back to summary
public static final DStarRunner.DStarAlgorithmEnum DSTDEV See Also `DStdev`

DSTDEVP	back to summary
public static final DStarRunner.DStarAlgorithmEnum DSTDEVP See Also `DStdevp`

DSUM	back to summary
public static final DStarRunner.DStarAlgorithmEnum DSUM See Also `DSum`

DVAR	back to summary
public static final DStarRunner.DStarAlgorithmEnum DVAR See Also `DVar`

DVARP	back to summary
public static final DStarRunner.DStarAlgorithmEnum DVARP See Also `DVarp`

implSupplier	back to summary
private final Supplier<IDStarAlgorithm> implSupplier

Constructor Detail

DStarAlgorithmEnum	back to summary
private DStarAlgorithmEnum(Supplier<IDStarAlgorithm> implSupplier)

Method Detail

newInstance	back to summary
public IDStarAlgorithm newInstance() Returns:IDStarAlgorithm a new function implementation instance

valueOf	back to summary
public static DStarRunner.DStarAlgorithmEnum valueOf(String name)

values	back to summary
public static DStarRunner.DStarAlgorithmEnum[] values()

org.apache.poi.ss.formula.functions back to summary

private final Enum DStarRunner.operator

Class Inheritance

extends Enum<DStarRunner.operator>

java.lang.Object
java.lang.Enum
org.apache.poi.ss.formula.functions.DStarRunner.operator

Field Summary

Modifier and Type	Field and Description
public static final DStarRunner.operator	equal
public static final DStarRunner.operator	largerEqualThan
public static final DStarRunner.operator	largerThan
public static final DStarRunner.operator	smallerEqualThan
public static final DStarRunner.operator	smallerThan

Constructor Summary

Access	Constructor and Description
private	operator()

Method Summary

Modifier and Type	Method and Description
public static DStarRunner.operator	valueOf(String name)
public static DStarRunner.operator[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

equal	back to summary
public static final DStarRunner.operator equal

largerEqualThan	back to summary
public static final DStarRunner.operator largerEqualThan

largerThan	back to summary
public static final DStarRunner.operator largerThan

smallerEqualThan	back to summary
public static final DStarRunner.operator smallerEqualThan

smallerThan	back to summary
public static final DStarRunner.operator smallerThan

Constructor Detail

operator	back to summary
private operator()

Method Detail

valueOf	back to summary
public static DStarRunner.operator valueOf(String name)

values	back to summary
public static DStarRunner.operator[] values()

public final Class DStarRunner

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DStarRunner.DStarAlgorithmEnum

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum DStarRunner.operator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail