gov.nih.nlm.nls.stmt.Corpus

Class TreeNode

java.lang.Object

gov.nih.nlm.nls.stmt.Corpus.TreeNode

public class TreeNode
extends java.lang.Object

This class is the Java Object for node in retrieval corpus tree. It includes three fields: key|level|children.

History:

• SCR-0, chlu, 02-29-12, baseline - initial design

Version:

V-2013

Author:

NLM NLS Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	END_NODE_STR the name of end node, the end of a branch
static java.lang.String	ROOT_NODE_STR the name of root node, the starting node of the entire tree

Constructor Summary

Constructors

Constructor and Description
TreeNode() Create a tree node with default values
TreeNode(java.lang.String key) Create a tree node with specifying key
TreeNode(java.lang.String key, int level) Create a tree node with specifying key and level
TreeNode(java.lang.String key, int level, java.util.HashMap<java.lang.String,TreeNode> children) Create a tree node with specifying key, level, and children

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Check if two tree nodes are equals.
java.util.HashMap<java.lang.String,TreeNode>	GetChildren() Get children of the node
int	GetChildrenNo() Get the total number of children of the node
java.lang.String	GetDetailString() Convert the node to a string in detail
java.lang.String	GetKey() Get key of the node
int	GetLevel() Get level of the node
int	hashCode() the hashcode value of the tree node.
static void	main(java.lang.String[] args) Test driver for this class.
void	SetChildren(java.util.HashMap<java.lang.String,TreeNode> children) Set the value of children.
java.lang.String	ToString() Convert the node to a string in the format of [key|level|children number]

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_NODE_STR

public static final java.lang.String ROOT_NODE_STR

the name of root node, the starting node of the entire tree

See Also:

Constant Field Values

END_NODE_STR

public static final java.lang.String END_NODE_STR

the name of end node, the end of a branch

See Also:

Constant Field Values

Constructor Detail

TreeNode

public TreeNode()

Create a tree node with default values

TreeNode

public TreeNode(java.lang.String key)

Create a tree node with specifying key

Parameters:

key - key (word) of the tree node

TreeNode

public TreeNode(java.lang.String key,
        int level)

Create a tree node with specifying key and level

Parameters:

key - key (word) of the tree node

level - level of the tree node in the tree

TreeNode

public TreeNode(java.lang.String key,
        int level,
        java.util.HashMap<java.lang.String,TreeNode> children)

Create a tree node with specifying key, level, and children

Parameters:

key - key (word) of the tree node

level - level of the tree node in the tree

children - children of the tree node

Method Detail

SetChildren

public void SetChildren(java.util.HashMap<java.lang.String,TreeNode> children)

Set the value of children.

Parameters:

children - children of the node in HashMap format

GetKey

public java.lang.String GetKey()

Get key of the node

Returns:

the key of the node in String

GetLevel

public int GetLevel()

Get level of the node

Returns:

the level of the node in integer

GetChildren

public java.util.HashMap<java.lang.String,TreeNode> GetChildren()

Get children of the node

Returns:

the children of the node in HashMap format

GetChildrenNo

public int GetChildrenNo()

Get the total number of children of the node

Returns:

the number of children of the node

ToString

public java.lang.String ToString()

Convert the node to a string in the format of [key|level|children number]

Returns:

the string format of the node

GetDetailString

public java.lang.String GetDetailString()

Convert the node to a string in detail

Returns:

the detail format of the node in string

equals

public boolean equals(java.lang.Object obj)

Check if two tree nodes are equals.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the tree node object to be compared

Returns:

true if the tree nodes are the same, false, otherwise.

hashCode

public int hashCode()

the hashcode value of the tree node.

Overrides:

hashCode in class java.lang.Object

Returns:

the hashcode value of the tree node

main

public static void main(java.lang.String[] args)

Test driver for this class.

Parameters:

args - arguments of the test driver program