org.apache.flink.api.common.operators

Interface SemanticProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

BinaryUnionNode.UnionSemanticProperties, DualInputSemanticProperties, SemanticProperties.EmptySemanticProperties, SingleInputSemanticProperties, SingleInputSemanticProperties.AllFieldsForwardedProperties

@Internal
public interface SemanticProperties
extends Serializable

Container for the semantic properties associated to an operator.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SemanticProperties.EmptySemanticProperties
static class	SemanticProperties.InvalidSemanticAnnotationException

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getForwardingTargetFields

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.

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

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.

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

FieldSet getReadFields(int input)

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

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.