gov.nih.nlm.nls.lvg.Trie

Class RamTrie

java.lang.Object

gov.nih.nlm.nls.lvg.Trie.RamTrie

public final class RamTrie
extends java.lang.Object

This class establishes Trie from flat files and put them into Ram.

History:

Version:

V-2026

Author:

NLM NLS Development Team

See Also:

Design Document

Constructor Summary

Constructors

Constructor and Description
RamTrie(boolean isInflection, int minTermLength, java.lang.String dir, int minTrieStemLength) Create an object of LVG trie, using a flag to indicate using inflection or derivation trie.

Method Summary

Modifier and Type	Method and Description
CatInfl	GetCatInflByRules(java.lang.String term, long inCat, long inInfl) Get all possible categories and inflections for a term from trie rules.
java.util.Vector<CatInfl>	GetCatInflsByRules(java.lang.String term, long inCat, long inInfl) Get all possible categories and inflections for a term from trie rules.
java.util.Vector<RuleResult>	GetDerivationsByRules(java.lang.String term, long inCat, long inInfl, boolean showAll) Get derivation for a specific term from LVG trie rules.
java.util.Vector<RuleResult>	GetInflectedTermsByRules(java.lang.String term, long inCat, long inInfl, boolean showAll) Get inflected terms for a specific term from LVG trie rules.
int	GetMatchedNodeNum() Get the total number of nodes which match suffix
TrieTree	GetTrie() Get the object of trie tree.
java.util.Vector<RuleResult>	GetUninflectedTermsByRules(java.lang.String term, long inCat, long inInfl, boolean showAll) Get uninflected terms for a specific inflected term from LVG trie rules.
static void	main(java.lang.String[] args) This is the executable program for using LVG rule trie through RAM.
void	PrintResults(java.util.Vector<RuleResult> resultList) Print out a collection of trie ruleresult.
void	SetMinTermLength(int minTermLength) Set the minimum term length

Methods inherited from class java.lang.Object

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

Constructor Detail

RamTrie

public RamTrie(boolean isInflection,
               int minTermLength,
               java.lang.String dir,
               int minTrieStemLength)

Create an object of LVG trie, using a flag to indicate using inflection or derivation trie.

Parameters:

isInflection - true or false to indicate the persistent trie type as inflections or derivations.

minTermLength - minimum length of rule generated out term

dir - the top directory of LVG

minTrieStemLength - min. legal stem length in trie

Method Detail

GetUninflectedTermsByRules

public java.util.Vector<RuleResult> GetUninflectedTermsByRules(java.lang.String term,
                                                               long inCat,
                                                               long inInfl,
                                                               boolean showAll)

Get uninflected terms for a specific inflected term from LVG trie rules.

Parameters:

term - the term to be found for uninflections

inCat - the input category

inInfl - the input inflection

showAll - set false to get uninflected terms from a node that has matching suffix and ignore all other matching nodes above it in the same tree branch.
set true to get all uninflected terms from all nodes that has matching suffix in the entire tree.

Returns:

a collection (Vector) of RuleResult of uninflected terms

GetCatInflByRules

public CatInfl GetCatInflByRules(java.lang.String term,
                                 long inCat,
                                 long inInfl)

Get all possible categories and inflections for a term from trie rules.

Parameters:

term - the term to be found all possible categories and inflections

inCat - input categories

inInfl - input inflections

Returns:

a record of combined categories and inflections

GetCatInflsByRules

public java.util.Vector<CatInfl> GetCatInflsByRules(java.lang.String term,
                                                    long inCat,
                                                    long inInfl)

Get all possible categories and inflections for a term from trie rules.

Parameters:

term - the term to be found all possible categories and inflections

inCat - input categories

inInfl - input inflections

Returns:

a collection (Vector) of CatInfl, categories and inflections, from rules

GetInflectedTermsByRules

public java.util.Vector<RuleResult> GetInflectedTermsByRules(java.lang.String term,
                                                             long inCat,
                                                             long inInfl,
                                                             boolean showAll)

Get inflected terms for a specific term from LVG trie rules.

Parameters:

term - the term to be found for inflections

inCat - the input category

inInfl - the input inflection

showAll - set false to get inflected terms from a node that has matching suffix and ignore all other matching nodes above it in the same tree branch.
set true to get all inflected terms from all nodes that has matching suffix in the entire tree.

Returns:

a collection (Vector) of RuleResult of inflected terms

GetDerivationsByRules

public java.util.Vector<RuleResult> GetDerivationsByRules(java.lang.String term,
                                                          long inCat,
                                                          long inInfl,
                                                          boolean showAll)

Get derivation for a specific term from LVG trie rules.

Parameters:

term - the term to be found for derivations

inCat - the input category

inInfl - the input inflection

showAll - set false to get derivation from a node that has matching suffix and ignore all other matching nodes above it in the same tree branch.
set true to get all derivation from all nodes that has matching suffix in the entire tree.

Returns:

a collection (Vector) of RuleResult of derivations

PrintResults

public void PrintResults(java.util.Vector<RuleResult> resultList)

Print out a collection of trie ruleresult.

Parameters:

resultList - A vector of ruleResult to be print out.

GetTrie

public TrieTree GetTrie()

Get the object of trie tree.

Returns:

the trie tree is using

GetMatchedNodeNum

public int GetMatchedNodeNum()

Get the total number of nodes which match suffix

Returns:

A vector of ruleResult to be print out.

SetMinTermLength

public void SetMinTermLength(int minTermLength)

Set the minimum term length

Parameters:

minTermLength - minimum term length used in Morpology

main

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

This is the executable program for using LVG rule trie through RAM. In other words, this program read all information of LVG rules and load them up into RAM. The command of running this program is:
java2 RamTrie <term> <-i/-d> <-ps>
< term >: input term for testing
< -i >: mutate with all branch rules applied
< -p >: print details, rule, and exceptions
< -s >: mutate with all branch rules applied

Parameters:

args - arguments