simplenlg.lexicon

Class NIHDBLexicon

java.lang.Object

simplenlg.lexicon.Lexicon

simplenlg.lexicon.NIHDBLexicon

public class NIHDBLexicon
extends Lexicon

This class gets Words from the NIH Specialist Lexicon

Author:

ereiter

Constructor Summary

Constructors

Constructor and Description
NIHDBLexicon(String filename) set up lexicon using file which contains downloaded lexAccess HSQL DB and default passwords
NIHDBLexicon(String driver, String url, String username, String password) set up lexicon using general DB parameters; DB must be NIH specialist lexicon from lexAccess

Method Summary

Modifier and Type	Method and Description
void	close() close the lexicon (if necessary) if lexicon does not need to be closed, this does nothing
List<WordElement>	getWords(String baseForm, LexicalCategory category) returns all Words which have the specified base form and category
List<WordElement>	getWordsByID(String id) returns a List of WordElement which have this ID.
List<WordElement>	getWordsFromVariant(String variant, LexicalCategory category) returns Words which have an inflected form and/or spelling variant that matches the specified variant, and are in the specified category.
boolean	isKeepStandardInflections() reports whether Words include standard (derivable) inflections
void	setKeepStandardInflections(boolean keepStandardInflections) set whether Words should include standard (derivable) inflections

Methods inherited from class simplenlg.lexicon.Lexicon

createWord, createWord, getDefaultLexicon, getWord, getWord, getWordByID, getWordFromVariant, getWordFromVariant, getWords, getWordsFromVariant, hasWord, hasWord, hasWordByID, hasWordFromVariant, hasWordFromVariant, lookupWord, lookupWord

Methods inherited from class java.lang.Object

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

Constructor Detail

NIHDBLexicon

public NIHDBLexicon(String filename)

set up lexicon using file which contains downloaded lexAccess HSQL DB and default passwords

Parameters:

filename - of HSQL DB

NIHDBLexicon

public NIHDBLexicon(String driver,
                    String url,
                    String username,
                    String password)

set up lexicon using general DB parameters; DB must be NIH specialist lexicon from lexAccess

Method Detail

isKeepStandardInflections

public boolean isKeepStandardInflections()

reports whether Words include standard (derivable) inflections

Returns:

true if standard inflections are kept

setKeepStandardInflections

public void setKeepStandardInflections(boolean keepStandardInflections)

set whether Words should include standard (derivable) inflections

Parameters:

keepStandardInflections - - if true, standard inflections are kept

getWords

public List<WordElement> getWords(String baseForm,
                                  LexicalCategory category)

Description copied from class: Lexicon

returns all Words which have the specified base form and category

Specified by:

getWords in class Lexicon

Parameters:

baseForm - - base form of word, eg "be" or "dog" (not "is" or "dogs")

category - - syntactic category of word (ANY for unknown)

Returns:

collection of all matching Words (may be empty)

getWordsByID

public List<WordElement> getWordsByID(String id)

Description copied from class: Lexicon

returns a List of WordElement which have this ID. IDs are lexicon-dependent, and should be unique. Therefore the list should contain either zero elements (if no such word exists) or one element (if the word is found)

Specified by:

getWordsByID in class Lexicon

Parameters:

id - - internal lexicon ID for a word

Returns:

either empty list (if no word with this ID exists) or list containing the matching word

getWordsFromVariant

public List<WordElement> getWordsFromVariant(String variant,
                                             LexicalCategory category)

Description copied from class: Lexicon

returns Words which have an inflected form and/or spelling variant that matches the specified variant, and are in the specified category.
Note: the returned word list may not be complete, it depends on how it is implemented by the underlying lexicon

Specified by:

getWordsFromVariant in class Lexicon

Parameters:

variant - - base form, inflected form, or spelling variant of word

category - - syntactic category of word (ANY for unknown)

Returns:

list of all matching Words (empty list if no matching WordElement found)

close

public void close()

Description copied from class: Lexicon

close the lexicon (if necessary) if lexicon does not need to be closed, this does nothing

Overrides:

close in class Lexicon