org.apache.flink.table.planner.functions.casting

Class CastRuleProvider

java.lang.Object

org.apache.flink.table.planner.functions.casting.CastRuleProvider

@Internal
public class CastRuleProvider
extends Object

This class resolves CastRule using the input and the target type.

Constructor Summary

Constructors

Constructor and Description
CastRuleProvider()

Method Summary

Modifier and Type	Method and Description
static boolean	canFail(LogicalType inputType, LogicalType targetType) Resolves the rule and returns the result of CastRule.canFail(LogicalType, LogicalType).
static Object	cast(CastRule.Context context, LogicalType inputLogicalType, LogicalType targetLogicalType, Object value) Create a CastExecutor and execute the cast on the provided value.
static CastExecutor<?,?>	create(CastRule.Context context, LogicalType inputLogicalType, LogicalType targetLogicalType) Create a CastExecutor for the provided input type and target type.
static boolean	exists(LogicalType inputType, LogicalType targetType) Returns true if and only if a CastRule can be resolved for the provided input type and target type.
static CastCodeBlock	generateCodeBlock(CodeGeneratorCastRule.Context context, String inputTerm, String inputIsNullTerm, LogicalType inputLogicalType, LogicalType targetLogicalType) Create a CastCodeBlock for the provided input type and target type.
static CastRule<?,?>	resolve(LogicalType inputType, LogicalType targetType) Resolve a CastRule for the provided input type and target type.

Methods inherited from class java.lang.Object

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

Constructor Detail

CastRuleProvider

public CastRuleProvider()

Method Detail

resolve

@Nullable
public static CastRule<?,?> resolve(LogicalType inputType,
                                              LogicalType targetType)

Resolve a CastRule for the provided input type and target type. Returns null if no rule can be resolved.

exists

public static boolean exists(LogicalType inputType,
                             LogicalType targetType)

Returns true if and only if a CastRule can be resolved for the provided input type and target type.

canFail

public static boolean canFail(LogicalType inputType,
                              LogicalType targetType)

Resolves the rule and returns the result of CastRule.canFail(LogicalType, LogicalType). Fails with NullPointerException if the rule cannot be resolved.

create

@Nullable
public static CastExecutor<?,?> create(CastRule.Context context,
                                                 LogicalType inputLogicalType,
                                                 LogicalType targetLogicalType)

Create a CastExecutor for the provided input type and target type. Returns null if no rule can be resolved.

See Also:

CastRule.create(CastRule.Context, LogicalType, LogicalType)

generateCodeBlock

@Nullable
public static CastCodeBlock generateCodeBlock(CodeGeneratorCastRule.Context context,
                                                        String inputTerm,
                                                        String inputIsNullTerm,
                                                        LogicalType inputLogicalType,
                                                        LogicalType targetLogicalType)

Create a CastCodeBlock for the provided input type and target type. Returns null if no rule can be resolved or the resolved rule is not instance of CodeGeneratorCastRule.

See Also:

CodeGeneratorCastRule.generateCodeBlock(CodeGeneratorCastRule.Context, String, String, LogicalType, LogicalType)

cast

@Nullable
public static Object cast(CastRule.Context context,
                                    LogicalType inputLogicalType,
                                    LogicalType targetLogicalType,
                                    Object value)

Create a CastExecutor and execute the cast on the provided value. Fails with IllegalArgumentException if the rule cannot be resolved, or with an exception from the CastExecutor itself if the rule can fail.