PlanNode (Flink : 1.20-SNAPSHOT API)

java.lang.Object
- org.apache.flink.optimizer.plan.PlanNode

All Implemented Interfaces:

DumpableNode<PlanNode>, Visitable<PlanNode>

Direct Known Subclasses:

BulkPartialSolutionPlanNode, DualInputPlanNode, NAryUnionPlanNode, SingleInputPlanNode, SolutionSetPlanNode, SourcePlanNode, WorksetPlanNode
```
public abstract class PlanNode
extends Object
implements Visitable<PlanNode>, DumpableNode<PlanNode>
```
The representation of a data exchange between two operators. The data exchange can realize a shipping strategy, which established global properties, and a local strategy, which establishes local properties.
Because we currently deal only with plans where the operator order is fixed, many properties are equal among candidates and are determined prior to the enumeration (such as for example constant/dynamic path membership). Hence, many methods will delegate to the OptimizerNode that represents the node this candidate was created for.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PlanNode.FeedbackPropertiesMeetRequirementsReport

static class PlanNode.SourceAndDamReport

Nested Classes
Modifier and Type	Class and Description
`static class`	`PlanNode.FeedbackPropertiesMeetRequirementsReport`
`static class`	`PlanNode.SourceAndDamReport`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<OptimizerNode,PlanNode>`	`branchPlan`
`protected Costs`	`cumulativeCosts`
`protected GlobalProperties`	`globalProps`
`protected LocalProperties`	`localProps`
`protected Costs`	`nodeCosts`
`protected List<Channel>`	`outChannels`
`protected OptimizerNode`	`template`

Constructor Summary

Constructors
Constructor and Description

PlanNode(OptimizerNode template, String nodeName, DriverStrategy strategy)

Constructors
Constructor and Description
`PlanNode(OptimizerNode template, String nodeName, DriverStrategy strategy)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOutgoingChannel(Channel channel)` Adds a channel to a successor node to this node.
`PlanNode.FeedbackPropertiesMeetRequirementsReport`	`checkPartialSolutionPropertiesMet(PlanNode partialSolution, GlobalProperties feedbackGlobal, LocalProperties feedbackLocal)`
`Map<OptimizerNode,PlanNode>`	`getBranchPlan()`
`List<NamedChannel>`	`getBroadcastInputs()` Gets a list of all broadcast inputs attached to this node.
`PlanNode`	`getCandidateAtBranchPoint(OptimizerNode branchPoint)`
`int`	`getCostWeight()`
`Costs`	`getCumulativeCosts()` Gets the cumulative costs of this nose.
`Costs`	`getCumulativeCostsShare()`
`DriverStrategy`	`getDriverStrategy()` Gets the driver strategy from this node.
`Iterable<DumpableConnection<PlanNode>>`	`getDumpableInputs()`
`GlobalProperties`	`getGlobalProperties()` Gets the global properties from this PlanNode.
`long`	`getGuaranteedAvailableMemory()`
`abstract Iterable<Channel>`	`getInputs()`
`LocalProperties`	`getLocalProperties()` Gets the local properties from this PlanNode.
`int`	`getMemoryConsumerWeight()`
`ResourceSpec`	`getMinResources()`
`Costs`	`getNodeCosts()` Gets the costs incurred by this node.
`String`	`getNodeName()` Gets the name of the plan node.
`OptimizerNode`	`getOptimizerNode()`
`OptimizerNode`	`getOriginalOptimizerNode()` Gets the node from the optimizer DAG for which this plan candidate node was created.
`List<Channel>`	`getOutgoingChannels()` Gets a list of all outgoing channels leading to successors.
`int`	`getParallelism()`
`PlanNode`	`getPlanNode()`
`abstract Iterable<PlanNode>`	`getPredecessors()` Gets an iterator over the predecessors.
`ResourceSpec`	`getPreferredResources()`
`Operator<?>`	`getProgramOperator()` Gets the program operator that this node represents in the plan.
`double`	`getRelativeMemoryPerSubTask()` Gets the memory dedicated to each sub-task for this node.
`abstract PlanNode.SourceAndDamReport`	`hasDamOnPathDownTo(PlanNode source)` Checks whether this node has a dam on the way down to the given source node.
`void`	`initProperties(GlobalProperties globals, LocalProperties locals)`
`boolean`	`isOnDynamicPath()`
`boolean`	`isPruneMarkerSet()` Checks whether the pruning marker was set.
`protected void`	`mergeBranchPlanMaps(Map<OptimizerNode,PlanNode> branchPlan1, Map<OptimizerNode,PlanNode> branchPlan2)`
`protected void`	`mergeBranchPlanMaps(PlanNode pred1, PlanNode pred2)`
`void`	`setBroadcastInputs(List<NamedChannel> broadcastInputs)` Sets a list of all broadcast inputs attached to this node.
`void`	`setCosts(Costs nodeCosts)` Sets the basic cost for this node to the given value, and sets the cumulative costs to those costs plus the cost shares of all inputs (regular and broadcast).
`void`	`setDriverStrategy(DriverStrategy newDriverStrategy)` Sets the driver strategy for this node.
`void`	`setParallelism(int parallelism)`
`void`	`setPruningMarker()` Sets the pruning marker to true.
`void`	`setRelativeMemoryPerSubtask(double relativeMemoryPerSubtask)` Sets the memory dedicated to each task for this node.
`String`	`toString()`
`void`	`updatePropertiesWithUniqueSets(Set<FieldSet> uniqueFieldCombinations)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flink.util.Visitable
accept

- Field Detail
  - template
```
protected final OptimizerNode template
```
  - outChannels
```
protected final List<Channel> outChannels
```
  - localProps
```
protected LocalProperties localProps
```
  - globalProps
```
protected GlobalProperties globalProps
```
  - branchPlan
```
protected Map<OptimizerNode,PlanNode> branchPlan
```
  - nodeCosts
```
protected Costs nodeCosts
```
  - cumulativeCosts
```
protected Costs cumulativeCosts
```
- Constructor Detail
  - PlanNode
```
public PlanNode(OptimizerNode template,
                String nodeName,
                DriverStrategy strategy)
```
- Method Detail
  - mergeBranchPlanMaps
```
protected void mergeBranchPlanMaps(PlanNode pred1,
                                   PlanNode pred2)
```
  - mergeBranchPlanMaps
```
protected void mergeBranchPlanMaps(Map<OptimizerNode,PlanNode> branchPlan1,
                                   Map<OptimizerNode,PlanNode> branchPlan2)
```
  - getOriginalOptimizerNode
```
public OptimizerNode getOriginalOptimizerNode()
```
    Gets the node from the optimizer DAG for which this plan candidate node was created.
    
    Returns:
    
    The optimizer's DAG node.
  - getProgramOperator
```
public Operator<?> getProgramOperator()
```
    Gets the program operator that this node represents in the plan.
    
    Returns:
    
    The program operator this node represents in the plan.
  - getNodeName
```
public String getNodeName()
```
    Gets the name of the plan node.
    
    Returns:
    
    The name of the plan node.
  - getMemoryConsumerWeight
```
public int getMemoryConsumerWeight()
```
  - getRelativeMemoryPerSubTask
```
public double getRelativeMemoryPerSubTask()
```
    Gets the memory dedicated to each sub-task for this node.
    
    Returns:
    
    The memory per task, in bytes.
  - setRelativeMemoryPerSubtask
```
public void setRelativeMemoryPerSubtask(double relativeMemoryPerSubtask)
```
    Sets the memory dedicated to each task for this node.
    
    Parameters:
    
    relativeMemoryPerSubtask - The relative memory per sub-task
  - getDriverStrategy
```
public DriverStrategy getDriverStrategy()
```
    Gets the driver strategy from this node. This determines for example for a match Pact whether to use a merge or a hybrid hash strategy.
    
    Returns:
    
    The driver strategy.
  - setDriverStrategy
```
public void setDriverStrategy(DriverStrategy newDriverStrategy)
```
    Sets the driver strategy for this node. Usually should not be changed.
    
    Parameters:
    
    newDriverStrategy - The driver strategy.
  - initProperties
```
public void initProperties(GlobalProperties globals,
                           LocalProperties locals)
```
  - getLocalProperties
```
public LocalProperties getLocalProperties()
```
    Gets the local properties from this PlanNode.
    
    Returns:
    
    The local properties.
  - getGlobalProperties
```
public GlobalProperties getGlobalProperties()
```
    Gets the global properties from this PlanNode.
    
    Returns:
    
    The global properties.
  - getNodeCosts
```
public Costs getNodeCosts()
```
    Gets the costs incurred by this node. The costs reflect also the costs incurred by the shipping strategies of the incoming connections.
    
    Returns:
    
    The node-costs, or null, if not yet set.
  - getCumulativeCosts
```
public Costs getCumulativeCosts()
```
    Gets the cumulative costs of this nose. The cumulative costs are the sum of the costs of this node and of all nodes in the subtree below this node.
    
    Returns:
    
    The cumulative costs, or null, if not yet set.
  - getCumulativeCostsShare
```
public Costs getCumulativeCostsShare()
```
  - setCosts
