com.grapecity.documents.excel

Enum ConsolidationFunction

java.lang.Object

java.lang.Enum<ConsolidationFunction>

com.grapecity.documents.excel.ConsolidationFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConsolidationFunction>

public enum ConsolidationFunction
extends java.lang.Enum<ConsolidationFunction>

Specifies the subtotal function.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Average Specifies the average.
Count Specifies the count.
CountNums Specifies to count numerical values only.
DistinctCount
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 and Description
static ConsolidationFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConsolidationFunction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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

Unknown

public static final ConsolidationFunction Unknown

Specifies that no subtotal function is specified.

Method Detail

values

public static ConsolidationFunction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConsolidationFunction c : ConsolidationFunction.values())
    System.out.println(c);

Returns:

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

valueOf

public static ConsolidationFunction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null