au.id.pbw.hyfo.hyph
Class TreeElement

java.lang.Object
  au.id.pbw.hyfo.hyph.TreeElement

public class TreeElement
extends Object

A TreeElement is returned by a tree walker.

Author:

pbw

Constructor Summary

TreeElement(int node, int[] key)
Creates a new instance of TreeElement.

Method Summary

static TreeElement	get_END_ELEMENT() Gets the END element from a tree walker.
String	get_key(TernaryTreeDataStore formatter) Gets the key of this element, formatted by a TernaryTreeDataStore instance.
int	get_node() Gets the node number from the element.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeElement

public TreeElement(int node,
                   int[] key)

Creates a new instance of TreeElement.

Parameters:

node - the node number of the element.

key - the key of the node, as an array of codepoints.

Method Detail

get_node

public int get_node()

Gets the node number from the element.

Returns:

the node number.

get_key

public String get_key(TernaryTreeDataStore formatter)

Gets the key of this element, formatted by a TernaryTreeDataStore instance.

Parameters:

formatter - the TernaryTreeDataStore instance.

Returns:

the formatted key.

get_END_ELEMENT

public static TreeElement get_END_ELEMENT()

Gets the END element from a tree walker.

Returns:

the END element.