Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv abstract static class	AggregateFunction.AggregateFunctionA
private static class	AggregateFunction.Geomean
private static class	AggregateFunction.LargeSmall
private static class	AggregateFunction.Percentile Returns the k-th percentile of values in a range.
private static class	AggregateFunction.Product
pack-priv static class	AggregateFunction.ValueCollector

Field Summary

Modifier and Type	Field and Description
public static final Function	AVEDEV
public static final Function	AVERAGE
public static final Function	AVERAGEA
public static final Function	DEVSQ
public static final Function	GEOMEAN
public static final Function	LARGE
public static final Function	MAX
public static final Function	MEDIAN
public static final Function	MIN
public static final Function	PERCENTILE
public static final Function	PRODUCT
public static final Function	SMALL
public static final Function	STDEV
public static final Function	STDEVA
public static final Function	STDEVP
public static final Function	STDEVPA
public static final Function	SUM
public static final Function	SUMSQ
public static final Function	VAR
public static final Function	VARA
public static final Function	VARP
public static final Function	VARPA

Access	Constructor and Description
protected	AggregateFunction()
protected	AggregateFunction(boolean isReferenceBoolCounted)

Method Summary

Modifier and Type	Method and Description
pack-priv static Function	Returns: wrapped instance. The actual math is delegated to the argument function. subtotalInstance(Function the function to wrap func, boolean countHiddenRows) Create an instance to use in the `Subtotal` function.

Inherited from org.apache.poi.ss.formula.functions.MultiOperandNumericFunction:: evaluate evaluate getMaxNumOperands getNumberArray isHiddenRowCounted isSubtotalCounted setBlankEvalPolicy setMissingArgPolicy treatStringsAsZero

Field Detail

AVEDEV	back to summary
public static final Function AVEDEV

AVERAGE	back to summary
public static final Function AVERAGE

AVERAGEA	back to summary
public static final Function AVERAGEA

DEVSQ	back to summary
public static final Function DEVSQ

GEOMEAN	back to summary
public static final Function GEOMEAN

LARGE	back to summary
public static final Function LARGE

MAX	back to summary
public static final Function MAX

MEDIAN	back to summary
public static final Function MEDIAN

MIN	back to summary
public static final Function MIN

PERCENTILE	back to summary
public static final Function PERCENTILE

PRODUCT	back to summary
public static final Function PRODUCT

SMALL	back to summary
public static final Function SMALL

STDEV	back to summary
public static final Function STDEV

STDEVA	back to summary
public static final Function STDEVA

STDEVP	back to summary
public static final Function STDEVP

STDEVPA	back to summary
public static final Function STDEVPA

SUM	back to summary
public static final Function SUM

SUMSQ	back to summary
public static final Function SUMSQ

VAR	back to summary
public static final Function VAR

VARA	back to summary
public static final Function VARA

VARP	back to summary
public static final Function VARP

VARPA	back to summary
public static final Function VARPA

AggregateFunction	back to summary
protected AggregateFunction()

AggregateFunction	back to summary
protected AggregateFunction(boolean isReferenceBoolCounted)

Method Detail

subtotalInstance back to summary

subtotalInstance	back to summary
pack-priv static Function subtotalInstance(Function func, boolean countHiddenRows) Create an instance to use in the `Subtotal` function. If there are other subtotals within argument refs (or nested subtotals), these nested subtotals are ignored to avoid double counting. Parameters func:Function the function to wrap Returns:Function wrapped instance. The actual math is delegated to the argument function.

pack-priv static Function subtotalInstance(Function func, boolean countHiddenRows)

Create an instance to use in the Subtotal function.

If there are other subtotals within argument refs (or nested subtotals), these nested subtotals are ignored to avoid double counting.

Parameters

func:Function: the function to wrap

Returns:Function

wrapped instance. The actual math is delegated to the argument function.

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

pack-priv abstract Class AggregateFunction.AggregateFunctionA

Class Inheritance

extends AggregateFunction

java.lang.Object
org.apache.poi.ss.formula.functions.MultiOperandNumericFunction
org.apache.poi.ss.formula.functions.AggregateFunction
org.apache.poi.ss.formula.functions.AggregateFunction.AggregateFunctionA

