net.sf.extjwnl.dictionary

Class AbstractCachingDictionary

java.lang.Object

net.sf.extjwnl.dictionary.Dictionary

net.sf.extjwnl.dictionary.AbstractCachingDictionary

Direct Known Subclasses:

DatabaseBackedDictionary, FileBackedDictionary

public abstract class AbstractCachingDictionary
extends Dictionary

Extends Dictionary to provide caching of elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractCachingDictionary.IndexWordIterator

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

Dictionary.Version

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isCachingEnabled

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

Modifier	Constructor and Description
protected	AbstractCachingDictionary(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	cacheAll()
protected Exc	cacheException(Exc exception)
protected IndexWord	cacheIndexWord(IndexWord word)
protected void	cachePOS(POS pos)
void	cacheSynset(Synset synset)
void	clearCache()
void	clearCache(DictionaryElementType elementType)
protected void	clearException(POS pos, java.lang.Object key)
protected void	clearIndexWord(POS pos, java.lang.Object key)
void	clearSynset(POS pos, java.lang.Object key)
void	edit() Puts the dictionary into edit mode.
long	getCacheCapacity(DictionaryElementType type)
protected Exc	getCachedException(POS pos, java.lang.Object key)
protected IndexWord	getCachedIndexWord(POS pos, java.lang.Object key)
protected Synset	getCachedSynset(POS pos, java.lang.Object key)
int	getCacheSizes(DictionaryElementType type)
java.util.Iterator<Exc>	getExceptionIterator(POS pos) Returns an iterator over all the exceptions.
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.
java.util.Iterator<Synset>	getSynsetIterator(POS pos) Returns an iterator over all the synsets of part-of-speech pos.
boolean	isCachingEnabled()
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.
void	setCacheCapacity(DictionaryElementType type, int size)
void	setCacheCapacity(int size)
void	setCachingEnabled(boolean cachingEnabled)

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

addElement, checkEditable, close, createException, createIndexWord, createSynset, delete, getCheckAlienPointers, getDatabaseBackedInstance, getDefaultResourceInstance, getException, getFileBackedInstance, getFrames, getFrames, getIndexWord, getInstance, getInstance, getManageSymmetricPointers, getMapBackedInstance, getMessages, getMorphologicalProcessor, getRandom, getRandomIndexWord, getResourceInstance, getRestoreDictionary, getSynsetAt, 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

isCachingEnabled

protected boolean isCachingEnabled

Constructor Detail

AbstractCachingDictionary

protected AbstractCachingDictionary(org.w3c.dom.Document doc)
                             throws JWNLException

Throws:

JWNLException

Method Detail

isCachingEnabled

public boolean isCachingEnabled()

setCachingEnabled

public void setCachingEnabled(boolean cachingEnabled)

getCacheSizes

public int getCacheSizes(DictionaryElementType type)

getCacheCapacity

public long getCacheCapacity(DictionaryElementType type)

setCacheCapacity

public void setCacheCapacity(int size)

setCacheCapacity

public void setCacheCapacity(DictionaryElementType type,
                             int size)

clearCache

public void clearCache()

clearCache

public void clearCache(DictionaryElementType elementType)

cacheIndexWord

protected IndexWord cacheIndexWord(IndexWord word)

clearIndexWord

protected void clearIndexWord(POS pos,
                              java.lang.Object key)

getCachedIndexWord

protected IndexWord getCachedIndexWord(POS pos,
                                       java.lang.Object key)

cacheSynset

public void cacheSynset(Synset synset)

clearSynset

public void clearSynset(POS pos,
                        java.lang.Object key)

getCachedSynset

protected Synset getCachedSynset(POS pos,
                                 java.lang.Object key)

cacheException

protected Exc cacheException(Exc exception)

clearException

protected void clearException(POS pos,
                              java.lang.Object key)

getCachedException

protected Exc getCachedException(POS pos,
                                 java.lang.Object key)

getExceptionIterator

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

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

Throws:

JWNLException - JWNLException

getSynsetIterator

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

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.

Throws:

JWNLException - JWNLException

getIndexWordIterator

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

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

Throws:

JWNLException - JWNLException

getIndexWordIterator

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

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.

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

cacheAll

public void cacheAll()
              throws JWNLException

Throws:

JWNLException

cachePOS

protected void cachePOS(POS pos)
                 throws JWNLException

Throws:

JWNLException