simplenlg.lexicon

Class MultipleLexicon

java.lang.Object

simplenlg.lexicon.Lexicon

simplenlg.lexicon.MultipleLexicon

public class MultipleLexicon
extends Lexicon

This class contains a set of lexicons, which are searched in order for the specified word

Author:

ereiter

Constructor Summary

Constructors

Constructor and Description
MultipleLexicon() create an empty multi lexicon
MultipleLexicon(Lexicon... lexicons) create a multi lexicon with the specified lexicons

Method Summary

Modifier and Type	Method and Description
void	addFinalLexicon(Lexicon lex) add lexicon at end of list (is searched last)
void	addInitialLexicon(Lexicon lex) add lexicon at beginning of list (is searched first)
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	isAlwaysSearchAll()
void	setAlwaysSearchAll(boolean alwaysSearchAll)

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

MultipleLexicon

public MultipleLexicon()

create an empty multi lexicon

MultipleLexicon

public MultipleLexicon(Lexicon... lexicons)

create a multi lexicon with the specified lexicons

Method Detail

addInitialLexicon

public void addInitialLexicon(Lexicon lex)

add lexicon at beginning of list (is searched first)

addFinalLexicon

public void addFinalLexicon(Lexicon lex)

add lexicon at end of list (is searched last)

isAlwaysSearchAll

public boolean isAlwaysSearchAll()

Returns:

the alwaysSearchAll

setAlwaysSearchAll

public void setAlwaysSearchAll(boolean alwaysSearchAll)

Parameters:

alwaysSearchAll - the alwaysSearchAll to set

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