com.bigdata.bop.joinGraph.rto

Enum EstimateEnum

java.lang.Object

java.lang.Enum<EstimateEnum>

com.bigdata.bop.joinGraph.rto.EstimateEnum

All Implemented Interfaces:

Serializable, Comparable<EstimateEnum>

public enum EstimateEnum
extends Enum<EstimateEnum>

Type safe enumeration describes the edge condition (if any) for a cardinality estimate.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Exact The cardinality estimate is exact.
LowerBound The cardinality estimation is a lower bound (the actual cardinality may be higher than the estimated value).
Normal An estimate, but not any of the edge conditions.
Underflow Flag is set when the cardinality estimate underflowed (false zero (0)).

Method Summary

Methods

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

Normal

public static final EstimateEnum Normal

An estimate, but not any of the edge conditions.

Exact

public static final EstimateEnum Exact

The cardinality estimate is exact.

LowerBound

public static final EstimateEnum LowerBound

The cardinality estimation is a lower bound (the actual cardinality may be higher than the estimated value).

Note: The estimated cardinality reported for a LowerBound is the sum of the fast range counts for the sampled access paths. See the logic which handles cutoff join sampling for details on this.

Underflow

public static final EstimateEnum Underflow

Flag is set when the cardinality estimate underflowed (false zero (0)).

Method Detail

values

public static EstimateEnum[] 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 (EstimateEnum c : EstimateEnum.values())
    System.out.println(c);

Returns:

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

valueOf

public static EstimateEnum 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

getCode

public String getCode()