org.apache.flink.api.java.typeutils

Class TypeExtractor

java.lang.Object

org.apache.flink.api.java.typeutils.TypeExtractor

@Public
public class TypeExtractor
extends Object

A utility for reflection analysis on classes, to determine the return type of implementations of transformation functions.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TypeExtractor()

Method Summary

Modifier and Type	Method and Description
protected <OUT,IN1,IN2> TypeInformation<OUT>	analyzePojo(Class<OUT> clazz, ArrayList<Type> typeHierarchy, ParameterizedType parameterizedType, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type)
static <IN1,IN2,OUT> TypeInformation<OUT>	createTypeInfo(Class<?> baseClass, Class<?> clazz, int returnParamPos, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type)
static <T> TypeInformation<T>	createTypeInfo(Class<T> type)
static <OUT> TypeInformation<OUT>	createTypeInfo(Object instance, Class<?> baseClass, Class<?> clazz, int returnParamPos) Creates a TypeInformation from the given parameters.
static TypeInformation<?>	createTypeInfo(Type t)
static List<Field>	getAllDeclaredFields(Class<?> clazz) recursively determine all declared fields This is required because class.getFields() is not returning fields defined in parent classes.
static <IN1,IN2,OUT> TypeInformation<OUT>	getBinaryOperatorReturnType(Function function, Class<?> baseClass, boolean hasIterables, boolean hasCollector, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type, String functionName, boolean allowMissing) Returns the binary operator's return type.
static <IN1,IN2,OUT> TypeInformation<OUT>	getBinaryOperatorReturnType(Function function, Class<?> baseClass, int inputTypeArgumentIndex, int outputTypeArgumentIndex, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type, String functionName, boolean allowMissing) Returns the binary operator's return type.
static <IN1,IN2,OUT> TypeInformation<OUT>	getCoGroupReturnTypes(CoGroupFunction<IN1,IN2,OUT> coGroupInterface, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type)
static <IN1,IN2,OUT> TypeInformation<OUT>	getCoGroupReturnTypes(CoGroupFunction<IN1,IN2,OUT> coGroupInterface, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type, String functionName, boolean allowMissing)
static <IN1,IN2,OUT> TypeInformation<OUT>	getCrossReturnTypes(CrossFunction<IN1,IN2,OUT> crossInterface, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type)
static <IN1,IN2,OUT> TypeInformation<OUT>	getCrossReturnTypes(CrossFunction<IN1,IN2,OUT> crossInterface, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type, String functionName, boolean allowMissing)
static Field	getDeclaredField(Class<?> clazz, String name)
static <IN1,IN2,OUT> TypeInformation<OUT>	getFlatJoinReturnTypes(FlatJoinFunction<IN1,IN2,OUT> joinInterface, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type)
static <IN1,IN2,OUT> TypeInformation<OUT>	getFlatJoinReturnTypes(FlatJoinFunction<IN1,IN2,OUT> joinInterface, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type, String functionName, boolean allowMissing)
static <IN,OUT> TypeInformation<OUT>	getFlatMapReturnTypes(FlatMapFunction<IN,OUT> flatMapInterface, TypeInformation<IN> inType)
static <IN,OUT> TypeInformation<OUT>	getFlatMapReturnTypes(FlatMapFunction<IN,OUT> flatMapInterface, TypeInformation<IN> inType, String functionName, boolean allowMissing)
static <IN,OUT> TypeInformation<OUT>	getFoldReturnTypes(FoldFunction<IN,OUT> foldInterface, TypeInformation<IN> inType)
static <IN,OUT> TypeInformation<OUT>	getFoldReturnTypes(FoldFunction<IN,OUT> foldInterface, TypeInformation<IN> inType, String functionName, boolean allowMissing)
static <X> TypeInformation<X>	getForClass(Class<X> clazz) Creates type information from a given Class such as Integer, String[] or POJOs.
static <X> TypeInformation<X>	getForObject(X value)
static <IN,OUT> TypeInformation<OUT>	getGroupCombineReturnTypes(GroupCombineFunction<IN,OUT> combineInterface, TypeInformation<IN> inType)
static <IN,OUT> TypeInformation<OUT>	getGroupCombineReturnTypes(GroupCombineFunction<IN,OUT> combineInterface, TypeInformation<IN> inType, String functionName, boolean allowMissing)
static <IN,OUT> TypeInformation<OUT>	getGroupReduceReturnTypes(GroupReduceFunction<IN,OUT> groupReduceInterface, TypeInformation<IN> inType)
static <IN,OUT> TypeInformation<OUT>	getGroupReduceReturnTypes(GroupReduceFunction<IN,OUT> groupReduceInterface, TypeInformation<IN> inType, String functionName, boolean allowMissing)
static <IN> TypeInformation<IN>	getInputFormatTypes(InputFormat<IN,?> inputFormatInterface)
static <IN1,IN2,OUT> TypeInformation<OUT>	getJoinReturnTypes(JoinFunction<IN1,IN2,OUT> joinInterface, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type)
static <IN1,IN2,OUT> TypeInformation<OUT>	getJoinReturnTypes(JoinFunction<IN1,IN2,OUT> joinInterface, TypeInformation<IN1> in1Type, TypeInformation<IN2> in2Type, String functionName, boolean allowMissing)
static <IN,OUT> TypeInformation<OUT>	getKeySelectorTypes(KeySelector<IN,OUT> selectorInterface, TypeInformation<IN> inType)
static <IN,OUT> TypeInformation<OUT>	getKeySelectorTypes(KeySelector<IN,OUT> selectorInterface, TypeInformation<IN> inType, String functionName, boolean allowMissing)
static <IN,OUT> TypeInformation<OUT>	getMapPartitionReturnTypes(MapPartitionFunction<IN,OUT> mapPartitionInterface, TypeInformation<IN> inType)
static <IN,OUT> TypeInformation<OUT>	getMapPartitionReturnTypes(MapPartitionFunction<IN,OUT> mapPartitionInterface, TypeInformation<IN> inType, String functionName, boolean allowMissing)
static <IN,OUT> TypeInformation<OUT>	getMapReturnTypes(MapFunction<IN,OUT> mapInterface, TypeInformation<IN> inType)
static <IN,OUT> TypeInformation<OUT>	getMapReturnTypes(MapFunction<IN,OUT> mapInterface, TypeInformation<IN> inType, String functionName, boolean allowMissing)
static Type	getParameterType(Class<?> baseClass, Class<?> clazz, int pos)
static <T> TypeInformation<T>	getPartitionerTypes(Partitioner<T> partitioner)
static <T> TypeInformation<T>	getPartitionerTypes(Partitioner<T> partitioner, String functionName, boolean allowMissing)
static <IN,OUT> TypeInformation<OUT>	getUnaryOperatorReturnType(Function function, Class<?> baseClass, boolean hasIterable, boolean hasCollector, TypeInformation<IN> inType, String functionName, boolean allowMissing) Returns the unary operator's return type.
static <IN,OUT> TypeInformation<OUT>	getUnaryOperatorReturnType(Function function, Class<?> baseClass, int inputTypeArgumentIndex, int outputTypeArgumentIndex, TypeInformation<IN> inType, String functionName, boolean allowMissing) Returns the unary operator's return type.
static boolean	isClassType(Type t)
static Class<?>	typeToClass(Type t)

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeExtractor

