org.apache.pig.newplan

Class DotPlanDumper

java.lang.Object

org.apache.pig.newplan.PlanDumper

org.apache.pig.newplan.DotPlanDumper

Direct Known Subclasses:

DotLOPrinter

public class DotPlanDumper
extends PlanDumper

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.newplan.PlanDumper

isVerbose, plan, ps

Constructor Summary

Constructors

Modifier	Constructor and Description
	DotPlanDumper(BaseOperatorPlan plan, java.io.PrintStream ps)
protected	DotPlanDumper(BaseOperatorPlan 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(Operator op)
protected void	dumpMultiInputNestedOperator(Operator op, MultiMap<Operator,BaseOperatorPlan> plans) Will be called when an operator has nested plans, which are connected to one of the multiple inputs.
protected void	dumpMultiOutputNestedOperator(Operator op, java.util.Collection<BaseOperatorPlan> plans) Will be called for nested operators, where the plans represent how the output of the operator is processed.
protected void	dumpNestedOperator(Operator op, java.util.Collection<BaseOperatorPlan> plans) Will be called for nested operators.
protected void	dumpOperator(Operator op) Will be called to dump a simple operator
protected java.lang.String[]	getAttributes(Operator op) Used to generate the the attributes of a node
protected java.lang.String	getName(Operator op) Used to generate the label for an operator.
protected PlanDumper	makeDumper(BaseOperatorPlan plan, java.io.PrintStream ps) makeDumper is a factory method.
protected boolean	reverse(BaseOperatorPlan plan)

Methods inherited from class org.apache.pig.newplan.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(BaseOperatorPlan plan,
                     java.io.PrintStream ps)

DotPlanDumper

protected DotPlanDumper(BaseOperatorPlan 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

dumpMultiInputNestedOperator

protected void dumpMultiInputNestedOperator(Operator op,
                                            MultiMap<Operator,BaseOperatorPlan> 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

Parameters:

op - the nested operator

plans - a map of input operator to connected nested plan

dumpMultiOutputNestedOperator

protected void dumpMultiOutputNestedOperator(Operator op,
                                             java.util.Collection<BaseOperatorPlan> 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

Parameters:

op - the nested operator

plans - a collection of sub plans.

dumpNestedOperator

protected void dumpNestedOperator(Operator op,
                                  java.util.Collection<BaseOperatorPlan> 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

Parameters:

op - the nested operator

plans - a collection of sub plans.

dumpOperator

protected void dumpOperator(Operator op)

Description copied from class: PlanDumper

Will be called to dump a simple operator

Overrides:

dumpOperator in class PlanDumper

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

Parameters:

op - tail of the edge

suc - head of the edge

makeDumper

protected PlanDumper makeDumper(BaseOperatorPlan 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

Parameters:

plan - Plan that the new dumper should handle

Returns:

the dumper for plan

getName

protected java.lang.String getName(Operator op)

Used to generate the label for an operator.

Parameters:

op - operator to dump

getAttributes

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

Used to generate the the attributes of a node

Parameters:

op - operator

dumpInvisibleOperators

protected void dumpInvisibleOperators(Operator op)

reverse

protected boolean reverse(BaseOperatorPlan plan)