Package gov.nih.nlm.nls.lvg.Trie

Provides the classes necessary to generate inflections, uninflections, and derivations using LVG rules tries.

See: Description

Class Summary

Class	Description
InflectionRule	This class creates an object of LVG inflection rule, using a string format of a rule.
PersistentExceptionNode	This class creates an object of rule's exception for persistent data.
PersistentList	This class provides a mechanism for persistent linked list.
PersistentListNode	This class creates an object of persistent list node.
PersistentRuleNode	This class creates an object of the rule node for persistent data.
PersistentTree	This class provides a mechanism of persistent tree.
PersistentTreeNode	This class creates an object of persistent tree node.
PersistentTrie	This class provides API for using LVG persistent trie rules.
PersistentTrieNode	This class creates an object of persistent trie node.
PersistentTrieTree	This class establishes the Persistent files (Random Access File) from a flat file.
RamTrie	This class establishes Trie from flat files and put them into Ram.
RTrieNode	This class creates object of a reverse trie node.
RTrieTree	This class creates an object of a reverse trie tree.
RuleException	This class creates an object of exception to a rule.
RuleResult	This class creates an object for the result after applying a rule.
RuleResultComparator<T>	This class provides methods to compare rule results.
RWildCard	This class creates an object of wild cards for reverse trie.
TrieNode	This class creates object of a trie node.
TrieTree	This class creates an object of a trie tree.
WildCard	This class creates an object of wild cards for trie.

Package gov.nih.nlm.nls.lvg.Trie Description

Provides the classes necessary to generate inflections, uninflections, and derivations using LVG rules tries. This package provides a persistent data storing and retrieving mechanism for the application of LVG rules. The original design concept is from previous version of LVG.

Features

Features of this package are described as follows:

• Stores Lvg rule information in files instead of RAM.

• Provides random access ability for quick retrieval.

Usage

• Inflection & Uninflection:
  1. Initiate a persistent trie object
     PersistentTrie trie = new PersistentTrie(true);
  2. Retrieve inflections for a String str
     Vector inflections = trie.GetInflectedTermsByRules(inStr, true);
  3. Retrieve uninflections for a String str
     Vector uninflections = trie.GetUninflectedTermsByRules(inStr, true);
  4. Close the trie
     trie.Close();
• Derivation:
  1. Initiate a persistent trie object
     PersistentTrie trie = new PersistentTrie(false);
  2. Retrieve derivations for a String str
     Vector derivations = trie.GetDerivationsByRules(inStr, true);
  3. Close the trie
     trie.Close();

Files
The flat file for these LVG rules are under $LVG_DIR/data/rules/. They are:

• im.rul: rules of inflections and uninflections
• plural.rul: rules of plural, used by im.rul
• verbinfl.rul: rules of verb inflections, used by im.rul
• dm.rul: rules of derivations

The above files are read in by LVG trie pre-process programs and then stored as binary files for LVG trie system to retrieve later. These binary files are generated before LVG is distributed and are listed as follows:

• trieI.data: data for trie tree of inflection
• ruleI.data: data of inflection rules
• exceptionI.data: data of exceptions on inflection rules
  
  
• trieD.data: data for trie tree of derivation rules
• ruleD.data: data of derivation rules
• exceptionD.data: data of exceptions on derivation rules

Related Documents

• Design Document

Since:

2002