protected TypeExtractor()

Method Detail

getMapReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getMapReturnTypes(MapFunction<IN,OUT> mapInterface,
                                                                              TypeInformation<IN> inType)

getMapReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getMapReturnTypes(MapFunction<IN,OUT> mapInterface,
                                                                              TypeInformation<IN> inType,
                                                                              String functionName,
                                                                              boolean allowMissing)

getFlatMapReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getFlatMapReturnTypes(FlatMapFunction<IN,OUT> flatMapInterface,
                                                                                  TypeInformation<IN> inType)

getFlatMapReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getFlatMapReturnTypes(FlatMapFunction<IN,OUT> flatMapInterface,
                                                                                  TypeInformation<IN> inType,
                                                                                  String functionName,
                                                                                  boolean allowMissing)

getFoldReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getFoldReturnTypes(FoldFunction<IN,OUT> foldInterface,
                                                                               TypeInformation<IN> inType)

getFoldReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getFoldReturnTypes(FoldFunction<IN,OUT> foldInterface,
                                                                               TypeInformation<IN> inType,
                                                                               String functionName,
                                                                               boolean allowMissing)

getMapPartitionReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getMapPartitionReturnTypes(MapPartitionFunction<IN,OUT> mapPartitionInterface,
                                                                                       TypeInformation<IN> inType)

getMapPartitionReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getMapPartitionReturnTypes(MapPartitionFunction<IN,OUT> mapPartitionInterface,
                                                                                       TypeInformation<IN> inType,
                                                                                       String functionName,
                                                                                       boolean allowMissing)

getGroupReduceReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getGroupReduceReturnTypes(GroupReduceFunction<IN,OUT> groupReduceInterface,
                                                                                      TypeInformation<IN> inType)

getGroupReduceReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getGroupReduceReturnTypes(GroupReduceFunction<IN,OUT> groupReduceInterface,
                                                                                      TypeInformation<IN> inType,
                                                                                      String functionName,
                                                                                      boolean allowMissing)

getGroupCombineReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getGroupCombineReturnTypes(GroupCombineFunction<IN,OUT> combineInterface,
                                                                                       TypeInformation<IN> inType)

getGroupCombineReturnTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getGroupCombineReturnTypes(GroupCombineFunction<IN,OUT> combineInterface,
                                                                                       TypeInformation<IN> inType,
                                                                                       String functionName,
                                                                                       boolean allowMissing)

getFlatJoinReturnTypes

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> getFlatJoinReturnTypes(FlatJoinFunction<IN1,IN2,OUT> joinInterface,
                                                                                        TypeInformation<IN1> in1Type,
                                                                                        TypeInformation<IN2> in2Type)

getFlatJoinReturnTypes

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> getFlatJoinReturnTypes(FlatJoinFunction<IN1,IN2,OUT> joinInterface,
                                                                                        TypeInformation<IN1> in1Type,
                                                                                        TypeInformation<IN2> in2Type,
                                                                                        String functionName,
                                                                                        boolean allowMissing)

getJoinReturnTypes

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> getJoinReturnTypes(JoinFunction<IN1,IN2,OUT> joinInterface,
                                                                                    TypeInformation<IN1> in1Type,
                                                                                    TypeInformation<IN2> in2Type)

getJoinReturnTypes

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> getJoinReturnTypes(JoinFunction<IN1,IN2,OUT> joinInterface,
                                                                                    TypeInformation<IN1> in1Type,
                                                                                    TypeInformation<IN2> in2Type,
                                                                                    String functionName,
                                                                                    boolean allowMissing)

getCoGroupReturnTypes

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> getCoGroupReturnTypes(CoGroupFunction<IN1,IN2,OUT> coGroupInterface,
                                                                                       TypeInformation<IN1> in1Type,
                                                                                       TypeInformation<IN2> in2Type)

getCoGroupReturnTypes

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> getCoGroupReturnTypes(CoGroupFunction<IN1,IN2,OUT> coGroupInterface,
                                                                                       TypeInformation<IN1> in1Type,
                                                                                       TypeInformation<IN2> in2Type,
                                                                                       String functionName,
                                                                                       boolean allowMissing)

getCrossReturnTypes

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> getCrossReturnTypes(CrossFunction<IN1,IN2,OUT> crossInterface,
                                                                                     TypeInformation<IN1> in1Type,
                                                                                     TypeInformation<IN2> in2Type)

