org.leialearns.logic.structure

Interface Node

All Superinterfaces:

Comparable<Node>

public interface Node
extends Comparable<Node>

Defines the objects that represent nodes in the interaction history tree.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Node.Iterable Represents a NearIterable that returns node items.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Node other)
Node.Iterable	findChildren() Returns an iterable that contains the child nodes of this node.
Node	findOrCreate(Symbol symbol, Direction direction) Finds or creates a child node of this node with the given symbol and direction.
int	getDepth() Returns the depth of the node in the tree.
Direction	getDirection() Returns the direction associated with this node.
boolean	getExtensible() Returns a flag that indicates whether the tree may be extended beyond this node.
Node	getParent() Returns the parent node of this node.
Structure	getStructure() Returns the structure that contains this node.
Symbol	getSymbol() Returns the symbol associated with this node.
boolean	isPrefixOf(Node other) Returns a flag that indicates whether this node is a prefix of the given node
void	showPath(StringBuilder builder) Appends a representation of the path to this node to the given string builder.
void	showPathReverse(StringBuilder builder) Appends a representation of the path to this node to the given string builder.

Method Detail

getStructure

Structure getStructure()

Returns the structure that contains this node.

Returns:

The structure that contains this node

getParent

Node getParent()

Returns the parent node of this node. In an interaction history tree, the root of the tree represents the present. The nodes of the first level represent the last action of the LEIA system and the farther the nodes are from the root of the tree, the farther in the past the corresponding symbols are to be found in the current state of the encounter.

Returns:

The parent node of this node

See Also:

Encounter

findChildren

Node.Iterable findChildren()

Returns an iterable that contains the child nodes of this node.

Returns:

An iterable that contains the child nodes of this node

getSymbol

Symbol getSymbol()

Returns the symbol associated with this node.

Returns:

The symbol associated with this node

getDirection

Direction getDirection()

Returns the direction associated with this node.

Returns:

The direction associated with this node

getDepth

int getDepth()

Returns the depth of the node in the tree.

Returns:

The depth of the node in the tree

getExtensible

boolean getExtensible()

Returns a flag that indicates whether the tree may be extended beyond this node.

Returns:

true if the tree may be extended beyond this node; false otherwise

findOrCreate

Node findOrCreate(Symbol symbol,
                Direction direction)

Finds or creates a child node of this node with the given symbol and direction.

Parameters:

symbol - The symbol associated with the requested node

direction - The direction associated with the requested node

Returns:

The requested child node

Throws:

IllegalStateException - if this node is not extensible

isPrefixOf

boolean isPrefixOf(Node other)

Returns a flag that indicates whether this node is a prefix of the given node

Parameters:

other - The node to compare against

Returns:

true if this node is a prefix of the other node; false otherwise

showPath

void showPath(StringBuilder builder)

Appends a representation of the path to this node to the given string builder. The root node is located at the front of the representation.

Parameters:

builder - The builder to use

showPathReverse

void showPathReverse(StringBuilder builder)

Appends a representation of the path to this node to the given string builder. The root node is located at the end of the representation. This order is often the most intuitive, because it lists symbols from past to present instead of the other way around.

Parameters:

builder - The builder to use

compareTo

int compareTo(Node other)

Specified by:

compareTo in interface Comparable<Node>