org.leialearns.logic.structure

Interface Structure

public interface Structure

Defines an object that contains the interaction history tree.

Method Summary

Methods

Modifier and Type	Method and Description
Node.Iterable	findNodes() Returns an iterable that contains all nodes in the tree.
Node.Iterable	findNodes(int depth) Returns an iterable that contains all nodes in the tree with the given depth.
Node	findOrCreateNode(DirectedSymbol.Iterable path) Finds or creates a node in the tree.
Node	findOrCreateNode(Symbol symbol, Direction direction) Finds or creates a node in the tree.
Node	findOrCreateNode(Symbol action, TypedIterable<DirectedSymbol> path) Finds or creates a node in the tree.
Node.Iterable	findRootNodes() Returns an iterable that contains the root nodes of this structure.
int	getMaxDepth() Returns the maximum depth of all nodes in the tree.
String	getURI() Returns the identifying URI of this structure.
void	logNodes() Logs all nodes in this structure.
void	markExtensible(Node node) Marks the given node as extensible.

Method Detail

getURI

String getURI()

Returns the identifying URI of this structure.

Returns:

The identifying URI of this structure

See Also:

Root.createInteractionContext(String, String, String, String)

findOrCreateNode

Node findOrCreateNode(DirectedSymbol.Iterable path)

Finds or creates a node in the tree.

Parameters:

path - The directed symbols that specify the path from the root of the tree to the requested node

Returns:

The requested node

findOrCreateNode

Node findOrCreateNode(Symbol action,
                    TypedIterable<DirectedSymbol> path)

Finds or creates a node in the tree.

Parameters:

action - The last action

path - The directed symbols that specify the path from node corresponding to the last action to the requested node

Returns:

The requested node

findOrCreateNode

Node findOrCreateNode(Symbol symbol,
                    Direction direction)

Finds or creates a node in the tree.

Parameters:

symbol - The symbol

direction - The direction

Returns:

The requested node

findNodes

Node.Iterable findNodes()

Returns an iterable that contains all nodes in the tree.

Returns:

An iterable that contains all nodes in the tree

findNodes

Node.Iterable findNodes(int depth)

Returns an iterable that contains all nodes in the tree with the given depth.

Parameters:

depth - The depth of the requested nodes

Returns:

An iterable that contains the requested nodes

findRootNodes

Node.Iterable findRootNodes()

Returns an iterable that contains the root nodes of this structure.

Returns:

An iterable that contains the root nodes of this structure

getMaxDepth

int getMaxDepth()

Returns the maximum depth of all nodes in the tree.

Returns:

The maximum depth of all nodes in the tree

markExtensible

void markExtensible(Node node)

Marks the given node as extensible.

Parameters:

node - The node to mark as extensible

logNodes

void logNodes()

Logs all nodes in this structure.