gov.nih.nlm.nls.stmt.Synonym

Class Synonyms

java.lang.Object

gov.nih.nlm.nls.stmt.Synonym.Synonyms

public class Synonyms
extends java.lang.Object

This program is used to read normalized term (key) and synonyms (values) from normTermSynonym.data (no duplicates) and load in to a hashtable Hashtable<String, HashSet<String>>. It is a table of one key -> many values Thsi class also provides method to find synonyms. This program can be replaced by database.

History:

Version:

V-2014

Author:

NLM NLS Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEPTH_NO_LIMIT unlimited recursive depth

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Vector<java.lang.String>	FindRecursiveSynonyms(java.lang.String term, gov.nih.nlm.nls.lvg.Api.LvgApi lvgApi, java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable, int maxDepth) Find unique recursive synonyms for a term from a synonym table.
static java.util.Vector<java.lang.String>	FindSortedRecursiveSynonyms(java.lang.String term, gov.nih.nlm.nls.lvg.Api.LvgApi lvgApi, java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable, int maxDepth) Find sorted unique recursive synonyms for a term from a synonym table.
static java.util.Vector<java.lang.String>	FindSortedSynonyms(java.lang.String term, gov.nih.nlm.nls.lvg.Api.LvgApi lvgApi, java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable) Find sorted unique synonyms for a term from a synonym table.
static java.util.Vector<java.lang.String>	FindSynonyms(java.lang.String term, gov.nih.nlm.nls.lvg.Api.LvgApi lvgApi, java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable) Find unique synonyms for a term from a synonym table.
static java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>>	GetHashTable(java.lang.String inFile, boolean verboseFlag, int lineNum) Get the the key-values table of norm-term|synonym by loading from a file.
static java.util.Vector<java.lang.String>	GetSortedSynonyms(java.lang.String normTerm, java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable) Find sorted unique synonyms for a normalized term from a synonym table.
static java.util.Vector<java.lang.String>	GetSynonyms(java.lang.String normTerm, java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable) Find unique synonyms for a normalized term from a synonym table.

Methods inherited from class java.lang.Object

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

Field Detail

DEPTH_NO_LIMIT

public static final int DEPTH_NO_LIMIT

unlimited recursive depth

See Also:

Constant Field Values

Method Detail

FindSortedSynonyms

public static java.util.Vector<java.lang.String> FindSortedSynonyms(java.lang.String term,
                                                    gov.nih.nlm.nls.lvg.Api.LvgApi lvgApi,
                                                    java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable)

Find sorted unique synonyms for a term from a synonym table. Term is normalized by SynonymNorm before mapping.

Parameters:

term - the term of interestes to find synonyms

lvgApi - LvgApi object from Lexical Tools

synTable - the key-values table of term|synonym

Returns:

a collection of sorted unique synonyms for the term

FindSynonyms

public static java.util.Vector<java.lang.String> FindSynonyms(java.lang.String term,
                                              gov.nih.nlm.nls.lvg.Api.LvgApi lvgApi,
                                              java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable)

Find unique synonyms for a term from a synonym table. Term is normalized by SynonymNorm before mapping.

Parameters:

term - the term of interestes to find synonyms

lvgApi - LvgApi object from Lexical Tools

synTable - the key-values table of term|synonym

Returns:

a collection of unique synonyms for the term

FindSortedRecursiveSynonyms

public static java.util.Vector<java.lang.String> FindSortedRecursiveSynonyms(java.lang.String term,
                                                             gov.nih.nlm.nls.lvg.Api.LvgApi lvgApi,
                                                             java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable,
                                                             int maxDepth)

Find sorted unique recursive synonyms for a term from a synonym table. Term is normalized by SynonymNorm before mapping.

Parameters:

term - the term of interestes to find synonyms

lvgApi - LvgApi object from Lexical Tools

synTable - the key-values table of term|synonym

maxDepth - the max recursive depth

Returns:

a collection of sorted unique recursive synonyms for the term

FindRecursiveSynonyms

public static java.util.Vector<java.lang.String> FindRecursiveSynonyms(java.lang.String term,
                                                       gov.nih.nlm.nls.lvg.Api.LvgApi lvgApi,
                                                       java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable,
                                                       int maxDepth)

Find unique recursive synonyms for a term from a synonym table. Term is normalized by SynonymNorm before mapping.

Parameters:

term - the term of interestes to find synonyms

lvgApi - LvgApi object from Lexical Tools

synTable - the key-values table of term|synonym

maxDepth - the max recursive depth

Returns:

a collection of sorted unique synonyms for the term

GetSynonyms

public static java.util.Vector<java.lang.String> GetSynonyms(java.lang.String normTerm,
                                             java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable)

Find unique synonyms for a normalized term from a synonym table. No nomalization is performed in this method before mapping.

Parameters:

normTerm - the normalized term of interestes to find synonyms

synTable - the key-values table of term|synonym

Returns:

a collection of unique synonyms for the term

GetSortedSynonyms

public static java.util.Vector<java.lang.String> GetSortedSynonyms(java.lang.String normTerm,
                                                   java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> synTable)

Find sorted unique synonyms for a normalized term from a synonym table. No nomalization is performed in this method before mapping.

Parameters:

normTerm - the normalized term of interestes to find synonyms

synTable - the key-values table of term|synonym

Returns:

a collection of sorted unique synonyms for the term

GetHashTable

public static java.util.Hashtable<java.lang.String,java.util.HashSet<java.lang.String>> GetHashTable(java.lang.String inFile,
                                                                                     boolean verboseFlag,
                                                                                     int lineNum)

Get the the key-values table of norm-term|synonym by loading from a file.

Parameters:

inFile - the file includes norm-term|synonym pairs to be loaded

verboseFlag - verbose flag

lineNum - loading status of line number to be displayed

Returns:

the key-values table of term|synonyms