Package org.apache.flink.table.types.inference.strategies

Class ArrayComparableElementArgumentTypeStrategy

java.lang.Object

org.apache.flink.table.types.inference.strategies.ArrayComparableElementArgumentTypeStrategy

All Implemented Interfaces:

ArgumentTypeStrategy

@Internal
public final class ArrayComparableElementArgumentTypeStrategy
extends Object
implements ArgumentTypeStrategy

An ArgumentTypeStrategy that checks if the input argument is an ARRAY type and check whether its' elements are comparable.

It requires one argument.

For the rules which types are comparable with which types see areComparable(LogicalType, LogicalType).

Constructor Summary

Constructors

Constructor	Description
ArrayComparableElementArgumentTypeStrategy(StructuredType.StructuredComparison requiredComparison)

Method Summary

Modifier and Type	Method	Description
Signature.Argument	getExpectedArgument(FunctionDefinition functionDefinition, int argumentPos)	Returns a summary of the function's expected argument at argumentPos.
Optional<DataType>	inferArgumentType(CallContext callContext, int argumentPos, boolean throwOnFailure)	Main logic for inferring and validating an argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayComparableElementArgumentTypeStrategy

public ArrayComparableElementArgumentTypeStrategy(StructuredType.StructuredComparison requiredComparison)

Method Detail

inferArgumentType

public Optional<DataType> inferArgumentType(CallContext callContext,
                                            int argumentPos,
                                            boolean throwOnFailure)

Description copied from interface: ArgumentTypeStrategy

Main logic for inferring and validating an argument. Returns the data type that is valid for the given call. If the returned type differs from CallContext.getArgumentDataTypes() at argumentPos, a casting operation can be inserted. An empty result means that the given input type could not be inferred.

Specified by:

inferArgumentType in interface ArgumentTypeStrategy

Parameters:

callContext - provides details about the function call

argumentPos - argument index in the CallContext

throwOnFailure - whether this function is allowed to throw an ValidationException with a meaningful exception in case the inference is not successful or if this function should simply return an empty result.

Returns:

three-state result for either "true, same data type as argument", "true, but argument must be casted to returned data type", or "false, no inferred data type could be found"

See Also:

CallContext.newValidationError(String, Object...)

getExpectedArgument

public Signature.Argument getExpectedArgument(FunctionDefinition functionDefinition,
                                              int argumentPos)

Description copied from interface: ArgumentTypeStrategy

Returns a summary of the function's expected argument at argumentPos.

Specified by:

getExpectedArgument in interface ArgumentTypeStrategy

Parameters:

functionDefinition - the function definition that defines the function currently being called.

argumentPos - the position within the function call for which the signature should be retrieved