gov.nih.nlm.nls.lvg.Trie

Class TrieTree

java.lang.Object

gov.nih.nlm.nls.lvg.Trie.TrieTree

public class TrieTree
extends java.lang.Object

This class creates an object of a trie tree. A trie trie include a tree structure consists of trie nodes.

History:

Version:

V-2026

Author:

NLM NLS Development Team

See Also:

Design Document

Constructor Summary

Constructors

Constructor and Description
TrieTree() Create an object of trie tree (default).
TrieTree(boolean wildCard) Create an object of trie tree, using a boolean flag of wild card.

Method Summary

Modifier and Type	Method and Description
java.util.Vector<TrieNode>	FindRule(java.lang.String inStr) Find a collection of TrieNodes which matches the suffix as a specified term.
TrieNode	GetRoot() Get the root trie node of the current tire tree.
void	LoadRulesFromFile(java.lang.String inFile, boolean reverse, boolean duplicateFlag) Read in LVG trie rules from a specified rule.
void	LoadRulesFromFile(java.lang.String dir, java.lang.String fName, boolean reverse, boolean duplicateFlag) Read in LVG trie rules from a specified rule.
static void	main(java.lang.String[] args) A test driver for this class.
void	PrintTrie(boolean details, boolean rulesFlag, boolean exceptionFlag) Print the detail informatin of current trie tree.
void	SetWildCard(boolean wildCard) Set the boolean flag of the wild card for a trie tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrieTree

public TrieTree()

Create an object of trie tree (default).

TrieTree

public TrieTree(boolean wildCard)

Create an object of trie tree, using a boolean flag of wild card.

Parameters:

wildCard - a boolean flag and is set true for using wildcard

Method Detail

SetWildCard

public void SetWildCard(boolean wildCard)

Set the boolean flag of the wild card for a trie tree.

Parameters:

wildCard - a boolean flag and is set true for using wildcard

LoadRulesFromFile

public void LoadRulesFromFile(java.lang.String dir,
                              java.lang.String fName,
                              boolean reverse,
                              boolean duplicateFlag)

Read in LVG trie rules from a specified rule.

Parameters:

dir - the path name of the directory of the LVG trie rule file

fName - the file name of the LVG trie rule file

reverse - true or false to load the rule in forward or backward

duplicateFlag - flag to send warning message when duplicate rule direction from the file. All rules in LVG trie are bi-directional.

LoadRulesFromFile

public void LoadRulesFromFile(java.lang.String inFile,
                              boolean reverse,
                              boolean duplicateFlag)

Read in LVG trie rules from a specified rule.

Parameters:

inFile - the full path of the LVG trie rule file

reverse - true or false to load the rule in forward or backward

duplicateFlag - flag to send warning message when duplicate rule direction from the file. All rules in LVG trie are bi-directional.

FindRule

public java.util.Vector<TrieNode> FindRule(java.lang.String inStr)

Find a collection of TrieNodes which matches the suffix as a specified term.

Parameters:

inStr - a string is used to find nodes with matching suffix

Returns:

A vecotr of TrieNode with rule matches the inStr

PrintTrie

public void PrintTrie(boolean details,
                      boolean rulesFlag,
                      boolean exceptionFlag)

Print the detail informatin of current trie tree.

Parameters:

details - true or false to print out details (traverse path) or not of the current trie tree

rulesFlag - true or false to print out all rules of the current trie tree

exceptionFlag - true or false to print out all exceptions of the current trie tree

GetRoot

public TrieNode GetRoot()

Get the root trie node of the current tire tree.

Returns:

the root trie node of the current tire tree

main

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

A test driver for this class.

Parameters:

args - arguments