simplenlg.lexicon

Class XMLLexicon

java.lang.Object

simplenlg.lexicon.Lexicon

simplenlg.lexicon.XMLLexicon

public class XMLLexicon
extends Lexicon

This class loads words from an XML lexicon. All features specified in the lexicon are loaded

Author:

ereiter

Constructor Summary

Constructors

Constructor and Description
XMLLexicon()
XMLLexicon(File file) Load an XML Lexicon from a File
XMLLexicon(String filename) Load an XML Lexicon from a named file
XMLLexicon(URI lexiconURI) Load an XML Lexicon from a URI

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class simplenlg.lexicon.Lexicon

close, 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

XMLLexicon

public XMLLexicon(String filename)

Load an XML Lexicon from a named file

XMLLexicon

public XMLLexicon(File file)

Load an XML Lexicon from a File

XMLLexicon

public XMLLexicon(URI lexiconURI)

Load an XML Lexicon from a URI

XMLLexicon

public XMLLexicon()

Method Detail

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)