org.apache.beam.sdk.util.construction.renderer

Class PipelineDotRenderer

java.lang.Object

org.apache.beam.sdk.util.construction.renderer.PipelineDotRenderer

All Implemented Interfaces:

Pipeline.PipelineVisitor

public class PipelineDotRenderer
extends java.lang.Object
implements Pipeline.PipelineVisitor

A DOT renderer for BEAM Pipeline DAG.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.Pipeline.PipelineVisitor

Pipeline.PipelineVisitor.CompositeBehavior, Pipeline.PipelineVisitor.Defaults

Method Summary

Modifier and Type	Method and Description
Pipeline.PipelineVisitor.CompositeBehavior	enterCompositeTransform(TransformHierarchy.Node node) Called for each composite transform after all topological predecessors have been visited but before any of its component transforms.
void	enterPipeline(Pipeline p) Called before visiting anything values or transforms, as many uses of a visitor require access to the Pipeline object itself.
void	leaveCompositeTransform(TransformHierarchy.Node node) Called for each composite transform after all of its component transforms and their outputs have been visited.
void	leavePipeline(Pipeline pipeline) Called when all values and transforms in a Pipeline have been visited.
static java.lang.String	toDotString(Pipeline pipeline)
static java.lang.String	toDotString(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline)
void	visitPrimitiveTransform(TransformHierarchy.Node node) Called for each primitive transform after all of its topological predecessors and inputs have been visited.
void	visitValue(PValue value, TransformHierarchy.Node producer) Called for each value after the transform that produced the value has been visited.

Methods inherited from class java.lang.Object

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

Method Detail

toDotString

public static java.lang.String toDotString(Pipeline pipeline)

toDotString

public static java.lang.String toDotString(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline pipeline)

enterPipeline

public void enterPipeline(Pipeline p)

Description copied from interface: Pipeline.PipelineVisitor

Called before visiting anything values or transforms, as many uses of a visitor require access to the Pipeline object itself.

Specified by:

enterPipeline in interface Pipeline.PipelineVisitor

leavePipeline

public void leavePipeline(Pipeline pipeline)

Description copied from interface: Pipeline.PipelineVisitor

Called when all values and transforms in a Pipeline have been visited.

Specified by:

leavePipeline in interface Pipeline.PipelineVisitor

enterCompositeTransform

public Pipeline.PipelineVisitor.CompositeBehavior enterCompositeTransform(TransformHierarchy.Node node)

Description copied from interface: Pipeline.PipelineVisitor

Called for each composite transform after all topological predecessors have been visited but before any of its component transforms.

The return value controls whether or not child transforms are visited.

Specified by:

enterCompositeTransform in interface Pipeline.PipelineVisitor

leaveCompositeTransform

public void leaveCompositeTransform(TransformHierarchy.Node node)

Description copied from interface: Pipeline.PipelineVisitor

Called for each composite transform after all of its component transforms and their outputs have been visited.

Specified by:

leaveCompositeTransform in interface Pipeline.PipelineVisitor

visitPrimitiveTransform

public void visitPrimitiveTransform(TransformHierarchy.Node node)

Description copied from interface: Pipeline.PipelineVisitor

Called for each primitive transform after all of its topological predecessors and inputs have been visited.

Specified by:

visitPrimitiveTransform in interface Pipeline.PipelineVisitor

visitValue

public void visitValue(PValue value,
                       TransformHierarchy.Node producer)

Description copied from interface: Pipeline.PipelineVisitor

Called for each value after the transform that produced the value has been visited.

Specified by:

visitValue in interface Pipeline.PipelineVisitor