Package io.keikai.axyra.sheets

Enum Class ConsolidateFunction

java.lang.Object

java.lang.Enum<ConsolidateFunction>

io.keikai.axyra.sheets.ConsolidateFunction

All Implemented Interfaces:

Serializable, Comparable<ConsolidateFunction>, Constable

public enum ConsolidateFunction
extends Enum<ConsolidateFunction>

Aggregation function for Sheet.consolidate(int, int, io.keikai.axyra.sheets.ConsolidateFunction, io.keikai.axyra.sheets.Range...). Each constant applies the Excel function of the same name to the numeric values found at one position across all source ranges. Only numeric cells take part: text, booleans and blanks are skipped, except by COUNT_A.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVERAGE	AVERAGE: mean of the numbers at each position.
COUNT	COUNT: how many numbers are at each position.
COUNT_A	COUNTA: how many non-blank cells (numbers, text, booleans, errors) are at each position.
MAX	MAX: largest number at each position.
MIN	MIN: smallest number at each position.
PRODUCT	PRODUCT: product of the numbers at each position.
STDEV	STDEV: sample standard deviation.
STDEV_P	STDEVP: population standard deviation.
SUM	SUM: total of the numbers at each position.
VAR	VAR: sample variance.
VAR_P	VARP: population variance.

Method Summary

Modifier and Type	Method	Description
static ConsolidateFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConsolidateFunction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AVERAGE

public static final ConsolidateFunction AVERAGE

AVERAGE: mean of the numbers at each position.

COUNT

public static final ConsolidateFunction COUNT

COUNT: how many numbers are at each position.

COUNT_A

public static final ConsolidateFunction COUNT_A

COUNTA: how many non-blank cells (numbers, text, booleans, errors) are at each position.

MAX

public static final ConsolidateFunction MAX

MAX: largest number at each position.

MIN

public static final ConsolidateFunction MIN

MIN: smallest number at each position.

PRODUCT

public static final ConsolidateFunction PRODUCT

PRODUCT: product of the numbers at each position.

STDEV

public static final ConsolidateFunction STDEV

STDEV: sample standard deviation.

STDEV_P

public static final ConsolidateFunction STDEV_P

STDEVP: population standard deviation.

SUM

public static final ConsolidateFunction SUM

SUM: total of the numbers at each position.

VAR

public static final ConsolidateFunction VAR

VAR: sample variance.

VAR_P

public static final ConsolidateFunction VAR_P

VARP: population variance.

Method Details

values

public static ConsolidateFunction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ConsolidateFunction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null