LvgApi (Lvg API, 2020 Version)

java.lang.Object
- gov.nih.nlm.nls.lvg.Api.LvgApi

```
public class LvgApi
extends java.lang.Object
```
This class provides an LVG API for users to setup flows by calling Mutate( ) method in flow component classes. The input of this API can be either an LexItem or a Vector of LexItem. The output is a Vector of LexItem.
All LVG API consists methods for three phases:
- PreProcess:
  Taking care of preparation work for using Lvg transformations. Such as initiating configuration data, declaring persistent files for trie, and establishing database connection.
- Process:
  This is the core program for user's applications. Users define and run their flow(s) in this process.
- PostProcess:
  Methods in this phases are used to cleanly close database connection, persistent files, etc..
History:
Version:

V-2020

Author:

NLM NLS Development Team

See Also:

Design Document

Constructor Summary

Constructors
Constructor and Description
`LvgApi()` Creates an LvgApi object and initiate related data (default).
`LvgApi(java.util.Hashtable<java.lang.String,java.lang.String> properties)` Creates an LvgApi object and initiate related data with properties to be overwritten in configuration.
`LvgApi(java.lang.String configFile)` Creates an LvgApi object and initiate related data (default), using a specified configuration file.
`LvgApi(java.lang.String configFile, java.util.Hashtable<java.lang.String,java.lang.String> properties)` Creates an LvgApi object and initiate related data, using a specified configuration file, with properties to be overwritten in configuration

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`CleanUp()` Close Lvg database connection and persistent tries.
`void`	`CloseConnection(java.sql.Connection conn)` Close the Lvg database connection.
`Configuration`	`GetConfiguration()` A method to get the configuration object
`java.util.Vector<java.lang.String>`	`GetConjunctionWords()` Get the list of conjunction words
`java.sql.Connection`	`GetConnection()` Get the Lvg database connection.
`RamTrie`	`GetDerivationTrie()` Get the ram trie object for Lvg derivation rules.
`java.util.Hashtable<java.lang.Character,java.lang.Character>`	`GetDiacriticMap()` Get the list of diacritics mapping list
`RamTrie`	`GetInflectionTrie()` Get the ram trie object for Lvg inflection rules.
`java.util.Hashtable<java.lang.Character,java.lang.String>`	`GetLigatureMap()` Get the list of ligatures mapping list
`int`	`GetMaxCodeLength()` Get the maximum length for metaphone code.
`int`	`GetMaxTerm()` Get the maximum terms for permuting uninflection words.
`java.util.Vector<java.lang.String>`	`GetNonInfoWords()` Get the list of non-info words
`java.util.Hashtable<java.lang.Character,java.lang.String>`	`GetNonStripMap()` Get the list of non-Strip mapping list
`RTrieTree`	`GetRemoveSTree()` Get the ram trie object for Lvg removeS tree.
`java.util.Vector<java.lang.String>`	`GetStopWords()` Get the list of stop words
`java.util.Hashtable<java.lang.Character,java.lang.String>`	`GetSymbolMap()` Get the list of symbols mapping list
`java.util.Hashtable<java.lang.Character,java.lang.String>`	`GetUnicodeMap()` Get the list of Unicode mapping list
`java.util.Hashtable<java.lang.Character,java.lang.Character>`	`GetUnicodeSynonymMap()` Get the list of Unicode synonym mapping list

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LvgApi
```
public LvgApi()
```
    Creates an LvgApi object and initiate related data (default). This constructor is consider as a preprocess method.
    CleanUp( ) method must be called to close Db connection after using a LvgApi object
  - LvgApi
```
public LvgApi(java.lang.String configFile)
```
    Creates an LvgApi object and initiate related data (default), using a specified configuration file.
    This constructor is consider as a preprocess method.
    CleanUp( ) method must be called to close Db connection after using a LvgApi object
    
    Parameters:
    
    configFile - the absolute path of the configuration file
  - LvgApi
```
public LvgApi(java.util.Hashtable<java.lang.String,java.lang.String> properties)
```
    Creates an LvgApi object and initiate related data with properties to be overwritten in configuration. This constructor is consider as a preprocess method.
    CleanUp( ) method must be called to close Db connection after using a LvgApi object
    
    Parameters:
    
    properties - properties to be overwrite in configuration
  - LvgApi
