org.teiid.client.plan

Class PlanNode

java.lang.Object

org.teiid.client.plan.PlanNode

All Implemented Interfaces:

Externalizable, Serializable

public class PlanNode
extends Object
implements Externalizable

A PlanNode represents part of processing plan tree. For relational plans child PlanNodes may be either subqueries or nodes that feed tuples into the parent. For procedure plans child PlanNodes will be processing instructions, which can in turn contain other relational or procedure plans.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlanNode.Property A Property is a named value of a PlanNode that may be another PlanNode or a non-null list of values.

Constructor Summary

Constructors

Constructor and Description
PlanNode()
PlanNode(String name)

Method Summary

Modifier and Type	Method and Description
void	addProperty(String pname, List<String> value)
void	addProperty(String pname, PlanNode value)
void	addProperty(String pname, String value)
static PlanNode	fromXml(String planString)
String	getName()
PlanNode	getParent()
List<PlanNode.Property>	getProperties()
PlanNode.Property	getProperty(String pName)
void	readExternal(ObjectInput in)
String	toString()
String	toXml() Converts this PlanNode to XML.
String	toYaml()
protected void	visitNode(PlanNode node, int nodeLevel, boolean yaml, StringBuilder text)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanNode

public PlanNode()

PlanNode

public PlanNode(String name)

Method Detail

getName

public String getName()

getParent

public PlanNode getParent()

getProperties

public List<PlanNode.Property> getProperties()

addProperty

public void addProperty(String pname,
                        PlanNode value)

addProperty

public void addProperty(String pname,
                        List<String> value)

addProperty

public void addProperty(String pname,
                        String value)

toXml

public String toXml()

Converts this PlanNode to XML. See the JAXB bindings for the document form.

Returns:

an XML document of this PlanNode

fromXml

public static PlanNode fromXml(String planString)
                        throws XMLStreamException

Throws:

XMLStreamException

toString

public String toString()

Overrides:

toString in class Object

toYaml

public String toYaml()

visitNode

protected void visitNode(PlanNode node,
                         int nodeLevel,
                         boolean yaml,
                         StringBuilder text)

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

getProperty

public PlanNode.Property getProperty(String pName)