org.apache.flink.optimizer.plan

Class DualInputPlanNode

java.lang.Object

org.apache.flink.optimizer.plan.PlanNode

org.apache.flink.optimizer.plan.DualInputPlanNode

All Implemented Interfaces:

DumpableNode<PlanNode>, Visitable<PlanNode>

Direct Known Subclasses:

BinaryUnionPlanNode, SinkJoinerPlanNode, WorksetIterationPlanNode

public class DualInputPlanNode
extends PlanNode

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.optimizer.plan.PlanNode

PlanNode.FeedbackPropertiesMeetRequirementsReport, PlanNode.SourceAndDamReport

Field Summary

Fields

Modifier and Type	Field and Description
protected Channel	input1
protected Channel	input2
protected FieldList	keys1
protected FieldList	keys2
Object	postPassHelper1
Object	postPassHelper2
protected boolean[]	sortOrders

Fields inherited from class org.apache.flink.optimizer.plan.PlanNode

branchPlan, cumulativeCosts, globalProps, localProps, nodeCosts, outChannels, template

Constructor Summary

Constructors

Constructor and Description
DualInputPlanNode(OptimizerNode template, String nodeName, Channel input1, Channel input2, DriverStrategy diverStrategy)
DualInputPlanNode(OptimizerNode template, String nodeName, Channel input1, Channel input2, DriverStrategy diverStrategy, FieldList driverKeyFields1, FieldList driverKeyFields2)
DualInputPlanNode(OptimizerNode template, String nodeName, Channel input1, Channel input2, DriverStrategy diverStrategy, FieldList driverKeyFields1, FieldList driverKeyFields2, boolean[] driverSortOrders)

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor<PlanNode> visitor) Contains the logic to invoke the visitor and continue the traversal.
TypeComparatorFactory<?>	getComparator1()
TypeComparatorFactory<?>	getComparator2()
Channel	getInput1() Gets the first input channel to this node.
Channel	getInput2() Gets the second input channel to this node.
Iterable<Channel>	getInputs()
FieldList	getKeysForInput1()
FieldList	getKeysForInput2()
TypePairComparatorFactory<?,?>	getPairComparator()
Iterable<PlanNode>	getPredecessors() Gets an iterator over the predecessors.
boolean[]	getSortOrders()
TwoInputNode	getTwoInputNode()
PlanNode.SourceAndDamReport	hasDamOnPathDownTo(PlanNode source) Checks whether this node has a dam on the way down to the given source node.
void	setComparator1(TypeComparatorFactory<?> comparator)
void	setComparator2(TypeComparatorFactory<?> comparator)
void	setPairComparator(TypePairComparatorFactory<?,?> comparator)

Methods inherited from class org.apache.flink.optimizer.plan.PlanNode

addOutgoingChannel, checkPartialSolutionPropertiesMet, getBranchPlan, getBroadcastInputs, getCandidateAtBranchPoint, getCostWeight, getCumulativeCosts, getCumulativeCostsShare, getDriverStrategy, getDumpableInputs, getGlobalProperties, getGuaranteedAvailableMemory, getLocalProperties, getMemoryConsumerWeight, getMinResources, getNodeCosts, getNodeName, getOptimizerNode, getOriginalOptimizerNode, getOutgoingChannels, getParallelism, getPlanNode, getPreferredResources, getProgramOperator, getRelativeMemoryPerSubTask, initProperties, isOnDynamicPath, isPruneMarkerSet, mergeBranchPlanMaps, mergeBranchPlanMaps, setBroadcastInputs, setCosts, setDriverStrategy, setParallelism, setPruningMarker, setRelativeMemoryPerSubtask, toString, updatePropertiesWithUniqueSets

Methods inherited from class java.lang.Object

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

Field Detail

input1

protected final Channel input1

input2

protected final Channel input2

keys1

protected final FieldList keys1

keys2

protected final FieldList keys2

sortOrders

protected final boolean[] sortOrders

postPassHelper1

public Object postPassHelper1

postPassHelper2

public Object postPassHelper2

Constructor Detail

DualInputPlanNode

public DualInputPlanNode(OptimizerNode template,
                         String nodeName,
                         Channel input1,
                         Channel input2,
                         DriverStrategy diverStrategy)

DualInputPlanNode

public DualInputPlanNode(OptimizerNode template,
                         String nodeName,
                         Channel input1,
                         Channel input2,
                         DriverStrategy diverStrategy,
                         FieldList driverKeyFields1,
                         FieldList driverKeyFields2)

DualInputPlanNode

public DualInputPlanNode(OptimizerNode template,
                         String nodeName,
                         Channel input1,
                         Channel input2,
                         DriverStrategy diverStrategy,
                         FieldList driverKeyFields1,
                         FieldList driverKeyFields2,
                         boolean[] driverSortOrders)

Method Detail

getTwoInputNode

public TwoInputNode getTwoInputNode()

getKeysForInput1

public FieldList getKeysForInput1()

getKeysForInput2

public FieldList getKeysForInput2()

getSortOrders

public boolean[] getSortOrders()

getComparator1

public TypeComparatorFactory<?> getComparator1()

getComparator2

public TypeComparatorFactory<?> getComparator2()

setComparator1

public void setComparator1(TypeComparatorFactory<?> comparator)

setComparator2

public void setComparator2(TypeComparatorFactory<?> comparator)

getPairComparator

public TypePairComparatorFactory<?,?> getPairComparator()

setPairComparator

public void setPairComparator(TypePairComparatorFactory<?,?> comparator)

getInput1

public Channel getInput1()

Gets the first input channel to this node.

Returns:

The first input channel to this node.

getInput2

public Channel getInput2()

Gets the second input channel to this node.

Returns:

The second input channel to this node.

accept

public void accept(Visitor<PlanNode> visitor)

Description copied from interface: Visitable

Contains the logic to invoke the visitor and continue the traversal. Typically invokes the pre-visit method of the visitor, then sends the visitor to the children (or predecessors) and then invokes the post-visit method.

A typical code example is the following:

 public void accept(Visitor<Operator> visitor) {
     boolean descend = visitor.preVisit(this);	
     if (descend) {
         if (this.input != null) {
             this.input.accept(visitor);
         }
         visitor.postVisit(this);
     }
 }
 

Parameters:

visitor - The visitor to be called with this object as the parameter.

See Also:

Visitor.preVisit(Visitable), Visitor.postVisit(Visitable)

getPredecessors

public Iterable<PlanNode> getPredecessors()

Description copied from interface: DumpableNode

Gets an iterator over the predecessors.

Specified by:

getPredecessors in interface DumpableNode<PlanNode>

Specified by:

getPredecessors in class PlanNode

Returns:

An iterator over the predecessors.

getInputs

public Iterable<Channel> getInputs()

Specified by:

getInputs in class PlanNode

hasDamOnPathDownTo

public PlanNode.SourceAndDamReport hasDamOnPathDownTo(PlanNode source)

Description copied from class: PlanNode

Checks whether this node has a dam on the way down to the given source node. This method returns either that (a) the source node is not found as a (transitive) child of this node, (b) the node is found, but no dam is on the path, or (c) the node is found and a dam is on the path.

Specified by:

hasDamOnPathDownTo in class PlanNode

Parameters:

source - The node on the path to which the dam is sought.

Returns:

The result whether the node is found and whether a dam is on the path.