org.teiid.client.plan
Class PlanNode

java.lang.Object
  org.teiid.client.plan.PlanNode

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class PlanNode
extends java.lang.Object
implements java.io.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

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

PlanNode()

PlanNode(java.lang.String name)

Method Summary

void	addProperty(java.lang.String pname, java.util.List<java.lang.String> value)
void	addProperty(java.lang.String pname, PlanNode value)
void	addProperty(java.lang.String pname, java.lang.String value)
java.lang.String	getName()
PlanNode	getParent()
java.util.List<PlanNode.Property>	getProperties()
void	readExternal(java.io.ObjectInput in)
java.lang.String	toString()
java.lang.String	toXml() Converts this PlanNode to XML.
protected void	visitNode(PlanNode node, int nodeLevel, java.lang.StringBuilder text)
void	writeExternal(java.io.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(java.lang.String name)

Method Detail

getName

public java.lang.String getName()

getParent

public PlanNode getParent()

getProperties

public java.util.List<PlanNode.Property> getProperties()

addProperty

public void addProperty(java.lang.String pname,
                        PlanNode value)

addProperty

public void addProperty(java.lang.String pname,
                        java.util.List<java.lang.String> value)

addProperty

public void addProperty(java.lang.String pname,
                        java.lang.String value)

toXml

public java.lang.String toXml()

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

Returns:

an XML document of this PlanNode

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

visitNode

protected void visitNode(PlanNode node,
                         int nodeLevel,
                         java.lang.StringBuilder text)

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException