InputTypeStrategies (flink-table-common 1.10.0 API)

java.lang.Object
- org.apache.flink.table.types.inference.InputTypeStrategies

```
@Internal
public final class InputTypeStrategies
extends Object
```
Strategies for inferring and validating input arguments in a function call.

See Also:

InputTypeStrategy, ArgumentTypeStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`static AnyArgumentTypeStrategy`	`ANY` Strategy for an argument that can be of any type.
`static LiteralArgumentTypeStrategy`	`LITERAL` Strategy that checks if an argument is a literal.
`static LiteralArgumentTypeStrategy`	`LITERAL_OR_NULL` Strategy that checks if an argument is a literal or NULL.
`static OutputArgumentTypeStrategy`	`OUTPUT_IF_NULL` Strategy for inferring an unknown argument type from the function's output `DataType` if available.
`static WildcardInputTypeStrategy`	`WILDCARD` Strategy that does not perform any modification or validation of the input.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AndArgumentTypeStrategy`	`and(ArgumentTypeStrategy... strategies)` Strategy for a conjunction of multiple `ArgumentTypeStrategy`s into one like `f(NUMERIC && LITERAL)`.
`static ExplicitArgumentTypeStrategy`	`explicit(DataType expectedDataType)` Strategy for an argument that corresponds to an explicitly defined type casting.
`static InputTypeStrategy`	`explicitSequence(DataType... expectedDataTypes)` Strategy for a function signature of explicitly defined types like `f(STRING, INT)`.
`static InputTypeStrategy`	`explicitSequence(String[] argumentNames, DataType[] expectedDataTypes)` Strategy for a named function signature of explicitly defined types like `f(s STRING, i INT)`.
`static OrArgumentTypeStrategy`	`or(ArgumentTypeStrategy... strategies)` Strategy for a disjunction of multiple `ArgumentTypeStrategy`s into one like `f(NUMERIC \|\| STRING)`.
`static InputTypeStrategy`	`or(InputTypeStrategy... strategies)` Strategy for a disjunction of multiple `InputTypeStrategy`s into one like `f(NUMERIC) \|\| f(STRING)`.
`static InputTypeStrategy`	`sequence(ArgumentTypeStrategy... strategies)` Strategy for a function signature like `f(STRING, NUMERIC)` using a sequence of `ArgumentTypeStrategy`s.
`static InputTypeStrategy`	`sequence(String[] argumentNames, ArgumentTypeStrategy[] strategies)` Strategy for a named function signature like `f(s STRING, n NUMERIC)` using a sequence of `ArgumentTypeStrategy`s.
`static InputTypeStrategy`	`varyingSequence(ArgumentTypeStrategy... strategies)` Strategy for a varying function signature like `f(INT, STRING, NUMERIC...)` using a sequence of `ArgumentTypeStrategy`s.
`static InputTypeStrategy`	`varyingSequence(String[] argumentNames, ArgumentTypeStrategy[] strategies)` Strategy for a varying named function signature like `f(i INT, str STRING, num NUMERIC...)` using a sequence of `ArgumentTypeStrategy`s.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WILDCARD
```
public static final WildcardInputTypeStrategy WILDCARD
```
    Strategy that does not perform any modification or validation of the input.
  - OUTPUT_IF_NULL
```
public static final OutputArgumentTypeStrategy OUTPUT_IF_NULL
```
    Strategy for inferring an unknown argument type from the function's output DataType if available.
  - ANY
```
public static final AnyArgumentTypeStrategy ANY
```
    Strategy for an argument that can be of any type.
  - LITERAL
```
public static final LiteralArgumentTypeStrategy LITERAL
```
    Strategy that checks if an argument is a literal.
  - LITERAL_OR_NULL
```
public static final LiteralArgumentTypeStrategy LITERAL_OR_NULL
```
    Strategy that checks if an argument is a literal or NULL.
- Method Detail
  - sequence
```
public static InputTypeStrategy sequence(ArgumentTypeStrategy... strategies)
```
    Strategy for a function signature like f(STRING, NUMERIC) using a sequence of ArgumentTypeStrategys.
  - sequence
```
public static InputTypeStrategy sequence(String[] argumentNames,
                                         ArgumentTypeStrategy[] strategies)
```
    Strategy for a named function signature like f(s STRING, n NUMERIC) using a sequence of ArgumentTypeStrategys.
  - varyingSequence
```
public static InputTypeStrategy varyingSequence(ArgumentTypeStrategy... strategies)
```
    Strategy for a varying function signature like f(INT, STRING, NUMERIC...) using a sequence of ArgumentTypeStrategys. The first n - 1 arguments must be constant. The n-th argument can occur 0, 1, or more times.
  - varyingSequence
```
public static InputTypeStrategy varyingSequence(String[] argumentNames,
                                                ArgumentTypeStrategy[] strategies)
```
    Strategy for a varying named function signature like f(i INT, str STRING, num NUMERIC...) using a sequence of ArgumentTypeStrategys. The first n - 1 arguments must be constant. The n-th argument can occur 0, 1, or more times.
  - explicitSequence
```
public static InputTypeStrategy explicitSequence(DataType... expectedDataTypes)
```
    Strategy for a function signature of explicitly defined types like f(STRING, INT). Implicit casts will be inserted if possible.
    This is equivalent to using sequence(ArgumentTypeStrategy...) and explicit(DataType).
  - explicitSequence
```
public static InputTypeStrategy explicitSequence(String[] argumentNames,
                                                 DataType[] expectedDataTypes)
```
    Strategy for a named function signature of explicitly defined types like f(s STRING, i INT). Implicit casts will be inserted if possible.
    This is equivalent to using sequence(String[], ArgumentTypeStrategy[]) and explicit(DataType).
  - or
```
public static InputTypeStrategy or(InputTypeStrategy... strategies)
```
    Strategy for a disjunction of multiple InputTypeStrategys into one like f(NUMERIC) || f(STRING).
  - explicit
```
public static ExplicitArgumentTypeStrategy explicit(DataType expectedDataType)
```
    Strategy for an argument that corresponds to an explicitly defined type casting. Implicit casts will be inserted if possible.
  - and
```
public static AndArgumentTypeStrategy and(ArgumentTypeStrategy... strategies)
```
    Strategy for a conjunction of multiple ArgumentTypeStrategys into one like f(NUMERIC && LITERAL).
    Some ArgumentTypeStrategys cannot contribute an inferred type that is different from the input type (e.g. LITERAL). Therefore, the order f(X && Y) or f(Y && X) matters as it defines the precedence in case the result must be casted to a more specific type.
    This strategy aims to infer the first more specific, casted type or (if this is not possible) a type that has been inferred from all ArgumentTypeStrategys.
  - or
```
public static OrArgumentTypeStrategy or(ArgumentTypeStrategy... strategies)
```
    Strategy for a disjunction of multiple ArgumentTypeStrategys into one like f(NUMERIC || STRING).
    Some ArgumentTypeStrategys cannot contribute an inferred type that is different from the input type (e.g. LITERAL). Therefore, the order f(X || Y) or f(Y || X) matters as it defines the precedence in case the result must be casted to a more specific type.
    This strategy aims to infer a type that is equal to the input type (to prevent unnecessary casting) or (if this is not possible) the first more specific, casted type.

Class InputTypeStrategies

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WILDCARD

OUTPUT_IF_NULL

ANY

LITERAL

LITERAL_OR_NULL

Method Detail

sequence

sequence

varyingSequence

varyingSequence

explicitSequence

explicitSequence

or

explicit

and

or