Operator (flink-core 1.1.0 API)

java.lang.Object
- org.apache.flink.api.common.operators.Operator<OUT>

Type Parameters:

OUT - Output type of the records output by this operator

All Implemented Interfaces:

Visitable<Operator<?>>

Direct Known Subclasses:

AbstractUdfOperator, BulkIterationBase.PartialSolutionPlaceHolder, DeltaIterationBase.SolutionSetPlaceHolder, DeltaIterationBase.WorksetPlaceHolder, GenericDataSinkBase, GenericDataSourceBase
```
@Internal
public abstract class Operator<OUT>
extends Object
implements Visitable<Operator<?>>
```
Abstract base class for all operators. An operator is a source, sink, or it applies an operation to one or more inputs, producing a result.

Field Summary

Fields
Modifier and Type	Field and Description
`protected CompilerHints`	`compilerHints`
`protected String`	`name`
`protected OperatorInformation<OUT>`	`operatorInfo` The return type of the user function.
`protected Configuration`	`parameters`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Operator(OperatorInformation<OUT> operatorInfo, String name)
Creates a new contract with the given name.

Constructors
Modifier	Constructor and Description
`protected`	`Operator(OperatorInformation<OUT> operatorInfo, String name)` Creates a new contract with the given name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> Operator<T>`	`createUnionCascade(List<? extends Operator<T>> operators)` Takes a list of operators and creates a cascade of unions of this inputs, if needed.
`static <T> Operator<T>`	`createUnionCascade(Operator<T>... operators)` Takes a list of operators and creates a cascade of unions of this inputs, if needed.
`static <T> Operator<T>`	`createUnionCascade(Operator<T> input1, Operator<T>... input2)` Takes a single Operator and a list of operators and creates a cascade of unions of this inputs, if needed.
`CompilerHints`	`getCompilerHints()` Gets the compiler hints for this contract instance.
`String`	`getName()` Gets the name of the contract instance.
`OperatorInformation<OUT>`	`getOperatorInfo()` Gets the information about the operators input/output types.
`int`	`getParallelism()` Gets the parallelism for this contract instance.
`Configuration`	`getParameters()` Gets the stub parameters of this contract.
`UserCodeWrapper<?>`	`getUserCodeWrapper()` Gets the user code wrapper.
`void`	`setName(String name)` Sets the name of the contract instance.
`void`	`setParallelism(int parallelism)` Sets the parallelism for this contract instance.
`void`	`setParameter(String key, boolean value)` Sets a stub parameters in the configuration of this contract.
`void`	`setParameter(String key, int value)` Sets a stub parameters in the configuration of this contract.
`void`	`setParameter(String key, String value)` Sets a stub parameters in the configuration of this contract.
`String`	`toString()`

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

Methods inherited from interface org.apache.flink.util.Visitable
accept

- Field Detail
  - parameters
```
protected final Configuration parameters
```
  - compilerHints
```
protected CompilerHints compilerHints
```
  - name
```
protected String name
```
  - operatorInfo
```
protected final OperatorInformation<OUT> operatorInfo
```
    The return type of the user function.
- Constructor Detail
  - Operator
```
protected Operator(OperatorInformation<OUT> operatorInfo,
                   String name)
```
    Creates a new contract with the given name. The parameters are empty by default and the compiler hints are not set.
    
    Parameters:
    
    name - The name that is used to describe the contract.
- Method Detail
  - getOperatorInfo
```
public OperatorInformation<OUT> getOperatorInfo()
```
    Gets the information about the operators input/output types.
  - getName
```
public String getName()
```
    Gets the name of the contract instance. The name is only used to describe the contract instance in logging output and graphical representations.
    
    Returns:
    
    The contract instance's name.
  - setName
```
public void setName(String name)
```
    Sets the name of the contract instance. The name is only used to describe the contract instance in logging output and graphical representations.
    
    Parameters:
    
    name - The operator's name.
  - getCompilerHints
```
public CompilerHints getCompilerHints()
```
    Gets the compiler hints for this contract instance. In the compiler hints, different fields may be set (for example the selectivity) that will be evaluated by the pact compiler when generating plan alternatives.
    
    Returns:
    
    The compiler hints object.
  - getParameters
```
public Configuration getParameters()
```
    Gets the stub parameters of this contract. The stub parameters are a map that maps string keys to string or integer values. The map is accessible by the user code at runtime. Parameters that the user code needs to access at runtime to configure its behavior are typically stored in that configuration object.
    
    Returns:
    
    The configuration containing the stub parameters.
  - setParameter
```
public void setParameter(String key,
                         String value)