getCrossReturnTypes

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> getCrossReturnTypes(CrossFunction<IN1,IN2,OUT> crossInterface,
                                                                                     TypeInformation<IN1> in1Type,
                                                                                     TypeInformation<IN2> in2Type,
                                                                                     String functionName,
                                                                                     boolean allowMissing)

getKeySelectorTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getKeySelectorTypes(KeySelector<IN,OUT> selectorInterface,
                                                                                TypeInformation<IN> inType)

getKeySelectorTypes

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getKeySelectorTypes(KeySelector<IN,OUT> selectorInterface,
                                                                                TypeInformation<IN> inType,
                                                                                String functionName,
                                                                                boolean allowMissing)

getPartitionerTypes

@PublicEvolving
public static <T> TypeInformation<T> getPartitionerTypes(Partitioner<T> partitioner)

getPartitionerTypes

@PublicEvolving
public static <T> TypeInformation<T> getPartitionerTypes(Partitioner<T> partitioner,
                                                                         String functionName,
                                                                         boolean allowMissing)

getInputFormatTypes

@PublicEvolving
public static <IN> TypeInformation<IN> getInputFormatTypes(InputFormat<IN,?> inputFormatInterface)

getUnaryOperatorReturnType

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getUnaryOperatorReturnType(Function function,
                                                                                       Class<?> baseClass,
                                                                                       boolean hasIterable,
                                                                                       boolean hasCollector,
                                                                                       TypeInformation<IN> inType,
                                                                                       String functionName,
                                                                                       boolean allowMissing)

Returns the unary operator's return type.

Type Parameters:

IN - Input type

OUT - Output type

Parameters:

function - Function to extract the return type from

baseClass - Base class of the function

hasIterable - True if the first function parameter is an iterable, otherwise false

hasCollector - True if the function has an additional collector parameter, otherwise false

inType - Type of the input elements (In case of an iterable, it is the element type)

functionName - Function name

allowMissing - Can the type information be missing

Returns:

TypeInformation of the return type of the function

getUnaryOperatorReturnType

@PublicEvolving
public static <IN,OUT> TypeInformation<OUT> getUnaryOperatorReturnType(Function function,
                                                                                       Class<?> baseClass,
                                                                                       int inputTypeArgumentIndex,
                                                                                       int outputTypeArgumentIndex,
                                                                                       TypeInformation<IN> inType,
                                                                                       String functionName,
                                                                                       boolean allowMissing)

Returns the unary operator's return type.

Type Parameters:

IN - Input type

OUT - Output type

Parameters:

function - Function to extract the return type from

baseClass - Base class of the function

inputTypeArgumentIndex - Index of the type argument of function's first parameter specifying the input type if it is wrapped (Iterable, Map, etc.). Otherwise -1.

outputTypeArgumentIndex - Index of the type argument of functions second parameter specifying the output type if it is wrapped in a Collector. Otherwise -1.

inType - Type of the input elements (In case of an iterable, it is the element type)

functionName - Function name

allowMissing - Can the type information be missing

Returns:

TypeInformation of the return type of the function

getBinaryOperatorReturnType

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> getBinaryOperatorReturnType(Function function,
                                                                                             Class<?> baseClass,
                                                                                             boolean hasIterables,
                                                                                             boolean hasCollector,
                                                                                             TypeInformation<IN1> in1Type,
                                                                                             TypeInformation<IN2> in2Type,
                                                                                             String functionName,
                                                                                             boolean allowMissing)

Returns the binary operator's return type.

Type Parameters:

IN1 - Left side input type

IN2 - Right side input type

OUT - Output type

Parameters:

function - Function to extract the return type from

baseClass - Base class of the function

hasIterables - True if the first function parameter is an iterable, otherwise false

hasCollector - True if the function has an additional collector parameter, otherwise false

in1Type - Type of the left side input elements (In case of an iterable, it is the element type)

