org.apache.flink.api.java.record.functions

Class FunctionAnnotation

java.lang.Object

org.apache.flink.api.java.record.functions.FunctionAnnotation

Deprecated.

@Deprecated
public class FunctionAnnotation
extends Object

NOTE: The Record API is marked as deprecated. It is not being developed anymore and will be removed from the code at some point. See FLINK-1106 for more details. This class defines the semantic assertions that can be added to functions. The assertions are realized as java annotations, to be added to the class declaration of the class that realized the user function. For example, to declare the ConstantFieldsExcept annotation for a map-type function that realizes a simple absolute function, use it the following way:

 \@ConstantFieldsExcept(fields={2})
 public class MyMapper extends MapFunction
 {
     public void map(Record record, Collector out)
     {
        int value = record.getField(2, IntValue.class).getValue();
                record.setField(2, new IntValue(Math.abs(value)));

                out.collect(record);
     }
 }
 

Be aware that some annotations should only be used for functions with as single input (MapFunction, ReduceFunction) and some only for stubs with two inputs (CrossFunction, JoinFunction, CoGroupFunction).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FunctionAnnotation.AllFieldsConstants Deprecated. Specifies that all fields of an input record that are unchanged in the output of a MapFunction, or ReduceFunction).
static interface	FunctionAnnotation.ConstantFields Deprecated. Specifies the fields of an input record that are unchanged in the output of a stub with a single input ( MapFunction, ReduceFunction).
static interface	FunctionAnnotation.ConstantFieldsExcept Deprecated. Specifies the fields of an input record that are changed in the output of a stub with a single input ( MapFunction, ReduceFunction).
static interface	FunctionAnnotation.ConstantFieldsFirst Deprecated. Specifies the fields of an input record of the first input that are unchanged in the output of a stub with two inputs ( CrossFunction, JoinFunction, CoGroupFunction) A field is considered to be constant if its value is not changed and copied to the same position of output record.
static interface	FunctionAnnotation.ConstantFieldsFirstExcept Deprecated. Specifies the fields of an input record of the first input that are changed in the output of a stub with two inputs ( CrossFunction, JoinFunction, CoGroupFunction) All other fields are assumed to be constant.
static interface	FunctionAnnotation.ConstantFieldsSecond Deprecated. Specifies the fields of an input record of the second input that are unchanged in the output of a stub with two inputs ( CrossFunction, JoinFunction, CoGroupFunction) A field is considered to be constant if its value is not changed and copied to the same position of output record.
static interface	FunctionAnnotation.ConstantFieldsSecondExcept Deprecated. Specifies the fields of an input record of the second input that are changed in the output of a stub with two inputs ( CrossFunction, JoinFunction, CoGroupFunction) All other fields are assumed to be constant.

Method Summary

Methods

Modifier and Type	Method and Description
static DualInputSemanticProperties	readDualConstantAnnotations(UserCodeWrapper<?> udf) Deprecated.
static SingleInputSemanticProperties	readSingleConstantAnnotations(UserCodeWrapper<?> udf) Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

readSingleConstantAnnotations

public static SingleInputSemanticProperties readSingleConstantAnnotations(UserCodeWrapper<?> udf)

Deprecated.

readDualConstantAnnotations

public static DualInputSemanticProperties readDualConstantAnnotations(UserCodeWrapper<?> udf)

Deprecated.