Package org.teiid.query.optimizer.relational.plantree

Class PlanNode

java.lang.Object

org.teiid.query.optimizer.relational.plantree.PlanNode

public class PlanNode
extends Object

Constructor Summary

Constructors

Constructor	Description
PlanNode()

Method Summary

Modifier and Type	Method	Description
void	addAsParent(PlanNode node)	Add the node as this node's parent.
void	addChildren(Collection<PlanNode> otherChildren)
void	addFirstChild(PlanNode child)
void	addGroup(GroupSymbol groupID)
void	addGroups(Collection<GroupSymbol> newGroups)
void	addLastChild(PlanNode child)
PlanNode	clone()
List<SymbolMap>	getAllReferences()
float	getCardinality()
int	getChildCount()
List<PlanNode>	getChildren()
Set<ElementSymbol>	getCorrelatedReferenceElements()
List<SymbolMap>	getCorrelatedReferences()
List<SymbolMap>	getExportedCorrelatedReferences()
PlanNode	getFirstChild()
Set<GroupSymbol>	getGroups()
PlanNode	getLastChild()
PlanNode	getParent()
Object	getProperty(NodeConstants.Info propertyID)
List<SubqueryContainer<?>>	getSubqueryContainers()
int	getType()
boolean	hasBooleanProperty(NodeConstants.Info propertyKey)
boolean	hasCollectionProperty(NodeConstants.Info propertyID)	Indicates if there is a non-null and non-empty Collection value for the property key or not
boolean	hasProperty(NodeConstants.Info propertyID)	Indicates if there is a non-null value for the property key or not
String	nodeToString(boolean recusive)	Get the single node in full or recursive which considers modifications.
void	recordDebugAnnotation(String annotation, Object modelID, String resolution, AnalysisRecord record, QueryMetadataInterface metadata)
List<PlanNode>	removeAllChildren()
boolean	removeChild(PlanNode child)
PlanNode	removeFromParent()
Object	removeProperty(Object propertyID)
void	replaceChild(PlanNode child, PlanNode replacement)
Object	setProperty(NodeConstants.Info propertyID, Object value)
void	setType(int type)
String	toString()	Print plantree structure starting at this node

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanNode

public PlanNode()

Method Detail

getType

public int getType()

setType

public void setType(int type)

getParent

public PlanNode getParent()

getChildren

public List<PlanNode> getChildren()

removeAllChildren

public List<PlanNode> removeAllChildren()

getChildCount

public int getChildCount()

getFirstChild

public PlanNode getFirstChild()

getLastChild

public PlanNode getLastChild()

addFirstChild

public void addFirstChild(PlanNode child)

addLastChild

public void addLastChild(PlanNode child)

addChildren

public void addChildren(Collection<PlanNode> otherChildren)

removeFromParent

public PlanNode removeFromParent()

removeChild

public boolean removeChild(PlanNode child)

getProperty

public Object getProperty(NodeConstants.Info propertyID)

setProperty

public Object setProperty(NodeConstants.Info propertyID,
                          Object value)

removeProperty

public Object removeProperty(Object propertyID)

hasProperty

public boolean hasProperty(NodeConstants.Info propertyID)

Indicates if there is a non-null value for the property key or not

Parameters:

propertyID - one of the properties from NodeConstants

Returns:

whether this node has a non-null value for that property

hasCollectionProperty

public boolean hasCollectionProperty(NodeConstants.Info propertyID)

Indicates if there is a non-null and non-empty Collection value for the property key or not

Parameters:

propertyID - one of the properties from NodeConstants which is known to be a Collection object of some sort

Returns:

whether this node has a non-null and non-empty Collection value for that property

addGroup

public void addGroup(GroupSymbol groupID)

addGroups

public void addGroups(Collection<GroupSymbol> newGroups)

getGroups

public Set<GroupSymbol> getGroups()

toString

public String toString()

Print plantree structure starting at this node

Overrides:

toString in class Object

Returns:

String representing this node and all children under this node

nodeToString

public String nodeToString(boolean recusive)

Get the single node in full or recursive which considers modifications.

Returns:

String representing just this node

hasBooleanProperty

public boolean hasBooleanProperty(NodeConstants.Info propertyKey)

replaceChild

public void replaceChild(PlanNode child,
                         PlanNode replacement)

addAsParent

public void addAsParent(PlanNode node)

Add the node as this node's parent.

Parameters:

node -

getCorrelatedReferences

public List<SymbolMap> getCorrelatedReferences()

getAllReferences

public List<SymbolMap> getAllReferences()

getExportedCorrelatedReferences

public List<SymbolMap> getExportedCorrelatedReferences()

getCorrelatedReferenceElements

public Set<ElementSymbol> getCorrelatedReferenceElements()

getSubqueryContainers

public List<SubqueryContainer<?>> getSubqueryContainers()

getCardinality

public float getCardinality()

recordDebugAnnotation

public void recordDebugAnnotation(String annotation,
                                  Object modelID,
                                  String resolution,
                                  AnalysisRecord record,
                                  QueryMetadataInterface metadata)
                           throws QueryMetadataException,
                                  TeiidComponentException

Throws:

QueryMetadataException

TeiidComponentException

clone

public PlanNode clone()

Overrides:

clone in class Object