/**
* Generates specific XML (sometimes called 'attribute-oriented XML'). Like this:
*
* <pre>
* <Join condition="EMP.DEPTNO = DEPT.DEPTNO">
* <Project expr1="x + y" expr2="42">
* <TableAccess table="SALES.EMPS">
* </Join>
* </pre>
*
* @param rel Relational expression
* @param terms Names of the attributes of the plan
* @param values Values of the attributes of the plan
*/
private void explainSpecific(RelNode rel, String[] terms, Object[] values) {
RelNode[] inputs = rel.getInputs();
RexNode[] children = rel.getChildExps();
assert terms.length == (inputs.length + children.length + values.length)
: "terms.length="
+ terms.length
+ " inputs.length="
+ inputs.length
+ " children.length="
+ children.length
+ " values.length="
+ values.length;
String tagName = rel.getRelTypeName();
xmlOutput.beginBeginTag(tagName);
xmlOutput.attribute("id", rel.getId() + "");
int j = 0;
for (int i = 0; i < children.length; i++) {
RexNode child = children[i];
xmlOutput.attribute(terms[inputs.length + j++], child.toString());
}
for (int i = 0; i < values.length; i++) {
Object value = values[i];
if (value != null) {
xmlOutput.attribute(terms[inputs.length + j++], value.toString());
}
}
xmlOutput.endBeginTag(tagName);
level++;
for (int i = 0; i < inputs.length; i++) {
RelNode child = inputs[i];
child.explain(this);
}
level--;
}
public static String wrapperToXml(DOMWrapper wrapper, boolean ignorePcdata) {
try {
NodeDef node;
switch (wrapper.getType()) {
case DOMWrapper.ELEMENT:
node = new WrapperElementDef(wrapper, null, null);
break;
case DOMWrapper.CDATA:
node = new CdataDef(wrapper);
break;
case DOMWrapper.FREETEXT:
node = new TextDef(wrapper);
break;
case DOMWrapper.COMMENT:
node = new CommentDef(wrapper);
break;
default:
throw new Error(
"unknown node type " + wrapper.getType() + " while converting node to xml");
}
StringWriter sw = new StringWriter();
XMLOutput out = new XMLOutput(sw);
out.setIgnorePcdata(ignorePcdata);
out.setGlob(true);
node.displayXML(out, 0);
return sw.toString();
} catch (XOMException e) {
throw new Error("[" + e.toString() + "] while converting node to xml");
}
}
/**
* Generates generic XML (sometimes called 'element-oriented XML'). Like this:
*
* <blockquote>
*
* <code>
* <RelNode id="1" type="Join"><br/>
* <Property name="condition">EMP.DEPTNO =
* DEPT.DEPTNO</Property><br/>
* <Inputs><br/>
* <RelNode id="2" type="Project"><br/>
* <Property name="expr1">x +
* y</Property><br/>
* <Property
* name="expr2">45</Property><br/>
* </RelNode><br/>
* <RelNode id="3" type="TableAccess"><br/>
* <Property
* name="table">SALES.EMP</Property><br/>
* </RelNode><br/>
* </Inputs><br/>
* </RelNode><br/>
* </code>
*
* </blockquote>
*
* @param rel Relational expression
* @param terms Names of the attributes of the plan
* @param values Values of the attributes of the plan
*/
private void explainGeneric(RelNode rel, String[] terms, Object[] values) {
RelNode[] inputs = rel.getInputs();
RexNode[] children = rel.getChildExps();
assert terms.length == (inputs.length + children.length + values.length)
: "terms.length="
+ terms.length
+ " inputs.length="
+ inputs.length
+ " children.length="
+ children.length
+ " values.length="
+ values.length;
String relType = rel.getRelTypeName();
xmlOutput.beginBeginTag("RelNode");
xmlOutput.attribute("type", relType);
// xmlOutput.attribute("id", rel.getId() + "");
xmlOutput.endBeginTag("RelNode");
int j = 0;
for (int i = 0; i < children.length; i++) {
RexNode child = children[i];
xmlOutput.beginBeginTag("Property");
xmlOutput.attribute("name", terms[inputs.length + j++]);
xmlOutput.endBeginTag("Property");
xmlOutput.cdata(child.toString());
xmlOutput.endTag("Property");
}
for (int i = 0; i < values.length; i++) {
Object value = values[i];
if (value != null) {
xmlOutput.beginBeginTag("Property");
xmlOutput.attribute("name", terms[inputs.length + j++]);
xmlOutput.endBeginTag("Property");
xmlOutput.cdata(value.toString());
xmlOutput.endTag("Property");
}
}
xmlOutput.beginTag("Inputs", null);
level++;
for (int i = 0; i < inputs.length; i++) {
RelNode child = inputs[i];
child.explain(this);
}
level--;
xmlOutput.endTag("Inputs");
xmlOutput.endTag("RelNode");
}
public RelOptXmlPlanWriter(PrintWriter pw, SqlExplainLevel detailLevel) {
super(pw, detailLevel);
xmlOutput = new XMLOutput(this);
xmlOutput.setGlob(true);
xmlOutput.setCompact(false);
}