Field Summary

Inherited from org.apache.poi.ss.formula.functions.AggregateFunction:: AVEDEV AVERAGE AVERAGEA DEVSQ GEOMEAN LARGE MAX MEDIAN MIN PERCENTILE PRODUCT SMALL STDEV STDEVA STDEVP STDEVPA SUM SUMSQ VAR VARA VARP VARPA

Constructor Summary

Access	Constructor and Description
protected	AggregateFunctionA()

Method Summary

Modifier and Type	Method and Description
protected boolean	treatStringsAsZero() Overrides org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.treatStringsAsZero. Functions like AVERAGEA() differ from AVERAGE() in the way they handle non-numeric cells.

Inherited from org.apache.poi.ss.formula.functions.AggregateFunction:: subtotalInstance

Constructor Detail

AggregateFunctionA	back to summary
protected AggregateFunctionA()

Method Detail

treatStringsAsZero	back to summary
protected boolean treatStringsAsZero() Overrides org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.treatStringsAsZero. Doc from org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.treatStringsAsZero. Functions like AVERAGEA() differ from AVERAGE() in the way they handle non-numeric cells. AVERAGEA treats booleans as 1.0 (true) and 0.0 (false). String cells are treated as 0.0 (AVERAGE() ignores the cell altogether). Returns:boolean whether to parse non-numeric cells Annotations @Override

treatStringsAsZero

back to summary

protected boolean treatStringsAsZero()

Overrides org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.treatStringsAsZero.

Doc from org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.treatStringsAsZero.

Functions like AVERAGEA() differ from AVERAGE() in the way they handle non-numeric cells. AVERAGEA treats booleans as 1.0 (true) and 0.0 (false). String cells are treated as 0.0 (AVERAGE() ignores the cell altogether).

Returns:boolean

whether to parse non-numeric cells

Annotations

@Override

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

private Class AggregateFunction.Geomean

Class Inheritance

extends AggregateFunction

java.lang.Object
org.apache.poi.ss.formula.functions.MultiOperandNumericFunction
org.apache.poi.ss.formula.functions.AggregateFunction
org.apache.poi.ss.formula.functions.AggregateFunction.Geomean

Field Summary

Inherited from org.apache.poi.ss.formula.functions.AggregateFunction:: AVEDEV AVERAGE AVERAGEA DEVSQ GEOMEAN LARGE MAX MEDIAN MIN PERCENTILE PRODUCT SMALL STDEV STDEVA STDEVP STDEVPA SUM SUMSQ VAR VARA VARP VARPA

Constructor Summary

Access	Constructor and Description
pack-priv	Geomean()

Method Summary

Modifier and Type	Method and Description
protected double	evaluate(double[] values) Implements abstract org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.evaluate.

Inherited from org.apache.poi.ss.formula.functions.AggregateFunction:: subtotalInstance

Constructor Detail

Geomean	back to summary
pack-priv Geomean()

Method Detail

evaluate	back to summary
protected double evaluate(double[] values) throws EvaluationException Implements abstract org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.evaluate. Annotations @Override

evaluate

back to summary

protected double evaluate(double[] values) throws EvaluationException

Implements abstract org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.evaluate.

Annotations

@Override

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

private final Class AggregateFunction.LargeSmall

Class Inheritance

extends Fixed2ArgFunction

java.lang.Object
org.apache.poi.ss.formula.functions.Fixed2ArgFunction
org.apache.poi.ss.formula.functions.AggregateFunction.LargeSmall

Field Summary

Modifier and Type	Field and Description
private final boolean	_isLarge

Constructor Summary

Access	Constructor and Description
protected	LargeSmall(boolean isLarge)

Method Summary

