com.datastax.dse.driver.api.core.metadata.schema

Enum DseFunctionMetadata.Monotonicity

java.lang.Object

java.lang.Enum<DseFunctionMetadata.Monotonicity>

com.datastax.dse.driver.api.core.metadata.schema.DseFunctionMetadata.Monotonicity

All Implemented Interfaces:

Serializable, Comparable<DseFunctionMetadata.Monotonicity>

Enclosing interface:

DseFunctionMetadata

public static enum DseFunctionMetadata.Monotonicity
extends Enum<DseFunctionMetadata.Monotonicity>

The monotonicity of a function.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULLY_MONOTONIC Indicates that the function is fully monotonic on all of its arguments.
NOT_MONOTONIC Indicates that the function is not monotonic.
PARTIALLY_MONOTONIC Indicates that the function is partially monotonic, meaning that partial application over some of the its arguments is monotonic.

Method Summary

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

FULLY_MONOTONIC

public static final DseFunctionMetadata.Monotonicity FULLY_MONOTONIC

Indicates that the function is fully monotonic on all of its arguments. This means that it is either entirely non-increasing or non-decreasing. Full monotonicity is required to use the function in a GROUP BY clause.

PARTIALLY_MONOTONIC

public static final DseFunctionMetadata.Monotonicity PARTIALLY_MONOTONIC

Indicates that the function is partially monotonic, meaning that partial application over some of the its arguments is monotonic. Currently (DSE 6.0.0), CQL only allows partial monotonicity on exactly one argument. This may change in a future CQL version.

NOT_MONOTONIC

public static final DseFunctionMetadata.Monotonicity NOT_MONOTONIC

Indicates that the function is not monotonic.

Method Detail

values

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

Returns:

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

valueOf

public static DseFunctionMetadata.Monotonicity 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