```
    Sets a stub parameters in the configuration of this contract. The stub parameters are accessible by the user code at runtime. Parameters that the user code needs to access at runtime to configure its behavior are typically stored as stub parameters.
    
    Parameters:
    
    key - The parameter key.
    
    value - The parameter value.
    
    See Also:
    
    getParameters()
  - setParameter
```
public void setParameter(String key,
                         int value)
```
    Sets a stub parameters in the configuration of this contract. The stub parameters are accessible by the user code at runtime. Parameters that the user code needs to access at runtime to configure its behavior are typically stored as stub parameters.
    
    Parameters:
    
    key - The parameter key.
    
    value - The parameter value.
    
    See Also:
    
    getParameters()
  - setParameter
```
public void setParameter(String key,
                         boolean value)
```
    Sets a stub parameters in the configuration of this contract. The stub parameters are accessible by the user code at runtime. Parameters that the user code needs to access at runtime to configure its behavior are typically stored as stub parameters.
    
    Parameters:
    
    key - The parameter key.
    
    value - The parameter value.
    
    See Also:
    
    getParameters()
  - getParallelism
```
public int getParallelism()
```
    Gets the parallelism for this contract instance. The parallelism denotes how many parallel instances of the user function will be spawned during the execution. If this value is ExecutionConfig.PARALLELISM_DEFAULT, then the system will decide the number of parallel instances by itself.
    
    Returns:
    
    The parallelism.
  - setParallelism
```
public void setParallelism(int parallelism)
```
    Sets the parallelism for this contract instance. The parallelism denotes how many parallel instances of the user function will be spawned during the execution.
    
    Parameters:
    
    parallelism - The number of parallel instances to spawn. Set this value to ExecutionConfig.PARALLELISM_DEFAULT to let the system decide on its own.
  - getUserCodeWrapper
```
public UserCodeWrapper<?> getUserCodeWrapper()
```
    Gets the user code wrapper. In the case of a pact, that object will be the stub with the user function, in the case of an input or output format, it will be the format object.
    
    Returns:
    
    The class with the user code.
  - createUnionCascade
```
public static <T> Operator<T> createUnionCascade(List<? extends Operator<T>> operators)
```
    Takes a list of operators and creates a cascade of unions of this inputs, if needed. If not needed (there was only one operator in the list), then that operator is returned.
    
    Parameters:
    
    operators - The operators.
    
    Returns:
    
    The single operator or a cascade of unions of the operators.
  - createUnionCascade
```
public static <T> Operator<T> createUnionCascade(Operator<T>... operators)
```
    Takes a list of operators and creates a cascade of unions of this inputs, if needed. If not needed (there was only one operator in the list), then that operator is returned.
    
    Parameters:
    
    operators - The operators.
    
    Returns:
    
    The single operator or a cascade of unions of the operators.
  - createUnionCascade
```
public static <T> Operator<T> createUnionCascade(Operator<T> input1,
                                                 Operator<T>... input2)
```
    Takes a single Operator and a list of operators and creates a cascade of unions of this inputs, if needed. If not needed there was only one operator as input, then this operator is returned.
    
    Parameters:
    
    input1 - The first input operator.
    
    input2 - The other input operators.
    
    Returns:
    
    The single operator or a cascade of unions of the operators.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Operator<OUT>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.flink.util.Visitable

Field Detail

parameters

compilerHints

name

operatorInfo

Constructor Detail

Operator

Method Detail

getOperatorInfo

getName

setName

getCompilerHints

getParameters

setParameter

setParameter

setParameter

getParallelism

setParallelism

getUserCodeWrapper

createUnionCascade

createUnionCascade

createUnionCascade

toString