org.apache.pig.impl.plan

Class DotPlanDumper<E extends Operator,P extends OperatorPlan<E>,N extends Operator,S extends OperatorPlan<N>>

java.lang.Object

org.apache.pig.impl.plan.PlanDumper<E,P,S>

org.apache.pig.impl.plan.DotPlanDumper<E,P,N,S>

Direct Known Subclasses:

DotMRPrinter, DotPOPrinter, DotSparkPrinter

public class DotPlanDumper<E extends Operator,P extends OperatorPlan<E>,N extends Operator,S extends OperatorPlan<N>>
extends PlanDumper<E,P,S>

This class puts everything that is needed to dump a plan in a format readable by graphviz's dot algorithm. Out of the box it does not print any nested plans.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<Operator>	mMultiInputSubgraphs
protected java.util.Set<Operator>	mMultiOutputSubgraphs
protected java.util.Set<Operator>	mSubgraphs

Fields inherited from class org.apache.pig.impl.plan.PlanDumper

isVerbose, plan, ps

Constructor Summary

Constructors

Modifier	Constructor and Description
	DotPlanDumper(P plan, java.io.PrintStream ps)
protected	DotPlanDumper(P plan, java.io.PrintStream ps, boolean isSubGraph, java.util.Set<Operator> mSubgraphs, java.util.Set<Operator> mMultiInputSubgraphs, java.util.Set<Operator> mMultiOutputSubgraphs)

Method Summary

Modifier and Type	Method and Description
void	dump() This is the public interface.
protected void	dumpEdge(Operator op, Operator suc) Will be called to dump the edges of the plan.
protected void	dumpInvisibleOperators(E op)
protected void	dumpMultiInputNestedOperator(E op, MultiMap<E,S> plans) Will be called when an operator has nested plans, which are connected to one of the multiple inputs.
protected void	dumpMultiOutputNestedOperator(E op, java.util.Collection<S> plans) Will be called for nested operators, where the plans represent how the output of the operator is processed.
protected void	dumpNestedOperator(E op, java.util.Collection<S> plans) Will be called for nested operators.
protected void	dumpOperator(E op) Will be called to dump a simple operator
protected java.lang.String[]	getAttributes(E op) Used to generate the the attributes of a node
protected java.lang.String	getName(E op) Used to generate the label for an operator.
protected PlanDumper	makeDumper(S plan, java.io.PrintStream ps) makeDumper is a factory method.

Methods inherited from class org.apache.pig.impl.plan.PlanDumper

getMultiInputNestedPlans, getMultiOutputNestedPlans, getNestedPlans, isVerbose, join, setVerbose

Methods inherited from class java.lang.Object

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

Field Detail

mSubgraphs

protected java.util.Set<Operator> mSubgraphs

mMultiInputSubgraphs

protected java.util.Set<Operator> mMultiInputSubgraphs

mMultiOutputSubgraphs

protected java.util.Set<Operator> mMultiOutputSubgraphs

Constructor Detail

DotPlanDumper

public DotPlanDumper(P plan,
                     java.io.PrintStream ps)

DotPlanDumper

protected DotPlanDumper(P plan,
                        java.io.PrintStream ps,
                        boolean isSubGraph,
                        java.util.Set<Operator> mSubgraphs,
                        java.util.Set<Operator> mMultiInputSubgraphs,
                        java.util.Set<Operator> mMultiOutputSubgraphs)

Method Detail

dump

public void dump()

Description copied from class: PlanDumper

This is the public interface. Dump writes the plan and nested plans to the stream.

Overrides:

dump in class PlanDumper<E extends Operator,P extends OperatorPlan<E>,S extends OperatorPlan<N>>

dumpMultiInputNestedOperator

protected void dumpMultiInputNestedOperator(E op,
                                            MultiMap<E,S> plans)

Description copied from class: PlanDumper

Will be called when an operator has nested plans, which are connected to one of the multiple inputs.

Overrides:

dumpMultiInputNestedOperator in class PlanDumper<E extends Operator,P extends OperatorPlan<E>,S extends OperatorPlan<N>>

Parameters:

op - the nested operator

plans - a map of input operator to connected nested plan

dumpMultiOutputNestedOperator

protected void dumpMultiOutputNestedOperator(E op,
                                             java.util.Collection<S> plans)

Description copied from class: PlanDumper

Will be called for nested operators, where the plans represent how the output of the operator is processed.

Overrides:

dumpMultiOutputNestedOperator in class PlanDumper<E extends Operator,P extends OperatorPlan<E>,S extends OperatorPlan<N>>

Parameters:

op - the nested operator

plans - a collection of sub plans.

dumpNestedOperator

protected void dumpNestedOperator(E op,
                                  java.util.Collection<S> plans)

Description copied from class: PlanDumper

Will be called for nested operators. The operators are not specifically connected to any input or output operators of E

Overrides:

dumpNestedOperator in class PlanDumper<E extends Operator,P extends OperatorPlan<E>,S extends OperatorPlan<N>>

Parameters:

op - the nested operator

plans - a collection of sub plans.

dumpOperator

protected void dumpOperator(E op)

Description copied from class: PlanDumper

Will be called to dump a simple operator

Overrides:

dumpOperator in class PlanDumper<E extends Operator,P extends OperatorPlan<E>,S extends OperatorPlan<N>>

Parameters:

op - the operator to be dumped

dumpEdge

protected void dumpEdge(Operator op,
                        Operator suc)

Description copied from class: PlanDumper

Will be called to dump the edges of the plan. Each edge results in one call.

Overrides:

dumpEdge in class PlanDumper<E extends Operator,P extends OperatorPlan<E>,S extends OperatorPlan<N>>

Parameters:

op - tail of the edge

suc - head of the edge

makeDumper

protected PlanDumper makeDumper(S plan,
                                java.io.PrintStream ps)

Description copied from class: PlanDumper

makeDumper is a factory method. Used by subclasses to specify what dumper should handle the nested plan.

Overrides:

makeDumper in class PlanDumper<E extends Operator,P extends OperatorPlan<E>,S extends OperatorPlan<N>>

Parameters:

plan - Plan that the new dumper should handle

Returns:

the dumper for plan

getName

protected java.lang.String getName(E op)

Used to generate the label for an operator.

Parameters:

op - operator to dump

getAttributes

protected java.lang.String[] getAttributes(E op)

Used to generate the the attributes of a node

Parameters:

op - operator

dumpInvisibleOperators

protected void dumpInvisibleOperators(E op)