Package com.grapecity.documents.excel

Enum Class ConsolidationFunction

java.lang.Object

java.lang.Enum<ConsolidationFunction>

com.grapecity.documents.excel.ConsolidationFunction

All Implemented Interfaces:

Serializable, Comparable<ConsolidationFunction>, Constable

public enum ConsolidationFunction
extends Enum<ConsolidationFunction>

Specifies the subtotal function.

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	Specifies the average.
Count	Specifies the count.
CountNums	Specifies to count numerical values only.
DistinctCount	Specifies to count using distinct count analysis.
Max	Specifies the maximum.
Min	Specifies the minimum.
Product	Specifies to multiply.
StdDev	Specifies the standard deviation, based on a sample.
StdDevp	Specifies the standard deviation, based on the entire population.
Sum	Specifies the sum.
Unknown	Specifies that no subtotal function is specified.
Var	Specifies the variation, based on a sample.
Varp	Specifies the variation, based on the entire population.

Method Summary

Modifier and Type	Method	Description
static ConsolidationFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConsolidationFunction[]	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

Sum

public static final ConsolidationFunction Sum

Specifies the sum.

Varp

public static final ConsolidationFunction Varp

Specifies the variation, based on the entire population.

Var

public static final ConsolidationFunction Var

Specifies the variation, based on a sample.

StdDevp

public static final ConsolidationFunction StdDevp

Specifies the standard deviation, based on the entire population.

StdDev

public static final ConsolidationFunction StdDev

Specifies the standard deviation, based on a sample.

Product

public static final ConsolidationFunction Product

Specifies to multiply.

Min

public static final ConsolidationFunction Min

Specifies the minimum.

Max

public static final ConsolidationFunction Max

Specifies the maximum.

CountNums

public static final ConsolidationFunction CountNums

Specifies to count numerical values only.

Count

public static final ConsolidationFunction Count

Specifies the count.

Average

public static final ConsolidationFunction Average

Specifies the average.

DistinctCount

public static final ConsolidationFunction DistinctCount

Specifies to count using distinct count analysis.

Unknown

public static final ConsolidationFunction Unknown

Specifies that no subtotal function is specified.

Method Details

values

public static ConsolidationFunction[] 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 ConsolidationFunction 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