Package org.apache.flink.api.common.operators

Class SingleInputOperator<IN,OUT,FT extends org.apache.flink.api.common.functions.Function>

java.lang.Object

org.apache.flink.api.common.operators.Operator<OUT>

org.apache.flink.api.common.operators.AbstractUdfOperator<OUT,FT>

org.apache.flink.api.common.operators.SingleInputOperator<IN,OUT,FT>

Type Parameters:

IN - Input type of the user function

OUT - Output type of the user function

FT - Type of the user function

All Implemented Interfaces:

Visitable<Operator<?>>

Direct Known Subclasses:

BulkIterationBase, FilterOperatorBase, FlatMapOperatorBase, GroupCombineOperatorBase, GroupReduceOperatorBase, MapOperatorBase, MapPartitionOperatorBase, PartitionOperatorBase, ReduceOperatorBase, SortPartitionOperatorBase

@Internal
public abstract class SingleInputOperator<IN,OUT,FT extends org.apache.flink.api.common.functions.Function>
extends AbstractUdfOperator<OUT,FT>

Abstract superclass for all operators that have one input like "map" or "reduce".

Field Summary

Fields

Modifier and Type	Field	Description
protected Operator<IN>	input	The input which produces the data consumed by this operator.

Fields inherited from class org.apache.flink.api.common.operators.AbstractUdfOperator

broadcastInputs, userFunction

Fields inherited from class org.apache.flink.api.common.operators.Operator

compilerHints, name, operatorInfo, parameters

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SingleInputOperator(UserCodeWrapper<FT> stub, UnaryOperatorInformation<IN,OUT> operatorInfo, int[] keyPositions, String name)	Creates a new abstract single-input operator with the given name wrapping the given user function.
protected	SingleInputOperator(UserCodeWrapper<FT> stub, UnaryOperatorInformation<IN,OUT> operatorInfo, String name)	Creates a new abstract single-input operator with the given name wrapping the given user function.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor<Operator<?>> visitor)	Accepts the visitor and applies it this instance.
void	addInput(List<Operator<IN>> inputs)	Deprecated. This method will be removed in future versions.
void	addInput(Operator<IN>... input)	Deprecated. This method will be removed in future versions.
void	clearInputs()	Removes all inputs.
protected abstract List<OUT>	executeOnCollections(List<IN> inputData, RuntimeContext runtimeContext, ExecutionConfig executionConfig)
Operator<IN>	getInput()	Returns the input operator or data source, or null, if none is set.
int[]	getKeyColumns(int inputNum)	Gets the column numbers of the key fields in the input records for the given input.
int	getNumberOfInputs()	Gets the number of inputs for this operator.
UnaryOperatorInformation<IN,OUT>	getOperatorInfo()	Gets the information about the operators input/output types.
SingleInputSemanticProperties	getSemanticProperties()
void	setInput(Operator<IN> input)	Sets the given operator as the input to this operator.
void	setInput(Operator<IN>... input)	Deprecated. This method will be removed in future versions.
void	setInputs(List<Operator<IN>> inputs)	Deprecated. This method will be removed in future versions.
void	setSemanticProperties(SingleInputSemanticProperties semanticProperties)

Methods inherited from class org.apache.flink.api.common.operators.AbstractUdfOperator

asArray, emptyClassArray, getBroadcastInputs, getUserCodeWrapper, setBroadcastVariable, setBroadcastVariables

Methods inherited from class org.apache.flink.api.common.operators.Operator

createUnionCascade, createUnionCascade, createUnionCascade, getCompilerHints, getMinResources, getName, getParallelism, getParameters, getPreferredResources, setName, setParallelism, setParameter, setParameter, setParameter, setResources, toString

Methods inherited from class java.lang.Object

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

Field Detail

input

protected Operator<IN> input

The input which produces the data consumed by this operator.

Constructor Detail

SingleInputOperator

protected SingleInputOperator(UserCodeWrapper<FT> stub,
                              UnaryOperatorInformation<IN,OUT> operatorInfo,
                              int[] keyPositions,
                              String name)

Creates a new abstract single-input operator with the given name wrapping the given user function.

Parameters:

stub - The object containing the user function.

keyPositions - The field positions of the input records that act as keys.

name - The given name for the operator, used in plans, logs and progress messages.

SingleInputOperator

protected SingleInputOperator(UserCodeWrapper<FT> stub,
                              UnaryOperatorInformation<IN,OUT> operatorInfo,
                              String name)

Creates a new abstract single-input operator with the given name wrapping the given user function. This constructor is specialized only for operators that require no keys for their processing.

Parameters:

stub - The object containing the user function.

name - The given name for the operator, used in plans, logs and progress messages.

Method Detail

getOperatorInfo

public UnaryOperatorInformation<IN,OUT> getOperatorInfo()

Gets the information about the operators input/output types.

Overrides:

getOperatorInfo in class Operator<OUT>

getInput

public Operator<IN> getInput()

Returns the input operator or data source, or null, if none is set.

Returns:

This operator's input.

clearInputs

public void clearInputs()

Removes all inputs.

setInput

public void setInput(Operator<IN> input)

Sets the given operator as the input to this operator.

Parameters:

input - The operator to use as the input.

setInput

@Deprecated
public void setInput(Operator<IN>... input)

Deprecated.

This method will be removed in future versions. Use the Union operator instead.

Sets the input to the union of the given operators.

Parameters:

input - The operator(s) that form the input.

setInputs

@Deprecated
public void setInputs(List<Operator<IN>> inputs)

Deprecated.

This method will be removed in future versions. Use the Union operator instead.

Sets the input to the union of the given operators.

Parameters:

inputs - The operator(s) that form the input.

addInput

@Deprecated
public void addInput(Operator<IN>... input)

Deprecated.

This method will be removed in future versions. Use the Union operator instead.

Adds to the input the union of the given operators.

Parameters:

input - The operator(s) that form the input.

addInput

@Deprecated
public void addInput(List<Operator<IN>> inputs)

Deprecated.

This method will be removed in future versions. Use the Union operator instead.

Adds to the input the union of the given operators.

Parameters:

inputs - The operator(s) that form the input.

getSemanticProperties

public SingleInputSemanticProperties getSemanticProperties()

setSemanticProperties

public void setSemanticProperties(SingleInputSemanticProperties semanticProperties)

getNumberOfInputs

public final int getNumberOfInputs()

Description copied from class: AbstractUdfOperator

Gets the number of inputs for this operator.

Specified by:

getNumberOfInputs in class AbstractUdfOperator<OUT,FT extends org.apache.flink.api.common.functions.Function>

Returns:

The number of inputs for this operator.

getKeyColumns

public int[] getKeyColumns(int inputNum)

Description copied from class: AbstractUdfOperator

Gets the column numbers of the key fields in the input records for the given input.

Specified by:

getKeyColumns in class AbstractUdfOperator<OUT,FT extends org.apache.flink.api.common.functions.Function>

Returns:

The column numbers of the key fields.

accept

public void accept(Visitor<Operator<?>> visitor)

Accepts the visitor and applies it this instance. The visitors pre-visit method is called and, if returning true, the visitor is recursively applied on the single input. After the recursion returned, the post-visit method is called.

Parameters:

visitor - The visitor.

See Also:

Visitable.accept(org.apache.flink.util.Visitor)

executeOnCollections

protected abstract List<OUT> executeOnCollections(List<IN> inputData,
                                                  RuntimeContext runtimeContext,
                                                  ExecutionConfig executionConfig)
                                           throws Exception

Throws:

Exception