org.apache.flink.compiler.dag

Class TwoInputNode

java.lang.Object

org.apache.flink.compiler.dag.OptimizerNode

org.apache.flink.compiler.dag.TwoInputNode

All Implemented Interfaces:

EstimateProvider, DumpableNode<OptimizerNode>, Visitable<OptimizerNode>

Direct Known Subclasses:

BinaryUnionNode, CoGroupNode, CrossNode, MatchNode, SinkJoiner, WorksetIterationNode, WorksetIterationNode.SingleRootJoiner

public abstract class TwoInputNode
extends OptimizerNode

A node in the optimizer plan that represents a PACT with a two different inputs, such as MATCH or CROSS. The two inputs are not substitutable in their sides.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.compiler.dag.OptimizerNode

OptimizerNode.UnclosedBranchDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected PactConnection	input1
protected PactConnection	input2
protected FieldList	keys1
protected FieldList	keys2

Fields inherited from class org.apache.flink.compiler.dag.OptimizerNode

cachedPlans, closedBranchingNodes, costWeight, estimatedNumRecords, estimatedOutputSize, hereJoinedBranches, id, MAX_DYNAMIC_PATH_COST_WEIGHT, onDynamicPath, openBranches, remappedKeys, uniqueFields

Constructor Summary

Constructors

Constructor and Description
TwoInputNode(DualInputOperator<?,?,?,?> pactContract) Creates a new node with a single input for the optimizer plan.

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor<OptimizerNode> visitor) This method implements the visit of a depth-first graph traversing visitor.
protected void	addLocalCandidates(Channel template1, Channel template2, List<Set<? extends NamedChannel>> broadcastPlanChannels, RequestedGlobalProperties rgps1, RequestedGlobalProperties rgps2, List<PlanNode> target, OperatorDescriptorDual.LocalPropertiesPair[] validLocalCombinations, CostEstimator estimator)
void	computeInterestingPropertiesForInputs(CostEstimator estimator) Tells the node to compute the interesting properties for its inputs.
void	computeUnclosedBranchStack() This method causes the node to compute the description of open branches in its sub-plan.
List<PlanNode>	getAlternativePlans(CostEstimator estimator) Computes the plan alternatives for this node, an implicitly for all nodes that are children of this node.
PactConnection	getFirstIncomingConnection() Gets the PactConnection through which this node receives its first input.
OptimizerNode	getFirstPredecessorNode()
List<PactConnection>	getIncomingConnections() This method needs to be overridden by subclasses to return the children.
FieldList	getInputKeySet(int input) Returns the key fields of the given input.
DualInputOperator<?,?,?,?>	getPactContract() Gets the object that specifically describes the contract of this node.
protected abstract List<OperatorDescriptorDual>	getPossibleProperties()
PactConnection	getSecondIncomingConnection() Gets the PactConnection through which this node receives its second input.
OptimizerNode	getSecondPredecessorNode()
protected boolean	haveValidOutputEstimates(OptimizerNode subPlan) Checks if the subPlan has a valid outputSize estimation.
protected void	instantiate(OperatorDescriptorDual operator, Channel in1, Channel in2, List<Set<? extends NamedChannel>> broadcastPlanChannels, List<PlanNode> target, CostEstimator estimator, RequestedGlobalProperties globPropsReq1, RequestedGlobalProperties globPropsReq2, RequestedLocalProperties locPropsReq1, RequestedLocalProperties locPropsReq2)
boolean	isFieldConstant(int input, int fieldNumber) Checks whether a field is modified by the user code or whether it is kept unchanged.
protected void	placePipelineBreakersIfNecessary(DriverStrategy strategy, Channel in1, Channel in2)
void	setInput(Map<Operator<?>,OptimizerNode> contractToNode) This function is for plan translation purposes.

Methods inherited from class org.apache.flink.compiler.dag.OptimizerNode

addBroadcastConnection, addClosedBranch, addClosedBranches, addOutgoingConnection, areBranchCompatible, clearInterestingProperties, computeOperatorSpecificDefaultEstimates, computeOutputEstimates, computeUnclosedBranchStackForBroadcastInputs, computeUnionOfInterestingPropertiesFromSuccessors, createUniqueFieldsForNode, getBranchesForParent, getBroadcastConnectionNames, getBroadcastConnections, getClosedBranchingNodes, getConstantKeySet, getCostWeight, getDegreeOfParallelism, getDumpableInputs, getEstimatedAvgWidthPerOutputRecord, getEstimatedNumRecords, getEstimatedOutputSize, getId, getInterestingProperties, getMaxDepth, getMinimalMemoryAcrossAllSubTasks, getName, getOpenBranches, getOptimizerNode, getOutgoingConnections, getPlanNode, getPredecessors, getRemappedKeys, getUniqueFields, hasUnclosedBranches, haveAllOutputConnectionInterestingProperties, identifyDynamicPath, initId, isBranching, isOnDynamicPath, mergeLists, prunePlanAlternatives, prunePlanAlternativesWithCommonBranching, readStubAnnotations, readUniqueFieldsAnnotation, removeClosedBranches, setBroadcastInputs, setDegreeOfParallelism, setEstimatedNumRecords, setEstimatedOutputSize, toString

Methods inherited from class java.lang.Object

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

Field Detail

keys1

protected final FieldList keys1

keys2

protected final FieldList keys2

input1

protected PactConnection input1

input2

protected PactConnection input2

Constructor Detail

TwoInputNode

public TwoInputNode(DualInputOperator<?,?,?,?> pactContract)

Creates a new node with a single input for the optimizer plan.

