org.apache.calcite.rel.hint

Class HintStrategy

java.lang.Object

org.apache.calcite.rel.hint.HintStrategy

public class HintStrategy
extends Object

Represents a hint strategy entry of HintStrategyTable.

A HintStrategy defines:

• HintPredicate: tests whether a hint should apply to a relational expression;
• HintOptionChecker: validates the hint options;
• excludedRules: rules to exclude when a relational expression is going to apply a planner rule;
• converterRules: fallback rules to apply when there are no proper implementations after excluding the excludedRules.

The HintPredicate is required, all the other items are optional.

HintStrategy is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HintStrategy.Builder Builder for HintStrategy.

Field Summary

Fields

Modifier and Type	Field and Description
com.google.common.collect.ImmutableSet<ConverterRule>	converterRules
com.google.common.collect.ImmutableSet<RelOptRule>	excludedRules
@Nullable HintOptionChecker	hintOptionChecker
HintPredicate	predicate

Method Summary

Modifier and Type	Method and Description
static HintStrategy.Builder	builder(HintPredicate hintPredicate) Returns a HintStrategy builder with given hint predicate.

Methods inherited from class java.lang.Object

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

Field Detail

predicate

public final HintPredicate predicate

hintOptionChecker

public final @Nullable HintOptionChecker hintOptionChecker

excludedRules

public final com.google.common.collect.ImmutableSet<RelOptRule> excludedRules

converterRules

public final com.google.common.collect.ImmutableSet<ConverterRule> converterRules

Method Detail

builder

public static HintStrategy.Builder builder(HintPredicate hintPredicate)

Returns a HintStrategy builder with given hint predicate.

Parameters:

hintPredicate - hint predicate

Returns:

HintStrategy.Builder instance