PilotStandardFunction (FastODS 0.8.1 API)

java.lang.Object
- java.lang.Enum<PilotStandardFunction>
- - com.github.jferard.fastods.attribute.PilotStandardFunction

All Implemented Interfaces:

AttributeValue, PilotFunction, Serializable, Comparable<PilotStandardFunction>
```
public enum PilotStandardFunction
extends Enum<PilotStandardFunction>
implements PilotFunction
```
19.643table:function

Author:

J. Férard

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTO` no function is applied to that category field.
`AVERAGE` the average of all numeric values.
`COUNT` the count of all non-empty values, including text.
`COUNT_NUMS` the count of all numeric values.
`MAX` the maximum of all numeric values.
`MIN` the minimum of all numeric values.
`PRODUCT` the product of all numeric values.
`ST_DEV` the standard deviation, treating all numeric values as a sample from a population.
`ST_DEVP` the standard deviation, treating all numeric values as a whole population.
`SUM` the sum of all numeric values.
`VAR` the variance, treating all numeric values as a sample from a population.
`VARP` the variance, treating all numeric values as a whole population.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getValue()`
`String`	`toString()`
`static PilotStandardFunction`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PilotStandardFunction[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - AVERAGE
```
public static final PilotStandardFunction AVERAGE
```
    the average of all numeric values.
  - COUNT
```
public static final PilotStandardFunction COUNT
```
    the count of all non-empty values, including text.
  - COUNT_NUMS
```
public static final PilotStandardFunction COUNT_NUMS
```
    the count of all numeric values.
  - MAX
```
public static final PilotStandardFunction MAX
```
    the maximum of all numeric values.
  - MIN
```
public static final PilotStandardFunction MIN
```
    the minimum of all numeric values.
  - PRODUCT
```
public static final PilotStandardFunction PRODUCT
```
    the product of all numeric values.
  - ST_DEV
```
public static final PilotStandardFunction ST_DEV
```
    the standard deviation, treating all numeric values as a sample from a population.
  - ST_DEVP
```
public static final PilotStandardFunction ST_DEVP
```
    the standard deviation, treating all numeric values as a whole population.
  - SUM
```
public static final PilotStandardFunction SUM
```
    the sum of all numeric values.
  - VAR
```
public static final PilotStandardFunction VAR
```
    the variance, treating all numeric values as a sample from a population.
  - VARP
```
public static final PilotStandardFunction VARP
```
    the variance, treating all numeric values as a whole population.
  - AUTO
```
public static final PilotStandardFunction AUTO
```
    no function is applied to that category field.
- Method Detail
  - values
```
public static PilotStandardFunction[] 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 (PilotStandardFunction c : PilotStandardFunction.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PilotStandardFunction valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<PilotStandardFunction>
  - getValue
```
public String getValue()
```
    Specified by:
    
    getValue in interface AttributeValue
    
    Returns:
    
    the string representation of the attribute

Enum PilotStandardFunction

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AVERAGE

COUNT

COUNT_NUMS

MAX

MIN

PRODUCT

ST_DEV

ST_DEVP

SUM

VAR

VARP

AUTO

Method Detail

values

valueOf

toString

getValue