Lvg ^Java, 2011 Release
APIs Specification

This document is the API specification for the Lexical Tools Java version, 2011 release.

See:
Description

Packages

gov.nih.nlm.nls.lvg.Api	This package provides Java APIs classes.
gov.nih.nlm.nls.lvg.CmdLineSyntax	Provides Java classes necessary to create a command line system.
gov.nih.nlm.nls.lvg.Db	Provides a higher level interface to LVG database.
gov.nih.nlm.nls.lvg.Flows	This package provides API of all lvg flow components.
gov.nih.nlm.nls.lvg.Lib	Contains LVG general library classes of BitMaskBase, Category, Gender, Inflection, Configuration, CombineRecords, OutputFilter, Flow, GlobalBehavior, LexItem, LexItemComparator.
gov.nih.nlm.nls.lvg.Trie	Provides the classes necessary to generate inflections, uninflections, and derivations using LVG rules tries.
gov.nih.nlm.nls.lvg.Util	Contains LVG general utility classes of comparators, Bit operations, Case, In, Out, Strip operations, token operation, Char, Str, and Word.

This document is the API specification for the Lexical Tools Java version, 2011 release. This API is packed in lvg2011api.jar and lvg2011dist.jar. There are seven Java packages:

• gov.nih.nlm.nls.lvg.Api
• gov.nih.nlm.nls.lvg.CmdLineSyntax
• gov.nih.nlm.nls.lvg.Db
• gov.nih.nlm.nls.lvg.Flows
• gov.nih.nlm.nls.lvg.Lib
• gov.nih.nlm.nls.lvg.Trie
• gov.nih.nlm.nls.lvg.Util

The packages of gov.nih.nlm.nls.lvg.Api and gov.nih.nlm.nls.lvg.Flows are the most useful packages for Lexical Tools users and should be paid more attention to. The other five packages are used as supporting packages for Lexical Tools to work. End users may skip these five packages.