net.sf.extjwnl.dictionary

Class MapDictionary

java.lang.Object

net.sf.extjwnl.dictionary.Dictionary

net.sf.extjwnl.dictionary.MapDictionary

Direct Known Subclasses:

MapBackedDictionary, MemoryDictionary

public class MapDictionary
extends Dictionary

Base class for map-based dictionaries.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.extjwnl.dictionary.Dictionary

Dictionary.Version

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Random	rand Random number generator used by getRandomIndexWord()
protected java.util.Map<POS,java.util.Map<DictionaryFileType,java.util.Map<java.lang.Object,DictionaryElement>>>	tableMap

Fields inherited from class net.sf.extjwnl.dictionary.Dictionary

CHECK_LEX_IDS_KEY, DEFAULT_RESOURCE_CONFIG_PATH, DICTIONARY_ELEMENT_FACTORY, EDIT_CHECK_ALIEN_POINTERS, EDIT_MANAGE_SYMMETRIC_POINTERS, elementFactory, MORPHOLOGICAL_PROCESSOR, params

Constructor Summary

Constructors

Constructor and Description
MapDictionary(org.w3c.dom.Document doc)

Method Summary

Modifier and Type	Method and Description
void	addException(Exc exc) Adds exception to the dictionary.
void	addIndexWord(IndexWord indexWord) Adds index word to the dictionary.
void	addSynset(Synset synset) Adds synset to the dictionary.
void	close() Shuts down the dictionary, freeing resources.
void	edit() Puts the dictionary into edit mode.
Exc	getException(POS pos, java.lang.String derivation) Looks up derivation in the exceptions file of part-of-speech pos and return an Exc object containing the results.
java.util.Iterator<Exc>	getExceptionIterator(POS pos) Returns an iterator over all the exceptions.
IndexWord	getIndexWord(POS pos, java.lang.String lemma) Looks up a word.
java.util.Iterator<IndexWord>	getIndexWordIterator(POS pos) Returns an Iterator over all the IndexWords of part-of-speech pos.
java.util.Iterator<IndexWord>	getIndexWordIterator(POS pos, java.lang.String substring) Returns an Iterator over all the IndexWords of part-of-speech pos whose lemmas contain substring as a substring.
IndexWord	getRandomIndexWord(POS pos) Returns a random index word of a specified pos.
Synset	getSynsetAt(POS pos, long offset) Returns the Synset at offset offset.
java.util.Iterator<Synset>	getSynsetIterator(POS pos) Returns an iterator over all the synsets of part-of-speech pos.
java.util.Map<java.lang.Object,DictionaryElement>	getTable(POS pos, DictionaryFileType fileType)
void	removeException(Exc exc) Removes the exc from the dictionary.
void	removeIndexWord(IndexWord indexWord) Removes indexWord from the dictionary.
void	removeSynset(Synset synset) Removes synset from the dictionary.

Methods inherited from class net.sf.extjwnl.dictionary.Dictionary

addElement, checkEditable, createException, createIndexWord, createSynset, delete, getCheckAlienPointers, getDatabaseBackedInstance, getDefaultResourceInstance, getFileBackedInstance, getFrames, getFrames, getInstance, getInstance, getManageSymmetricPointers, getMapBackedInstance, getMessages, getMorphologicalProcessor, getRandom, getResourceInstance, getRestoreDictionary, getVerbFrameIndices, getVersion, getWordBySenseKey, isEditable, lookupAllIndexWords, lookupIndexWord, prepareQueryString, removeElement, resolveAllPointers, resolvePointers, save, setRandom, setRestoreDictionary

Methods inherited from class java.lang.Object

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

Field Detail

rand

protected static final java.util.Random rand

Random number generator used by getRandomIndexWord()

tableMap

protected final java.util.Map<POS,java.util.Map<DictionaryFileType,java.util.Map<java.lang.Object,DictionaryElement>>> tableMap

Constructor Detail

MapDictionary

public MapDictionary(org.w3c.dom.Document doc)
              throws JWNLException

Throws:

JWNLException

Method Detail

getIndexWord

public IndexWord getIndexWord(POS pos,
                              java.lang.String lemma)

Description copied from class: Dictionary

Looks up a word. The search is case-independent, and phrases are separated by spaces ("look up", not "look_up"). Note: this method does not subject lemma to any morphological processing. If you want this, use Dictionary.lookupIndexWord(POS, String).

Specified by:

getIndexWord in class Dictionary

Parameters:

pos - The part-of-speech

lemma - The orthographic representation of the word

Returns:

An IndexWord representing the word, or null if no such entry exists

