org.apache.flink.compiler.dag

Class AbstractPartialSolutionNode

java.lang.Object

org.apache.flink.compiler.dag.OptimizerNode

org.apache.flink.compiler.dag.AbstractPartialSolutionNode

All Implemented Interfaces:

EstimateProvider, DumpableNode<OptimizerNode>, Visitable<OptimizerNode>

Direct Known Subclasses:

BulkPartialSolutionNode, SolutionSetNode, WorksetNode

public abstract class AbstractPartialSolutionNode
extends OptimizerNode

The optimizer's internal representation of the partial solution that is input to a bulk iteration.

Nested Class Summary

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

OptimizerNode.UnclosedBranchDescriptor

Field Summary

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

Modifier	Constructor and Description
protected	AbstractPartialSolutionNode(Operator<?> contract)

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)
protected void	copyEstimates(OptimizerNode node)
List<PlanNode>	getAlternativePlans(CostEstimator estimator) Computes the plan alternatives for this node, an implicitly for all nodes that are children of this node.
List<PactConnection>	getIncomingConnections() This method needs to be overridden by subclasses to return the children.
abstract IterationNode	getIterationNode()
void	identifyDynamicPath(int costWeight)
boolean	isFieldConstant(int input, int fieldNumber) Checks whether a field is modified by the user code or whether it is kept unchanged.
boolean	isOnDynamicPath()
protected void	readStubAnnotations() Reads all stub annotations, i.e.
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, computeOutputEstimates, computeUnclosedBranchStack, computeUnclosedBranchStackForBroadcastInputs, computeUnionOfInterestingPropertiesFromSuccessors, createUniqueFieldsForNode, getBranchesForParent, getBroadcastConnectionNames, getBroadcastConnections, getClosedBranchingNodes, getConstantKeySet, getCostWeight, getDegreeOfParallelism, getDumpableInputs, getEstimatedAvgWidthPerOutputRecord, getEstimatedNumRecords, getEstimatedOutputSize, getId, getInterestingProperties, getMaxDepth, getMinimalMemoryAcrossAllSubTasks, getName, getOpenBranches, getOptimizerNode, getOutgoingConnections, getPactContract, getPlanNode, getPredecessors, getRemappedKeys, getUniqueFields, hasUnclosedBranches, haveAllOutputConnectionInterestingProperties, initId, isBranching, mergeLists, prunePlanAlternatives, prunePlanAlternativesWithCommonBranching, readUniqueFieldsAnnotation, removeClosedBranches, setBroadcastInputs, setDegreeOfParallelism, setEstimatedNumRecords, setEstimatedOutputSize, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPartialSolutionNode

protected AbstractPartialSolutionNode(Operator<?> contract)

Method Detail

copyEstimates

protected void copyEstimates(OptimizerNode node)

getIterationNode

public abstract IterationNode getIterationNode()

isOnDynamicPath

public boolean isOnDynamicPath()

Overrides:

isOnDynamicPath in class OptimizerNode

identifyDynamicPath

public void identifyDynamicPath(int costWeight)

Overrides:

identifyDynamicPath in class OptimizerNode

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.

computeOperatorSpecificDefaultEstimates

protected void computeOperatorSpecificDefaultEstimates(DataStatistics statistics)

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.

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.

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.

readStubAnnotations

protected void readStubAnnotations()

Description copied from class: OptimizerNode

Reads all stub annotations, i.e. which fields remain constant, what cardinality bounds the functions have, which fields remain unique.

Overrides:

readStubAnnotations 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. 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)