in2Type - Type of the right side input elements (In case of an iterable, it is the element type)

functionName - Function name

allowMissing - Can the type information be missing

Returns:

TypeInformation of the return type of the function

getBinaryOperatorReturnType

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> getBinaryOperatorReturnType(Function function,
                                                                                             Class<?> baseClass,
                                                                                             int inputTypeArgumentIndex,
                                                                                             int outputTypeArgumentIndex,
                                                                                             TypeInformation<IN1> in1Type,
                                                                                             TypeInformation<IN2> in2Type,
                                                                                             String functionName,
                                                                                             boolean allowMissing)

Returns the binary operator's return type.

Type Parameters:

IN1 - Left side input type

IN2 - Right side input type

OUT - Output type

Parameters:

function - Function to extract the return type from

baseClass - Base class of the function

inputTypeArgumentIndex - Index of the type argument of function's first parameter specifying the input type if it is wrapped (Iterable, Map, etc.). Otherwise -1.

outputTypeArgumentIndex - Index of the type argument of functions second parameter specifying the output type if it is wrapped in a Collector. Otherwise -1.

in1Type - Type of the left side input elements (In case of an iterable, it is the element type)

in2Type - Type of the right side input elements (In case of an iterable, it is the element type)

functionName - Function name

allowMissing - Can the type information be missing

Returns:

TypeInformation of the return type of the function

createTypeInfo

public static <T> TypeInformation<T> createTypeInfo(Class<T> type)

createTypeInfo

public static TypeInformation<?> createTypeInfo(Type t)

createTypeInfo

@PublicEvolving
public static <OUT> TypeInformation<OUT> createTypeInfo(Object instance,
                                                                        Class<?> baseClass,
                                                                        Class<?> clazz,
                                                                        int returnParamPos)

Creates a TypeInformation from the given parameters. If the given instance implements ResultTypeQueryable, its information is used to determine the type information. Otherwise, the type information is derived based on the given class information.

Type Parameters:

OUT - output type

Parameters:

instance - instance to determine type information for

baseClass - base class of instance

clazz - class of instance

returnParamPos - index of the return type in the type arguments of clazz

Returns:

type information

createTypeInfo

@PublicEvolving
public static <IN1,IN2,OUT> TypeInformation<OUT> createTypeInfo(Class<?> baseClass,
                                                                                Class<?> clazz,
                                                                                int returnParamPos,
                                                                                TypeInformation<IN1> in1Type,
                                                                                TypeInformation<IN2> in2Type)

getParameterType

@PublicEvolving
public static Type getParameterType(Class<?> baseClass,
                                                    Class<?> clazz,
                                                    int pos)

getForClass

public static <X> TypeInformation<X> getForClass(Class<X> clazz)

Creates type information from a given Class such as Integer, String[] or POJOs. This method does not support ParameterizedTypes such as Tuples or complex type hierarchies. In most cases createTypeInfo(Type) is the recommended method for type extraction (a Class is a child of Type).

Parameters:

clazz - a Class to create TypeInformation for

Returns:

TypeInformation that describes the passed Class

analyzePojo

protected <OUT,IN1,IN2> TypeInformation<OUT> analyzePojo(Class<OUT> clazz,
                                                         ArrayList<Type> typeHierarchy,
                                                         ParameterizedType parameterizedType,
                                                         TypeInformation<IN1> in1Type,
                                                         TypeInformation<IN2> in2Type)

getAllDeclaredFields

@PublicEvolving
public static List<Field> getAllDeclaredFields(Class<?> clazz)

recursively determine all declared fields This is required because class.getFields() is not returning fields defined in parent classes.

getDeclaredField

@PublicEvolving
public static Field getDeclaredField(Class<?> clazz,
                                                     String name)

typeToClass

@Internal
public static Class<?> typeToClass(Type t)

isClassType

@Internal
public static boolean isClassType(Type t)

getForObject

public static <X> TypeInformation<X> getForObject(X value)