getIndexWordIterator

public java.util.Iterator<IndexWord> getIndexWordIterator(POS pos,
                                                          java.lang.String substring)

Description copied from class: Dictionary

Returns an Iterator over all the IndexWords of part-of-speech pos whose lemmas contain substring as a substring.

Specified by:

getIndexWordIterator in class Dictionary

Parameters:

pos - The part-of-speech.

substring - substring

Returns:

An iterator over IndexWords.

getIndexWordIterator

public java.util.Iterator<IndexWord> getIndexWordIterator(POS pos)

Description copied from class: Dictionary

Returns an Iterator over all the IndexWords of part-of-speech pos.

Specified by:

getIndexWordIterator in class Dictionary

Parameters:

pos - The part-of-speech

Returns:

iterator over IndexWords

getRandomIndexWord

public IndexWord getRandomIndexWord(POS pos)
                             throws JWNLException

Description copied from class: Dictionary

Returns a random index word of a specified pos.

Specified by:

getRandomIndexWord in class Dictionary

Parameters:

pos - part of speech

Returns:

a random index word of a specified pos

Throws:

JWNLException - JWNLException

getSynsetIterator

public java.util.Iterator<Synset> getSynsetIterator(POS pos)

Description copied from class: Dictionary

Returns an iterator over all the synsets of part-of-speech pos.

Specified by:

getSynsetIterator in class Dictionary

Parameters:

pos - The part-of-speech.

Returns:

An iterator over Synsets.

getExceptionIterator

public java.util.Iterator<Exc> getExceptionIterator(POS pos)

Description copied from class: Dictionary

Returns an iterator over all the exceptions.

Specified by:

getExceptionIterator in class Dictionary

Parameters:

pos - the part-of-speech

Returns:

an iterator over Excs

getSynsetAt

public Synset getSynsetAt(POS pos,
                          long offset)

Description copied from class: Dictionary

Returns the Synset at offset offset.

Specified by:

getSynsetAt in class Dictionary

Parameters:

pos - The part-of-speech file to look in

offset - The offset of the synset in the file

Returns:

A synset containing the parsed line from the database

getException

public Exc getException(POS pos,
                        java.lang.String derivation)

Description copied from class: Dictionary

Looks up derivation in the exceptions file of part-of-speech pos and return an Exc object containing the results.

Specified by:

getException in class Dictionary

Parameters:

pos - the exception file to look in

derivation - the word to look up

Returns:

the Exc object

close

public void close()
           throws JWNLException

Description copied from class: Dictionary

Shuts down the dictionary, freeing resources.

Specified by:

close in class Dictionary

Throws:

JWNLException - JWNLException

edit

public void edit()
          throws JWNLException

Description copied from class: Dictionary

Puts the dictionary into edit mode.

Overrides:

edit in class Dictionary

Throws:

JWNLException - JWNLException

addSynset

public void addSynset(Synset synset)
               throws JWNLException

Description copied from class: Dictionary

Adds synset to the dictionary.

Overrides:

addSynset in class Dictionary

Parameters:

synset - synset to add

Throws:

JWNLException - JWNLException

removeSynset

public void removeSynset(Synset synset)
                  throws JWNLException

Description copied from class: Dictionary

Removes synset from the dictionary.

Overrides:

removeSynset in class Dictionary

Parameters:

synset - synset to remove

Throws:

JWNLException - JWNLException

addException

public void addException(Exc exc)
                  throws JWNLException

Description copied from class: Dictionary

Adds exception to the dictionary.

Overrides:

addException in class Dictionary

Parameters:

exc - exception to add

Throws:

JWNLException - JWNLException

removeException

public void removeException(Exc exc)
                     throws JWNLException

Description copied from class: Dictionary

Removes the exc from the dictionary.

Overrides:

removeException in class Dictionary

Parameters:

exc - exc to be removed

Throws:

JWNLException - JWNLException

addIndexWord

public void addIndexWord(IndexWord indexWord)
                  throws JWNLException

Description copied from class: Dictionary

Adds index word to the dictionary.

Overrides:

addIndexWord in class Dictionary

Parameters:

indexWord - index word to add

Throws:

JWNLException - JWNLException

removeIndexWord

public void removeIndexWord(IndexWord indexWord)
                     throws JWNLException

Description copied from class: Dictionary

Removes indexWord from the dictionary.

Overrides:

removeIndexWord in class Dictionary

Parameters:

indexWord - index word to remove

Throws:

JWNLException - JWNLException

getTable

public java.util.Map<java.lang.Object,DictionaryElement> getTable(POS pos,
                                                                  DictionaryFileType fileType)