Package org.apache.calcite.adapter.enumerable

Enum EnumerableRel.Prefer

java.lang.Object

java.lang.Enum<EnumerableRel.Prefer>

org.apache.calcite.adapter.enumerable.EnumerableRel.Prefer

All Implemented Interfaces:

Serializable, Comparable<EnumerableRel.Prefer>, Constable

Enclosing interface:

EnumerableRel

public static enum EnumerableRel.Prefer
extends Enum<EnumerableRel.Prefer>

Preferred physical type.

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
ANY	Consumer has no preferred representation.
ARRAY	Records must be represented as arrays.
ARRAY_NICE	Consumer would prefer that records are represented as arrays, but can accommodate records represented as objects.
CUSTOM	Records must be represented as objects.
CUSTOM_NICE	Consumer would prefer that records are represented as objects, but can accommodate records represented as arrays.

Method Summary

Modifier and Type	Method	Description
EnumerableRel.Prefer	of(JavaRowFormat format)
JavaRowFormat	prefer(JavaRowFormat format)
JavaRowFormat	preferArray()
JavaRowFormat	preferCustom()
static EnumerableRel.Prefer	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EnumerableRel.Prefer[]	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, 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

ARRAY

public static final EnumerableRel.Prefer ARRAY

Records must be represented as arrays.

ARRAY_NICE

public static final EnumerableRel.Prefer ARRAY_NICE

Consumer would prefer that records are represented as arrays, but can accommodate records represented as objects.

CUSTOM

public static final EnumerableRel.Prefer CUSTOM

Records must be represented as objects.

CUSTOM_NICE

public static final EnumerableRel.Prefer CUSTOM_NICE

Consumer would prefer that records are represented as objects, but can accommodate records represented as arrays.

ANY

public static final EnumerableRel.Prefer ANY

Consumer has no preferred representation.

Method Details

values

public static EnumerableRel.Prefer[] values()

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

Returns:

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

valueOf

public static EnumerableRel.Prefer 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

preferCustom

public JavaRowFormat preferCustom()

preferArray

public JavaRowFormat preferArray()

prefer

public JavaRowFormat prefer(JavaRowFormat format)

of

public EnumerableRel.Prefer of(JavaRowFormat format)