Package org.apache.calcite.rel.hint

Class HintPredicates

java.lang.Object

org.apache.calcite.rel.hint.HintPredicates

public abstract class HintPredicates
extends Object

A collection of hint predicates.

Field Summary

Fields

Modifier and Type	Field	Description
static final HintPredicate	AGGREGATE	A hint predicate that indicates a hint can only be used to Aggregate nodes.
static final HintPredicate	CALC	A hint predicate that indicates a hint can only be used to Calc nodes.
static final HintPredicate	CORRELATE	A hint predicate that indicates a hint can only be used to Correlate nodes.
static final HintPredicate	FILTER	A hint predicate that indicates a hint can only be used to Filter nodes.
static final HintPredicate	JOIN	A hint predicate that indicates a hint can only be used to Join nodes.
static final HintPredicate	PROJECT	A hint predicate that indicates a hint can only be used to Project nodes.
static final HintPredicate	SET_VAR	A hint predicate that indicates a hint can only be used to the whole query(no specific nodes).
static final HintPredicate	SETOP	A hint predicate that indicates a hint can only be used to SetOp nodes.
static final HintPredicate	SNAPSHOT	A hint predicate that indicates a hint can only be used to Snapshot nodes.
static final HintPredicate	SORT	A hint predicate that indicates a hint can only be used to Sort nodes.
static final HintPredicate	TABLE_FUNCTION_SCAN	A hint predicate that indicates a hint can only be used to TableFunctionScan nodes.
static final HintPredicate	TABLE_SCAN	A hint predicate that indicates a hint can only be used to TableScan nodes.
static final HintPredicate	VALUES	A hint predicate that indicates a hint can only be used to Values nodes.
static final HintPredicate	WINDOW	A hint predicate that indicates a hint can only be used to Window nodes.

Constructor Summary

Constructors

Constructor	Description
HintPredicates()

Method Summary

Modifier and Type	Method	Description
static HintPredicate	and(HintPredicate... hintPredicates)	Returns a composed hint predicate that represents a short-circuiting logical AND of an array of hint predicates hintPredicates.
static HintPredicate	or(HintPredicate... hintPredicates)	Returns a composed hint predicate that represents a short-circuiting logical OR of an array of hint predicates hintPredicates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SET_VAR

public static final HintPredicate SET_VAR

A hint predicate that indicates a hint can only be used to the whole query(no specific nodes).

JOIN

public static final HintPredicate JOIN

A hint predicate that indicates a hint can only be used to Join nodes.

TABLE_SCAN

public static final HintPredicate TABLE_SCAN

A hint predicate that indicates a hint can only be used to TableScan nodes.

PROJECT

public static final HintPredicate PROJECT

A hint predicate that indicates a hint can only be used to Project nodes.

AGGREGATE

public static final HintPredicate AGGREGATE

A hint predicate that indicates a hint can only be used to Aggregate nodes.

CALC

public static final HintPredicate CALC

A hint predicate that indicates a hint can only be used to Calc nodes.

CORRELATE

public static final HintPredicate CORRELATE

A hint predicate that indicates a hint can only be used to Correlate nodes.

FILTER

public static final HintPredicate FILTER

A hint predicate that indicates a hint can only be used to Filter nodes.

SETOP

public static final HintPredicate SETOP

A hint predicate that indicates a hint can only be used to SetOp nodes.

SORT

public static final HintPredicate SORT

A hint predicate that indicates a hint can only be used to Sort nodes.

VALUES

public static final HintPredicate VALUES

A hint predicate that indicates a hint can only be used to Values nodes.

WINDOW

public static final HintPredicate WINDOW

A hint predicate that indicates a hint can only be used to Window nodes.

SNAPSHOT

public static final HintPredicate SNAPSHOT

A hint predicate that indicates a hint can only be used to Snapshot nodes.

TABLE_FUNCTION_SCAN

public static final HintPredicate TABLE_FUNCTION_SCAN

A hint predicate that indicates a hint can only be used to TableFunctionScan nodes.

Constructor Details

HintPredicates

public HintPredicates()

Method Details

and

public static HintPredicate and(HintPredicate... hintPredicates)

Returns a composed hint predicate that represents a short-circuiting logical AND of an array of hint predicates hintPredicates. When evaluating the composed predicate, if a predicate is false, then all the left predicates are not evaluated.

The predicates are evaluated in sequence.

or

public static HintPredicate or(HintPredicate... hintPredicates)

Returns a composed hint predicate that represents a short-circuiting logical OR of an array of hint predicates hintPredicates. When evaluating the composed predicate, if a predicate is true, then all the left predicates are not evaluated.

The predicates are evaluated in sequence.