com.ibm.tivoli.maximo.report.expr

Class Node

java.lang.Object

com.ibm.tivoli.maximo.report.expr.Node

public class Node
extends java.lang.Object

In a parsed expression, a "node" is simply piece of data in the parse tree. Nodes have parents, children, and siblings. The purpose of the Node is to build an Abstract Parse Tree for an expression, where the node holds information such as where in the "string" the node was created, and what are the children, parent, and siblings in relation to this node.

Author:

sls

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Node.Type
static interface	Node.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<Node>	children
int	end
Node	parent
int	start
int	type
java.lang.Object	userData
static java.util.concurrent.atomic.AtomicInteger	UserNodeStart
java.lang.String	value
java.lang.StringBuilder	whitespace

Constructor Summary

Constructors

Constructor and Description
Node(int type)
Node(int type, java.lang.String value)
Node(Node parent, int type, java.lang.String value)

Method Summary

Methods

Modifier and Type	Method and Description
Node.Visitor.Status	accept(Node.Visitor vis) Apply a visitor to this node and it's children
void	addChild(Node node) Adds a child to node...
void	addChildren(java.util.List<Node> children2) Adds all the children to this node
Node	child(int i)
void	dump(java.io.PrintStream writer) Dump the node informatoin to a writer
void	dump(java.io.PrintWriter writer) Dump the node informatoin to a writer
Collector	find(Collector c) Like accept by returns the collector for convenience
Node	last() Return the last child node
Node	nextSibling() Find the sibling that is adjacent after us
Node	prevSibling() Find the sibling that is adjacent before us
void	removeChild(Node node) Removes a child from our children, if it exists.
java.lang.String	toFormattedString()
java.lang.String	toFormattedString(ToStringVisitor.Transformer transformer)
java.lang.String	toFormattedStringChildrenOnly()
java.lang.String	toFormattedStringChildrenOnly(ToStringVisitor.Transformer transformer)
java.lang.String	toString()
Node.Visitor.Status	visitChildren(Node.Visitor vis, Node parent) Applies the visitor to the children of the given Parent, but NOT the parent itself.

Methods inherited from class java.lang.Object

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

Field Detail

UserNodeStart

public static java.util.concurrent.atomic.AtomicInteger UserNodeStart

children

public java.util.List<Node> children

parent

public Node parent

type

public int type

start

public int start

end

public int end

value

public java.lang.String value

userData

public java.lang.Object userData

whitespace

public java.lang.StringBuilder whitespace

Constructor Detail

Node

public Node(int type)

Node

public Node(int type,
    java.lang.String value)

Node

public Node(Node parent,
    int type,
    java.lang.String value)

Method Detail

addChild

public void addChild(Node node)

Adds a child to node... If the child has a parent, then the child will be re-parented to this node.

Parameters:

node -

removeChild

public void removeChild(Node node)

Removes a child from our children, if it exists. If it doesn't exist, then nothing happens.

Parameters:

node -

accept

public Node.Visitor.Status accept(Node.Visitor vis)
                           throws java.rmi.RemoteException,
                                  MXException

Apply a visitor to this node and it's children

Parameters:

vis -

Throws:

java.rmi.RemoteException - , MXException to have it compatible with MXException types

MXException

visitChildren

public Node.Visitor.Status visitChildren(Node.Visitor vis,
                                Node parent)
                                  throws java.rmi.RemoteException,
                                         MXException

Applies the visitor to the children of the given Parent, but NOT the parent itself.

Parameters:

vis -

parent -

Returns:

Throws:

java.rmi.RemoteException

MXException

nextSibling

public Node nextSibling()

Find the sibling that is adjacent after us

Returns:

prevSibling

public Node prevSibling()

Find the sibling that is adjacent before us

Returns:

dump

public void dump(java.io.PrintStream writer)

Dump the node informatoin to a writer

Parameters:

writer -

dump

public void dump(java.io.PrintWriter writer)

Dump the node informatoin to a writer

Parameters:

writer -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toFormattedString

public java.lang.String toFormattedString()

toFormattedString

public java.lang.String toFormattedString(ToStringVisitor.Transformer transformer)

toFormattedStringChildrenOnly

public java.lang.String toFormattedStringChildrenOnly()

toFormattedStringChildrenOnly

public java.lang.String toFormattedStringChildrenOnly(ToStringVisitor.Transformer transformer)

child

public Node child(int i)

find

public Collector find(Collector c)
               throws java.rmi.RemoteException,
                      MXException

Like accept by returns the collector for convenience

Parameters:

c -

Returns:

Throws:

java.rmi.RemoteException

MXException

addChildren

public void addChildren(java.util.List<Node> children2)

Adds all the children to this node

Parameters:

children2 -

last

public Node last()

Return the last child node

Returns: