org.apache.flink.optimizer.plan

Class SourcePlanNode

java.lang.Object

org.apache.flink.optimizer.plan.PlanNode

org.apache.flink.optimizer.plan.SourcePlanNode

All Implemented Interfaces:

DumpableNode<PlanNode>, Visitable<PlanNode>

public class SourcePlanNode
extends PlanNode

Plan candidate node for data flow sources that have no input and no special strategies.

Nested Class Summary

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

PlanNode.FeedbackPropertiesMeetRequirementsReport, PlanNode.SourceAndDamReport

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
SourcePlanNode(DataSourceNode template, String nodeName) Constructs a new source candidate node that uses NONE as its local strategy.
SourcePlanNode(DataSourceNode template, String nodeName, GlobalProperties gprops, LocalProperties lprops)

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor<PlanNode> visitor) Contains the logic to invoke the visitor and continue the traversal.
DataSourceNode	getDataSourceNode()
Iterable<Channel>	getInputs()
Iterable<PlanNode>	getPredecessors() Gets an iterator over the predecessors.
TypeSerializerFactory<?>	getSerializer() Gets the serializer from this PlanNode.
PlanNode.SourceAndDamReport	hasDamOnPathDownTo(PlanNode source) Checks whether this node has a dam on the way down to the given source node.
void	setSerializer(TypeSerializerFactory<?> serializer) Sets the serializer for this PlanNode.

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

Constructor Detail

SourcePlanNode

public SourcePlanNode(DataSourceNode template,
                      String nodeName)

Constructs a new source candidate node that uses NONE as its local strategy.

Parameters:

template - The template optimizer node that this candidate is created for.

SourcePlanNode

public SourcePlanNode(DataSourceNode template,
                      String nodeName,
                      GlobalProperties gprops,
                      LocalProperties lprops)

Method Detail

getDataSourceNode

public DataSourceNode getDataSourceNode()

getSerializer

public TypeSerializerFactory<?> getSerializer()

Gets the serializer from this PlanNode.

Returns:

The serializer.

setSerializer

public void setSerializer(TypeSerializerFactory<?> serializer)

Sets the serializer for this PlanNode.

Parameters:

serializer - The serializer 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.