org.apache.calcite.rel.externalize

Class RelXmlWriter

java.lang.Object

org.apache.calcite.rel.externalize.RelWriterImpl

org.apache.calcite.rel.externalize.RelXmlWriter

All Implemented Interfaces:

RelWriter

public class RelXmlWriter
extends RelWriterImpl

Callback for a relational expression to dump in XML format.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	generic
private XmlOutput	xmlOutput

Fields inherited from class org.apache.calcite.rel.externalize.RelWriterImpl

pw, spacer

Constructor Summary

Constructors

Constructor and Description
RelXmlWriter(PrintWriter pw, SqlExplainLevel detailLevel)

Method Summary

Modifier and Type	Method and Description
protected void	explain_(RelNode rel, List<Pair<String,Object>> values)
private void	explainGeneric(RelNode rel, List<Pair<String,Object>> values) Generates generic XML (sometimes called 'element-oriented XML').
private void	explainSpecific(RelNode rel, List<Pair<String,Object>> values) Generates specific XML (sometimes called 'attribute-oriented XML').

Methods inherited from class org.apache.calcite.rel.externalize.RelWriterImpl

done, explain, getDetailLevel, input, item, itemIf, nest, simple

Methods inherited from class java.lang.Object

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

Field Detail

xmlOutput

private final XmlOutput xmlOutput

generic

boolean generic

Constructor Detail

RelXmlWriter

public RelXmlWriter(PrintWriter pw,
                    SqlExplainLevel detailLevel)

Method Detail

explain_

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

Overrides:

explain_ in class RelWriterImpl

explainGeneric

private void explainGeneric(RelNode rel,
                            List<Pair<String,Object>> values)

Generates generic XML (sometimes called 'element-oriented XML'). Like this:

<RelNode id="1" type="Join">
<Property name="condition">EMP.DEPTNO = DEPT.DEPTNO</Property>
<Inputs>
<RelNode id="2" type="Project">
<Property name="expr1">x + y</Property>
<Property name="expr2">45</Property>
</RelNode>
<RelNode id="3" type="TableAccess">
<Property name="table">SALES.EMP</Property>
</RelNode>
</Inputs>
</RelNode>

Parameters:

rel - Relational expression

values - List of term-value pairs

explainSpecific

private void explainSpecific(RelNode rel,
                             List<Pair<String,Object>> values)

Generates specific XML (sometimes called 'attribute-oriented XML'). Like this:

 <Join condition="EMP.DEPTNO = DEPT.DEPTNO">
   <Project expr1="x + y" expr2="42">
   <TableAccess table="SALES.EMPS">
 </Join>
 

Parameters:

rel - Relational expression

values - List of term-value pairs