Package org.apache.calcite.rel.externalize

Class RelWriterImpl

java.lang.Object

org.apache.calcite.rel.externalize.RelWriterImpl

All Implemented Interfaces:

RelWriter

Direct Known Subclasses:

RelDotWriter, RelXmlWriter

public class RelWriterImpl
extends Object
implements RelWriter

Implementation of RelWriter.

Field Summary

Fields

Modifier and Type	Field	Description
protected final SqlExplainLevel	detailLevel
protected final boolean	expand
protected final PrintWriter	pw
protected final org.apache.calcite.avatica.util.Spacer	spacer
protected final boolean	withIdPrefix

Constructor Summary

Constructors

Constructor	Description
RelWriterImpl(PrintWriter pw)
RelWriterImpl(PrintWriter pw, SqlExplainLevel detailLevel, boolean withIdPrefix)
RelWriterImpl(PrintWriter pw, SqlExplainLevel detailLevel, boolean withIdPrefix, boolean expand)

Method Summary

Modifier and Type	Method	Description
RelWriter	done(RelNode node)	Writes the completed explanation.
boolean	expand()	Returns whether the writer needs to expand node's detail information when printing plan.
final void	explain(RelNode rel, List<Pair<String,@Nullable Object>> valueList)	Prints an explanation of a node, with a list of (term, value) pairs.
protected void	explain_(RelNode rel, List<Pair<String,@Nullable Object>> values)
SqlExplainLevel	getDetailLevel()	Returns detail level at which plan should be generated.
RelWriter	item(String term, @Nullable Object value)	Adds an attribute to the explanation of the current node.
String	simple()	Converts the collected terms and values to a string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.rel.RelWriter

input, itemIf, nest

Field Details

pw

protected final PrintWriter pw

detailLevel

protected final SqlExplainLevel detailLevel

withIdPrefix

protected final boolean withIdPrefix

expand

protected final boolean expand

spacer

protected final org.apache.calcite.avatica.util.Spacer spacer

Constructor Details

RelWriterImpl

public RelWriterImpl(PrintWriter pw)

RelWriterImpl

public RelWriterImpl(PrintWriter pw,
 SqlExplainLevel detailLevel,
 boolean withIdPrefix)

RelWriterImpl

public RelWriterImpl(PrintWriter pw,
 SqlExplainLevel detailLevel,
 boolean withIdPrefix,
 boolean expand)

Method Details

explain_

protected void explain_(RelNode rel,
 List<Pair<String,@Nullable Object>> values)

explain

public final void explain(RelNode rel,
 List<Pair<String,@Nullable Object>> valueList)

Description copied from interface: RelWriter

Prints an explanation of a node, with a list of (term, value) pairs.

The term-value pairs are generally gathered by calling RelNode.explain(RelWriter). Each sub-class of RelNode calls RelWriter.input(String, org.apache.calcite.rel.RelNode) and RelWriter.item(String, Object) to declare term-value pairs.

Specified by:

explain in interface RelWriter

Parameters:

rel - Relational expression

valueList - List of term-value pairs

getDetailLevel

public SqlExplainLevel getDetailLevel()

Description copied from interface: RelWriter

Returns detail level at which plan should be generated.

Specified by:

getDetailLevel in interface RelWriter

item

public RelWriter item(String term,
 @Nullable Object value)

Description copied from interface: RelWriter

Adds an attribute to the explanation of the current node.

Specified by:

item in interface RelWriter

Parameters:

term - Term for attribute, e.g. "joinType"

value - Attribute value

done

public RelWriter done(RelNode node)

Description copied from interface: RelWriter

Writes the completed explanation.

Specified by:

done in interface RelWriter

simple

public String simple()

Converts the collected terms and values to a string. Does not write to the parent writer.

expand

public boolean expand()

Description copied from interface: RelWriter

Returns whether the writer needs to expand node's detail information when printing plan. For example, LogicalSort(sort0=[$0], dir0=[ASC]) will be expanded to LogicalSort(sort0=[$0], dir0=[ASC-nulls-last]).

Specified by:

expand in interface RelWriter