org.apache.flink.optimizer.dag

Class DataSinkNode

java.lang.Object

org.apache.flink.optimizer.dag.OptimizerNode

org.apache.flink.optimizer.dag.DataSinkNode

All Implemented Interfaces:

EstimateProvider, DumpableNode<OptimizerNode>, Visitable<OptimizerNode>

public class DataSinkNode
extends OptimizerNode

The Optimizer representation of a data sink.

Nested Class Summary

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

OptimizerNode.UnclosedBranchDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected DagConnection	input

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

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

Constructor Summary

Constructors

Constructor and Description
DataSinkNode(GenericDataSinkBase<?> sink) Creates a new DataSinkNode for the given sink operator.

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.
void	computeInterestingPropertiesForInputs(CostEstimator estimator) Tells the node to compute the interesting properties for its inputs.
protected void	computeOperatorSpecificDefaultEstimates(DataStatistics statistics) Computes the estimated outputs for the data sink.
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.
protected List<OptimizerNode.UnclosedBranchDescriptor>	getBranchesForParent(DagConnection parent)
List<DagConnection>	getIncomingConnections() Gets all incoming connections of this node.
DagConnection	getInputConnection() Gets the input of the sink.
GenericDataSinkBase<?>	getOperator() Gets the operator for which this optimizer sink node was created.
String	getOperatorName() Gets the name of this node, which is the name of the function/operator, or data source / data sink.
List<DagConnection>	getOutgoingConnections() Gets all outgoing connections, which is an empty set for the data sink.
OptimizerNode	getPredecessorNode() Gets the predecessor of this node.
SemanticProperties	getSemanticProperties()
void	setInput(Map<Operator<?>,OptimizerNode> contractToNode, ExecutionMode defaultExchangeMode) This function connects the predecessors to this operator.

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

addBroadcastConnection, addClosedBranch, addClosedBranches, addOutgoingConnection, areBranchCompatible, clearInterestingProperties, computeOutputEstimates, computeUnclosedBranchStackForBroadcastInputs, computeUnionOfInterestingPropertiesFromSuccessors, getBroadcastConnectionNames, getBroadcastConnections, getClosedBranchingNodes, getCostWeight, getDumpableInputs, getEstimatedAvgWidthPerOutputRecord, getEstimatedNumRecords, getEstimatedOutputSize, getId, getInterestingProperties, getMaxDepth, getMinimalMemoryAcrossAllSubTasks, getOpenBranches, getOptimizerNode, getParallelism, getPlanNode, getPredecessors, getUniqueFields, hasUnclosedBranches, haveAllOutputConnectionInterestingProperties, identifyDynamicPath, initId, isBranching, isOnDynamicPath, markAllOutgoingConnectionsAsPipelineBreaking, mergeLists, prunePlanAlternatives, prunePlanAlternativesWithCommonBranching, readStubAnnotations, readUniqueFieldsAnnotation, removeClosedBranches, setBroadcastInputs, setEstimatedNumRecords, setEstimatedOutputSize, setParallelism, toString

Methods inherited from class java.lang.Object

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

Field Detail

input

protected DagConnection input

Constructor Detail

DataSinkNode

public DataSinkNode(GenericDataSinkBase<?> sink)

Creates a new DataSinkNode for the given sink operator.

Parameters:

sink - The data sink contract object.

Method Detail

getInputConnection

public DagConnection getInputConnection()

Gets the input of the sink.

Returns:

The input connection.

getPredecessorNode

public OptimizerNode getPredecessorNode()

Gets the predecessor of this node.

Returns:

The predecessor, or null, if no predecessor has been set.

getOperator

public GenericDataSinkBase<?> getOperator()

Gets the operator for which this optimizer sink node was created.

Overrides:

getOperator in class OptimizerNode

Returns:

The node's underlying operator.

getOperatorName

public String getOperatorName()

Description copied from class: OptimizerNode

Gets the name of this node, which is the name of the function/operator, or data source / data sink.

Specified by:

getOperatorName in class OptimizerNode

Returns:

The node name.

getIncomingConnections

public List<DagConnection> getIncomingConnections()

Description copied from class: OptimizerNode

Gets all incoming connections of this node. This method needs to be overridden by subclasses to return the children.

Specified by:

getIncomingConnections in class OptimizerNode

Returns:

The list of incoming connections.

getOutgoingConnections

public List<DagConnection> getOutgoingConnections()

Gets all outgoing connections, which is an empty set for the data sink.

Overrides:

getOutgoingConnections in class OptimizerNode

Returns:

An empty list.

setInput

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

Description copied from class: OptimizerNode

This function connects the predecessors to this operator.

Specified by:

setInput in class OptimizerNode

Parameters:

contractToNode - The map from program operators to optimizer nodes.

defaultExchangeMode - The data exchange mode to use, if the operator does not specify one.

computeOperatorSpecificDefaultEstimates

protected void computeOperatorSpecificDefaultEstimates(DataStatistics statistics)

Computes the estimated outputs for the data sink. Since the sink does not modify anything, it simply copies the output estimates from its direct predecessor.

Specified by:

computeOperatorSpecificDefaultEstimates in class OptimizerNode

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.

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

getBranchesForParent

protected List<OptimizerNode.UnclosedBranchDescriptor> getBranchesForParent(DagConnection parent)

Overrides:

getBranchesForParent in class OptimizerNode

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.

getSemanticProperties

public SemanticProperties getSemanticProperties()

Specified by:

getSemanticProperties in class OptimizerNode

accept

public void accept(Visitor<OptimizerNode> visitor)

Description copied from class: OptimizerNode

This method implements the visit of a depth-first graph traversing visitor. Implementers 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)