org.apache.flink.optimizer.plan

Class SingleInputPlanNode

java.lang.Object

org.apache.flink.optimizer.plan.PlanNode

org.apache.flink.optimizer.plan.SingleInputPlanNode

All Implemented Interfaces:

DumpableNode<PlanNode>, Visitable<PlanNode>

Direct Known Subclasses:

BulkIterationPlanNode, SinkPlanNode

public class SingleInputPlanNode
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 FieldList[]	driverKeys
protected boolean[][]	driverSortOrders
protected Channel	input
Object	postPassHelper

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

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

Constructor Summary

Constructors

Constructor and Description
SingleInputPlanNode(OptimizerNode template, String nodeName, Channel input, DriverStrategy driverStrategy)
SingleInputPlanNode(OptimizerNode template, String nodeName, Channel input, DriverStrategy driverStrategy, FieldList driverKeyFields)
SingleInputPlanNode(OptimizerNode template, String nodeName, Channel input, DriverStrategy driverStrategy, FieldList driverKeyFields, 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<?>	getComparator(int id) Gets the specified comparator from this PlanNode.
Channel	getInput() Gets the input channel to this node.
Iterable<Channel>	getInputs()
FieldList	getKeys(int id) Gets the key field indexes for the specified driver comparator.
PlanNode	getPredecessor() Gets the predecessor of this node, i.e.
Iterable<PlanNode>	getPredecessors() Gets an iterator over the predecessors.
SingleInputNode	getSingleInputNode()
boolean[]	getSortOrders(int id) Gets the sort order for the specified driver comparator.
protected static boolean[]	getTrueArray(int length)
PlanNode.SourceAndDamReport	hasDamOnPathDownTo(PlanNode source) Checks whether this node has a dam on the way down to the given source node.
void	setComparator(TypeComparatorFactory<?> comparator, int id) Sets the specified comparator for this PlanNode.
void	setDriverKeyInfo(FieldList keys, boolean[] sortOrder, int id) Sets the key field information for the specified driver comparator.
void	setDriverKeyInfo(FieldList keys, int id) Sets the key field indexes for the specified driver 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

input

protected final Channel input

driverKeys

protected final FieldList[] driverKeys

driverSortOrders

protected final boolean[][] driverSortOrders

postPassHelper

public Object postPassHelper

Constructor Detail

SingleInputPlanNode

public SingleInputPlanNode(OptimizerNode template,
                           String nodeName,
                           Channel input,
                           DriverStrategy driverStrategy)

SingleInputPlanNode

public SingleInputPlanNode(OptimizerNode template,
                           String nodeName,
                           Channel input,
                           DriverStrategy driverStrategy,
                           FieldList driverKeyFields)

SingleInputPlanNode

public SingleInputPlanNode(OptimizerNode template,
                           String nodeName,
                           Channel input,
                           DriverStrategy driverStrategy,
                           FieldList driverKeyFields,
                           boolean[] driverSortOrders)

Method Detail

getSingleInputNode

public SingleInputNode getSingleInputNode()

getInput

public Channel getInput()

Gets the input channel to this node.

Returns:

The input channel to this node.

getPredecessor

public PlanNode getPredecessor()

Gets the predecessor of this node, i.e. the source of the input channel.

Returns:

The predecessor of this node.

setDriverKeyInfo

public void setDriverKeyInfo(FieldList keys,
                             int id)

Sets the key field indexes for the specified driver comparator.

Parameters:

keys - The key field indexes for the specified driver comparator.

id - The ID of the driver comparator.

setDriverKeyInfo

public void setDriverKeyInfo(FieldList keys,
                             boolean[] sortOrder,
                             int id)

Sets the key field information for the specified driver comparator.

Parameters:

keys - The key field indexes for the specified driver comparator.

sortOrder - The key sort order for the specified driver comparator.

id - The ID of the driver comparator.

getKeys

public FieldList getKeys(int id)

Gets the key field indexes for the specified driver comparator.

Parameters:

id - The id of the driver comparator for which the key field indexes are requested.

Returns:

The key field indexes of the specified driver comparator.

getSortOrders

public boolean[] getSortOrders(int id)

Gets the sort order for the specified driver comparator.

Parameters:

id - The id of the driver comparator for which the sort order is requested.

Returns:

The sort order of the specified driver comparator.

getComparator

public TypeComparatorFactory<?> getComparator(int id)

Gets the specified comparator from this PlanNode.

Parameters:

id - The ID of the requested comparator.

Returns:

The specified comparator.

setComparator

public void setComparator(TypeComparatorFactory<?> comparator,
                          int id)

Sets the specified comparator for this PlanNode.

Parameters:

comparator - The comparator to set.

id - The ID of the comparator to set.

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.

getTrueArray

protected static boolean[] getTrueArray(int length)