```
public void setCosts(Costs nodeCosts)
```
    Sets the basic cost for this node to the given value, and sets the cumulative costs to those costs plus the cost shares of all inputs (regular and broadcast).
    
    Parameters:
    
    nodeCosts - The already knows costs for this node (this cost a produces by a concrete OptimizerNode subclass.
  - setParallelism
```
public void setParallelism(int parallelism)
```
  - getParallelism
```
public int getParallelism()
```
  - getMinResources
```
public ResourceSpec getMinResources()
```
  - getPreferredResources
```
public ResourceSpec getPreferredResources()
```
  - getGuaranteedAvailableMemory
```
public long getGuaranteedAvailableMemory()
```
  - getBranchPlan
```
public Map<OptimizerNode,PlanNode> getBranchPlan()
```
  - getInputs
```
public abstract Iterable<Channel> getInputs()
```
  - getPredecessors
```
public abstract Iterable<PlanNode> getPredecessors()
```
    Description copied from interface: DumpableNode
    
    Gets an iterator over the predecessors.
    
    Specified by:
    
    getPredecessors in interface DumpableNode<PlanNode>
    
    Returns:
    
    An iterator over the predecessors.
  - setBroadcastInputs
```
public void setBroadcastInputs(List<NamedChannel> broadcastInputs)
```
    Sets a list of all broadcast inputs attached to this node.
  - getBroadcastInputs
```
public List<NamedChannel> getBroadcastInputs()
```
    Gets a list of all broadcast inputs attached to this node.
  - addOutgoingChannel
```
public void addOutgoingChannel(Channel channel)
```
    Adds a channel to a successor node to this node.
    
    Parameters:
    
    channel - The channel to the successor.
  - getOutgoingChannels
```
public List<Channel> getOutgoingChannels()
```
    Gets a list of all outgoing channels leading to successors.
    
    Returns:
    
    A list of all channels leading to successors.
  - updatePropertiesWithUniqueSets
```
public void updatePropertiesWithUniqueSets(Set<FieldSet> uniqueFieldCombinations)
```
  - getCandidateAtBranchPoint
```
public PlanNode getCandidateAtBranchPoint(OptimizerNode branchPoint)
```
  - setPruningMarker
```
public void setPruningMarker()
```
    Sets the pruning marker to true.
  - isPruneMarkerSet
```
public boolean isPruneMarkerSet()
```
    Checks whether the pruning marker was set.
    
    Returns:
    
    True, if the pruning marker was set, false otherwise.
  - isOnDynamicPath
```
public boolean isOnDynamicPath()
```
  - getCostWeight
```
public int getCostWeight()
```
  - hasDamOnPathDownTo
```
public abstract PlanNode.SourceAndDamReport hasDamOnPathDownTo(PlanNode source)
```
    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.
    
    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.
  - checkPartialSolutionPropertiesMet
```
public PlanNode.FeedbackPropertiesMeetRequirementsReport checkPartialSolutionPropertiesMet(PlanNode partialSolution,
                                                                                           GlobalProperties feedbackGlobal,
                                                                                           LocalProperties feedbackLocal)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getOptimizerNode
```
public OptimizerNode getOptimizerNode()
```
    Specified by:
    
    getOptimizerNode in interface DumpableNode<PlanNode>
  - getPlanNode
```
public PlanNode getPlanNode()
```
    Specified by:
    
    getPlanNode in interface DumpableNode<PlanNode>
  - getDumpableInputs
```
public Iterable<DumpableConnection<PlanNode>> getDumpableInputs()
```
    Specified by:
    
    getDumpableInputs in interface DumpableNode<PlanNode>

Back to Flink Website

Class PlanNode

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.flink.util.Visitable

Field Detail

template

outChannels

localProps

globalProps

branchPlan

nodeCosts

cumulativeCosts

Constructor Detail

PlanNode

Method Detail

mergeBranchPlanMaps

mergeBranchPlanMaps

getOriginalOptimizerNode

getProgramOperator

getNodeName

getMemoryConsumerWeight

getRelativeMemoryPerSubTask

setRelativeMemoryPerSubtask

getDriverStrategy

setDriverStrategy

initProperties

getLocalProperties

getGlobalProperties

getNodeCosts

getCumulativeCosts

getCumulativeCostsShare

setCosts

setParallelism

getParallelism

getMinResources

getPreferredResources

getGuaranteedAvailableMemory

getBranchPlan

getInputs

getPredecessors

setBroadcastInputs

getBroadcastInputs

addOutgoingChannel

getOutgoingChannels

updatePropertiesWithUniqueSets

getCandidateAtBranchPoint

setPruningMarker

isPruneMarkerSet

isOnDynamicPath

getCostWeight

hasDamOnPathDownTo

checkPartialSolutionPropertiesMet

toString

getOptimizerNode

getPlanNode

getDumpableInputs

Back to Flink Website