SampleParameters.Sample (GeoWave Parent POM 1.2.0 API)

java.lang.Object
- java.lang.Enum<SampleParameters.Sample>
- - org.locationtech.geowave.analytic.param.SampleParameters.Sample

All Implemented Interfaces:

Serializable, Comparable<SampleParameters.Sample>, ParameterEnum

Enclosing class:

SampleParameters
```
public static enum SampleParameters.Sample
extends Enum<SampleParameters.Sample>
implements ParameterEnum
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DATA_TYPE_NAME`
`INDEX_NAME`
`MAX_SAMPLE_SIZE`
`MIN_SAMPLE_SIZE`
`PROBABILITY_FUNCTION`
`SAMPLE_ITERATIONS`
`SAMPLE_RANK_FUNCTION`
`SAMPLE_SIZE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ParameterHelper<?>`	`getHelper()`
`Enum<?>`	`self()`
`static SampleParameters.Sample`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SampleParameters.Sample[]`	`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, toString, valueOf

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

- Enum Constant Detail
  - SAMPLE_SIZE
```
public static final SampleParameters.Sample SAMPLE_SIZE
```
  - MIN_SAMPLE_SIZE
```
public static final SampleParameters.Sample MIN_SAMPLE_SIZE
```
  - MAX_SAMPLE_SIZE
```
public static final SampleParameters.Sample MAX_SAMPLE_SIZE
```
  - DATA_TYPE_NAME
```
public static final SampleParameters.Sample DATA_TYPE_NAME
```
  - INDEX_NAME
```
public static final SampleParameters.Sample INDEX_NAME
```
  - SAMPLE_ITERATIONS
```
public static final SampleParameters.Sample SAMPLE_ITERATIONS
```
  - PROBABILITY_FUNCTION
```
public static final SampleParameters.Sample PROBABILITY_FUNCTION
```
  - SAMPLE_RANK_FUNCTION
```
public static final SampleParameters.Sample SAMPLE_RANK_FUNCTION
```
- Method Detail
  - values
```
public static SampleParameters.Sample[] 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 (SampleParameters.Sample c : SampleParameters.Sample.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SampleParameters.Sample 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
  - self
```
public Enum<?> self()
```
    Specified by:
    
    self in interface ParameterEnum
  - getHelper
```
public ParameterHelper<?> getHelper()
```
    Specified by:
    
    getHelper in interface ParameterEnum

Enum SampleParameters.Sample

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SAMPLE_SIZE

MIN_SAMPLE_SIZE

MAX_SAMPLE_SIZE

DATA_TYPE_NAME

INDEX_NAME

SAMPLE_ITERATIONS

PROBABILITY_FUNCTION

SAMPLE_RANK_FUNCTION

Method Detail

values

valueOf

self

getHelper