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

Class DualInputSemanticProperties

java.lang.Object

org.apache.flink.api.common.operators.DualInputSemanticProperties

All Implemented Interfaces:

Serializable, SemanticProperties

@Internal
public class DualInputSemanticProperties
extends Object
implements SemanticProperties

Container for the semantic properties associated to a dual input operator.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.api.common.operators.SemanticProperties

SemanticProperties.EmptySemanticProperties, SemanticProperties.InvalidSemanticAnnotationException

Constructor Summary

Constructors

Constructor	Description
DualInputSemanticProperties()

Method Summary

Modifier and Type	Method	Description
void	addForwardedField(int input, int sourceField, int targetField)	Adds, to the existing information, a field that is forwarded directly from the source record(s) in the first input to the destination record(s).
void	addReadFields(int input, FieldSet readFields)	Adds, to the existing information, field(s) that are read in the source record(s) from the first input.
int	getForwardingSourceField(int input, int targetField)	Returns the index of the source field on the given input from which the target field has been unmodified copied by a function.
FieldSet	getForwardingTargetFields(int input, int sourceField)	Returns the indexes of all target fields to which a source field has been unmodified copied by a function.
FieldSet	getReadFields(int input)	Returns the position indexes of all fields of an input that are accessed by a function.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DualInputSemanticProperties

public DualInputSemanticProperties()

Method Detail

getForwardingTargetFields

public FieldSet getForwardingTargetFields(int input,
                                          int sourceField)

Description copied from interface: SemanticProperties

Returns the indexes of all target fields to which a source field has been unmodified copied by a function.

Specified by:

getForwardingTargetFields in interface SemanticProperties

Parameters:

input - The input id for the requested source field (0 for first input, 1 for second input)

sourceField - The index of the field for which the target position index is requested.

Returns:

A set containing the indexes of all target fields to which the source field has been unmodified copied.

getForwardingSourceField

public int getForwardingSourceField(int input,
                                    int targetField)

Description copied from interface: SemanticProperties

Returns the index of the source field on the given input from which the target field has been unmodified copied by a function.

Specified by:

getForwardingSourceField in interface SemanticProperties

Parameters:

input - The input id for the requested source field (0 for first input, 1 for second input)

targetField - The index of the target field to which the source field has been copied.

Returns:

The index of the source field on the given index that was copied to the given target field. -1 if the target field was not copied from any source field of the given input.

getReadFields

public FieldSet getReadFields(int input)

Description copied from interface: SemanticProperties

Returns the position indexes of all fields of an input that are accessed by a function.

Specified by:

getReadFields in interface SemanticProperties

Parameters:

input - The input id for which accessed fields are requested.

Returns:

A set of fields of the specified input which have been accessed by the function. Null if no information is available.

addForwardedField

public void addForwardedField(int input,
                              int sourceField,
                              int targetField)

Adds, to the existing information, a field that is forwarded directly from the source record(s) in the first input to the destination record(s).

Parameters:

input - the input of the source field

sourceField - the position in the source record

targetField - the position in the destination record

addReadFields

public void addReadFields(int input,
                          FieldSet readFields)

Adds, to the existing information, field(s) that are read in the source record(s) from the first input.

Parameters:

input - the input of the read fields

readFields - the position(s) in the source record(s)

toString

public String toString()

Overrides:

toString in class Object