```
public LvgApi(java.lang.String configFile,
              java.util.Hashtable<java.lang.String,java.lang.String> properties)
```
    Creates an LvgApi object and initiate related data, using a specified configuration file, with properties to be overwritten in configuration
    CleanUp( ) method must be called to close Db connection after using a LvgApi object
    
    Parameters:
    
    configFile - the absolute path of the configuration file
    
    properties - properties to be overwrite in configuration
- Method Detail
  - GetConfiguration
```
public Configuration GetConfiguration()
```
    A method to get the configuration object
    
    Returns:
    
    Configuration
  - GetConnection
```
public java.sql.Connection GetConnection()
```
    Get the Lvg database connection. This method is a preprocess method.
    
    Returns:
    
    the JDBC connection to Lvg database
  - CloseConnection
```
public void CloseConnection(java.sql.Connection conn)
```
    Close the Lvg database connection.
    
    Parameters:
    
    conn - the JDBC connection to Lvg database
  - GetInflectionTrie
```
public RamTrie GetInflectionTrie()
```
    Get the ram trie object for Lvg inflection rules. This method is a preprocess method.
    
    Returns:
    
    Lvg inflection ram trie
  - GetDerivationTrie
```
public RamTrie GetDerivationTrie()
```
    Get the ram trie object for Lvg derivation rules. This method is a preprocess method.
    
    Returns:
    
    Lvg derivation ram trie
  - GetRemoveSTree
```
public RTrieTree GetRemoveSTree()
```
    Get the ram trie object for Lvg removeS tree. This method is a preprocess method.
    
    Returns:
    
    Lvg inflection ram trie
  - CleanUp
```
public void CleanUp()
```
    Close Lvg database connection and persistent tries. This methods must be called before exiting LvgApi. It is a method from postprocess.
  - GetMaxTerm
```
public int GetMaxTerm()
```
    Get the maximum terms for permuting uninflection words.
    
    Returns:
    
    the maximum terms for permuting uninflection words
  - GetMaxCodeLength
```
public int GetMaxCodeLength()
```
    Get the maximum length for metaphone code.
    
    Returns:
    
    the maximum length for metaphone code
  - GetStopWords
```
public java.util.Vector<java.lang.String> GetStopWords()
```
    Get the list of stop words
    
    Returns:
    
    A Vector of String - stop words list
  - GetNonInfoWords
```
public java.util.Vector<java.lang.String> GetNonInfoWords()
```
    Get the list of non-info words
    
    Returns:
    
    A Vector of String - non-info words list
  - GetConjunctionWords
```
public java.util.Vector<java.lang.String> GetConjunctionWords()
```
    Get the list of conjunction words
    
    Returns:
    
    A Vector of String - conjunction words list
  - GetDiacriticMap
```
public java.util.Hashtable<java.lang.Character,java.lang.Character> GetDiacriticMap()
```
    Get the list of diacritics mapping list
    
    Returns:
    
    a Hash table of diacritics mapping list
  - GetLigatureMap
```
public java.util.Hashtable<java.lang.Character,java.lang.String> GetLigatureMap()
```
    Get the list of ligatures mapping list
    
    Returns:
    
    a Hash table of ligatures mapping list
  - GetUnicodeSynonymMap
```
public java.util.Hashtable<java.lang.Character,java.lang.Character> GetUnicodeSynonymMap()
```
    Get the list of Unicode synonym mapping list
    
    Returns:
    
    a Hash table of Unicode synonym mapping list
  - GetSymbolMap
```
public java.util.Hashtable<java.lang.Character,java.lang.String> GetSymbolMap()
```
    Get the list of symbols mapping list
    
    Returns:
    
    a Hash table of symbols mapping list
  - GetUnicodeMap
```
public java.util.Hashtable<java.lang.Character,java.lang.String> GetUnicodeMap()
```
    Get the list of Unicode mapping list
    
    Returns:
    
    a Hash table of Unicode mapping list
  - GetNonStripMap
```
public java.util.Hashtable<java.lang.Character,java.lang.String> GetNonStripMap()
```
    Get the list of non-Strip mapping list
    
    Returns:
    
    a Hash table of nono-strip mapping list

Class LvgApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LvgApi

LvgApi

LvgApi

LvgApi

Method Detail

GetConfiguration

GetConnection

CloseConnection

GetInflectionTrie

GetDerivationTrie

GetRemoveSTree

CleanUp

GetMaxTerm

GetMaxCodeLength

GetStopWords

GetNonInfoWords

GetConjunctionWords

GetDiacriticMap

GetLigatureMap

GetUnicodeSynonymMap

GetSymbolMap

GetUnicodeMap

GetNonStripMap