Modifier and Type	Method and Description
public ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1) Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`

Inherited from org.apache.poi.ss.formula.functions.Fixed2ArgFunction:: evaluate

Field Detail

_isLarge	back to summary
private final boolean _isLarge

Constructor Detail

LargeSmall	back to summary
protected LargeSmall(boolean isLarge)

Method Detail

evaluate back to summary

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

public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1)

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

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

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

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

private final Class AggregateFunction.Percentile

Class Inheritance

extends Fixed2ArgFunction

java.lang.Object
org.apache.poi.ss.formula.functions.Fixed2ArgFunction
org.apache.poi.ss.formula.functions.AggregateFunction.Percentile

Returns the k-th percentile of values in a range. You can use this function to establish a threshold of acceptance. For example, you can decide to examine candidates who score above the 90th percentile. PERCENTILE(array,k) Array is the array or range of data that defines relative standing. K is the percentile value in the range 0..1, inclusive. Remarks

if array is empty or contains more than 8,191 data points, PERCENTILE returns the #NUM! error value.
If k is nonnumeric, PERCENTILE returns the #VALUE! error value.
If k is < 0 or if k > 1, PERCENTILE returns the #NUM! error value.
If k is not a multiple of 1/(n - 1), PERCENTILE interpolates to determine the value at the k-th percentile.

Constructor Summary

Access	Constructor and Description
protected	Percentile()

Method Summary

Modifier and Type	Method and Description
public ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1) Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`

Inherited from org.apache.poi.ss.formula.functions.Fixed2ArgFunction:: evaluate

Constructor Detail

Percentile	back to summary
protected Percentile()

Method Detail

evaluate back to summary

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

public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1)

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

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

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

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

private Class AggregateFunction.Product

Class Inheritance

extends AggregateFunction

java.lang.Object
org.apache.poi.ss.formula.functions.MultiOperandNumericFunction
org.apache.poi.ss.formula.functions.AggregateFunction
org.apache.poi.ss.formula.functions.AggregateFunction.Product

Field Summary

Inherited from org.apache.poi.ss.formula.functions.AggregateFunction:: AVEDEV AVERAGE AVERAGEA DEVSQ GEOMEAN LARGE MAX MEDIAN MIN PERCENTILE PRODUCT SMALL STDEV STDEVA STDEVP STDEVPA SUM SUMSQ VAR VARA VARP VARPA

Constructor Summary

Access	Constructor and Description
pack-priv	Product()

Method Summary

Modifier and Type	Method and Description
protected double	evaluate(double[] values) Implements abstract org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.evaluate.

Inherited from org.apache.poi.ss.formula.functions.AggregateFunction:: subtotalInstance

Constructor Detail

Product	back to summary
pack-priv Product()

Method Detail

evaluate

back to summary

protected double evaluate(double[] values) throws EvaluationException

Implements abstract org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.evaluate.

Annotations

@Override

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

pack-priv final Class AggregateFunction.ValueCollector

Class Inheritance

extends MultiOperandNumericFunction

java.lang.Object
org.apache.poi.ss.formula.functions.MultiOperandNumericFunction
org.apache.poi.ss.formula.functions.AggregateFunction.ValueCollector

Field Summary

Modifier and Type	Field and Description
private static final AggregateFunction.ValueCollector	instance

Constructor Summary

Access	Constructor and Description
public	ValueCollector()

Method Summary

Modifier and Type	Method and Description
public static double[]	collectValues(ValueEval... operands)
protected double	evaluate(double[] values) Implements abstract org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.evaluate.

Inherited from org.apache.poi.ss.formula.functions.MultiOperandNumericFunction:: evaluate getMaxNumOperands getNumberArray isHiddenRowCounted isSubtotalCounted setBlankEvalPolicy setMissingArgPolicy treatStringsAsZero

Field Detail

instance	back to summary
private static final AggregateFunction.ValueCollector instance

Constructor Detail

ValueCollector	back to summary
public ValueCollector()

Method Detail

collectValues	back to summary
public static double[] collectValues(ValueEval... operands) throws EvaluationException

evaluate	back to summary
protected double evaluate(double[] values) Implements abstract org.apache.poi.ss.formula.functions.MultiOperandNumericFunction.evaluate.

public abstract Class AggregateFunction

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv abstract Class AggregateFunction.AggregateFunctionA

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class AggregateFunction.Geomean

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class AggregateFunction.LargeSmall

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class AggregateFunction.Percentile

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class AggregateFunction.Product

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv final Class AggregateFunction.ValueCollector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail