net.obsearch.example
Class SliceAST

java.lang.Object
  antlr.BaseAST
      net.obsearch.example.SliceAST

All Implemented Interfaces:

antlr.collections.AST, Serializable

public final class SliceAST
extends antlr.BaseAST

This class provides extra functionality required by tree edit distance algorithms and the like.

Since:

0.7

Author:

Arnoldo Jose Muller Molina

See Also:

Serialized Form

Field Summary

int	decendants Number of children this node has.
String	text The text of this node.

Fields inherited from class antlr.BaseAST

down, right

Constructor Summary

SliceAST()
Default constructor.

SliceAST(int t, String txt)
Initialize the node.

SliceAST(SliceAST t)
Clone the node with this constructor.

SliceAST(antlr.Token tok)
Initialize the node from a token.

Method Summary

List<SliceAST>	depthFirst()
protected void	depthFirstAux(LinkedList<SliceAST> res) Auxiliary function for depthFirst().
boolean	equals(antlr.collections.AST t)
boolean	equalsList(antlr.collections.AST t) Is t an exact structural and equals() match of this tree.
boolean	equalsTree(antlr.collections.AST t)
int	getDescendants() Returns the number of decendants of this node.
antlr.collections.AST	getFirstChild() Get the first child of this node; null if not children
SliceAST	getLeftmostChild() Get the leftmost child of this node.
antlr.collections.AST	getNextSibling() Get the next sibling in line after this one
int	getSize()
String	getText() Get the token text for this node.
int	getType() Get the token type for this node.
void	initialize(antlr.collections.AST t) Initialize the node from another node.
void	initialize(int t, String txt) Initialize the node.
void	initialize(antlr.Token tok) Initialize from the given token.
String	prettyPrint() Print out a child-sibling tree in LISP notation.
void	setText(String text_) Set the token text for this node.
void	setType(int ttype_) Set the token type for this node.
String	toFuriaChanTree()
void	updateDecendantInformation() Updates descendants information.
int	updateDecendantInformationAux() Updates descendants information.

Methods inherited from class antlr.BaseAST

addChild, decode, encode, equalsListPartial, equalsTreePartial, findAll, findAllPartial, getColumn, getLine, getNumberOfChildren, getTokenNames, removeChildren, setFirstChild, setNextSibling, setVerboseStringConversion, toString, toStringList, toStringTree, xmlSerialize, xmlSerializeNode, xmlSerializeRootClose, xmlSerializeRootOpen

Methods inherited from class java.lang.Object

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

Field Detail

decendants

public int decendants

Number of children this node has.

text

public String text

The text of this node.

Constructor Detail

SliceAST

public SliceAST()

Default constructor.

SliceAST

public SliceAST(int t,
                String txt)

Initialize the node.

Parameters:

t - Node type

txt - Node text

SliceAST

public SliceAST(antlr.Token tok)

Initialize the node from a token.

Parameters:

tok - The token to use as initializer.

SliceAST

public SliceAST(SliceAST t)

Clone the node with this constructor.

Parameters:

t - Another SliceAST

Method Detail

updateDecendantInformationAux

public final int updateDecendantInformationAux()

Updates descendants information.

Returns:

An integer that represents the number of children of this node.

updateDecendantInformation

public final void updateDecendantInformation()

Updates descendants information.

getDescendants

public final int getDescendants()

Returns the number of decendants of this node.

Returns:

The number of children of this node.

getSize

public final int getSize()

Returns:

The size of the Tree (includes the root node)

getText

public final String getText()

Get the token text for this node.

Specified by:

getText in interface antlr.collections.AST

Overrides:

getText in class antlr.BaseAST

Returns:

The text of the node.

getType

public final int getType()

Get the token type for this node.

Specified by:

getType in interface antlr.collections.AST

Overrides:

getType in class antlr.BaseAST

Returns:

The type of node

initialize

public final void initialize(int t,
                             String txt)

Initialize the node.

Specified by:

initialize in interface antlr.collections.AST

Specified by:

initialize in class antlr.BaseAST

Parameters:

t - Node type

txt - Node tag

initialize

public final void initialize(antlr.collections.AST t)

Initialize the node from another node.

Specified by:

initialize in interface antlr.collections.AST

Specified by:

initialize in class antlr.BaseAST

Parameters:

t - Another node.

initialize

public final void initialize(antlr.Token tok)

Initialize from the given token.

Specified by:

initialize in interface antlr.collections.AST

Specified by:

initialize in class antlr.BaseAST

Parameters:

tok - A token.

setText

public final void setText(String text_)

Set the token text for this node.

Specified by:

setText in interface antlr.collections.AST

Overrides:

setText in class antlr.BaseAST

Parameters:

text_ - The text to use.

setType

public final void setType(int ttype_)

Set the token type for this node. Currently ignored.

Specified by:

setType in interface antlr.collections.AST

Overrides:

setType in class antlr.BaseAST

Parameters:

ttype_ - Type to use

getLeftmostChild

public final SliceAST getLeftmostChild()

Get the leftmost child of this node.

Returns:

The leftmost child of this node.

prettyPrint

public final String prettyPrint()

Print out a child-sibling tree in LISP notation.

Returns:

A child-sibling tree in LISP notation

equalsList

public final boolean equalsList(antlr.collections.AST t)

Is t an exact structural and equals() match of this tree. The 'this' reference is considered the start of a sibling list.

Specified by:

equalsList in interface antlr.collections.AST

Overrides:

equalsList in class antlr.BaseAST

equalsTree

public final boolean equalsTree(antlr.collections.AST t)

Specified by:

equalsTree in interface antlr.collections.AST

Overrides:

equalsTree in class antlr.BaseAST

equals

public final boolean equals(antlr.collections.AST t)

Specified by:

equals in interface antlr.collections.AST

Overrides:

equals in class antlr.BaseAST

getFirstChild

public final antlr.collections.AST getFirstChild()

Get the first child of this node; null if not children

Specified by:

getFirstChild in interface antlr.collections.AST

Overrides:

getFirstChild in class antlr.BaseAST

getNextSibling

public final antlr.collections.AST getNextSibling()

Get the next sibling in line after this one

Specified by:

getNextSibling in interface antlr.collections.AST

Overrides:

getNextSibling in class antlr.BaseAST

depthFirst

public final List<SliceAST> depthFirst()

Returns:

A list of the nodes in depth first order

depthFirstAux

protected final void depthFirstAux(LinkedList<SliceAST> res)

Auxiliary function for depthFirst().

Parameters:

res - Where the result will be stored.

toFuriaChanTree

public final String toFuriaChanTree()