Parameters:

pactContract - The PACT that the node represents.

Method Detail

getPactContract

public DualInputOperator<?,?,?,?> getPactContract()

Description copied from class: OptimizerNode

Gets the object that specifically describes the contract of this node.

Overrides:

getPactContract in class OptimizerNode

Returns:

This node's contract.

getFirstIncomingConnection

public PactConnection getFirstIncomingConnection()

Gets the PactConnection through which this node receives its first input.

Returns:

The first input connection.

getSecondIncomingConnection

public PactConnection getSecondIncomingConnection()

Gets the PactConnection through which this node receives its second input.

Returns:

The second input connection.

getFirstPredecessorNode

public OptimizerNode getFirstPredecessorNode()

getSecondPredecessorNode

public OptimizerNode getSecondPredecessorNode()

getIncomingConnections

public List<PactConnection> getIncomingConnections()

Description copied from class: OptimizerNode

This method needs to be overridden by subclasses to return the children.

Specified by:

getIncomingConnections in class OptimizerNode

Returns:

The list of incoming links.

setInput

public void setInput(Map<Operator<?>,OptimizerNode> contractToNode)

Description copied from class: OptimizerNode

This function is for plan translation purposes. Upon invocation, the implementing subclasses should examine its contained contract and look at the contracts that feed their data into that contract. The method should then create a PactConnection for each of those inputs.

In addition, the nodes must set the shipping strategy of the connection, if a suitable optimizer hint is found.

Specified by:

setInput in class OptimizerNode

Parameters:

contractToNode - The map to translate the contracts to their corresponding optimizer nodes.

getPossibleProperties

protected abstract List<OperatorDescriptorDual> getPossibleProperties()

computeInterestingPropertiesForInputs

public void computeInterestingPropertiesForInputs(CostEstimator estimator)

Description copied from class: OptimizerNode

Tells the node to compute the interesting properties for its inputs. The interesting properties for the node itself must have been computed before. The node must then see how many of interesting properties it preserves and add its own.

Specified by:

computeInterestingPropertiesForInputs in class OptimizerNode

Parameters:

estimator - The CostEstimator instance to use for plan cost estimation.

getAlternativePlans

public List<PlanNode> getAlternativePlans(CostEstimator estimator)

Description copied from class: OptimizerNode

Computes the plan alternatives for this node, an implicitly for all nodes that are children of this node. This method must determine for each alternative the global and local properties and the costs. This method may recursively call getAlternatives() on its children to get their plan alternatives, and build its own alternatives on top of those.

Specified by:

getAlternativePlans in class OptimizerNode

Parameters:

estimator - The cost estimator used to estimate the costs of each plan alternative.

Returns:

A list containing all plan alternatives.

addLocalCandidates

protected void addLocalCandidates(Channel template1,
                                  Channel template2,
                                  List<Set<? extends NamedChannel>> broadcastPlanChannels,
                                  RequestedGlobalProperties rgps1,
                                  RequestedGlobalProperties rgps2,
                                  List<PlanNode> target,
                                  OperatorDescriptorDual.LocalPropertiesPair[] validLocalCombinations,
                                  CostEstimator estimator)

instantiate

protected void instantiate(OperatorDescriptorDual operator,
                           Channel in1,
                           Channel in2,
                           List<Set<? extends NamedChannel>> broadcastPlanChannels,
                           List<PlanNode> target,
                           CostEstimator estimator,
                           RequestedGlobalProperties globPropsReq1,
                           RequestedGlobalProperties globPropsReq2,
                           RequestedLocalProperties locPropsReq1,
                           RequestedLocalProperties locPropsReq2)

placePipelineBreakersIfNecessary

protected void placePipelineBreakersIfNecessary(DriverStrategy strategy,
                                                Channel in1,
                                                Channel in2)

haveValidOutputEstimates

protected boolean haveValidOutputEstimates(OptimizerNode subPlan)

Checks if the subPlan has a valid outputSize estimation.

Parameters:

subPlan - The subPlan to check.

Returns:

True, if all values are valid, false otherwise

computeUnclosedBranchStack

public void computeUnclosedBranchStack()

Description copied from class: OptimizerNode

This method causes the node to compute the description of open branches in its sub-plan. An open branch describes, that a (transitive) child node had multiple outputs, which have not all been re-joined in the sub-plan. This method needs to set the openBranches field to a stack of unclosed branches, the latest one top. A branch is considered closed, if some later node sees all of the branching node's outputs, no matter if there have been more branches to different paths in the meantime.

Specified by:

computeUnclosedBranchStack in class OptimizerNode

getInputKeySet

public FieldList getInputKeySet(int input)

Returns the key fields of the given input.

Parameters:

input - The input for which key fields must be returned.

Returns:

the key fields of the given input.

isFieldConstant

public boolean isFieldConstant(int input,
                               int fieldNumber)

Description copied from class: OptimizerNode

Checks whether a field is modified by the user code or whether it is kept unchanged.

Specified by:

isFieldConstant in class OptimizerNode

Parameters:

input - The input number.

fieldNumber - The position of the field.

Returns:

True if the field is not changed by the user function, false otherwise.

accept

public void accept(Visitor<OptimizerNode> visitor)

Description copied from class: OptimizerNode

This method implements the visit of a depth-first graph traversing visitor. Implementors must first call the preVisit() method, then hand the visitor to their children, and finally call the postVisit() method.

Specified by:

accept in interface Visitable<OptimizerNode>

Specified by:

accept in class OptimizerNode

Parameters:

visitor - The graph traversing visitor.

See Also:

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