|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object edu.mit.jwi.CachingDictionary
public class CachingDictionary
A dictionary that caches the results of another dictionary
Nested Class Summary | |
---|---|
static class |
CachingDictionary.ItemCache
An LRU cache for objects in JWI. |
Nested classes/interfaces inherited from interface edu.mit.jwi.ICachingDictionary |
---|
ICachingDictionary.IItemCache |
Nested classes/interfaces inherited from interface edu.mit.jwi.data.IHasLifecycle |
---|
IHasLifecycle.LifecycleState, IHasLifecycle.ObjectClosedException, IHasLifecycle.ObjectOpenException |
Constructor Summary | |
---|---|
CachingDictionary(IDictionary backing)
Constructs a new caching dictionary that caches the results of the specified backing dictionary |
Method Summary | |
---|---|
protected void |
cacheSynset(ISynset synset)
Caches the specified synset and its words. |
protected void |
checkOpen()
An internal method for assuring compliance with the dictionary interface that says that methods will throw ObjectClosedException s if
the dictionary has not yet been opened. |
void |
close()
This closes the object by disposing of data backing objects or connections. |
protected ICachingDictionary.IItemCache |
createCache()
This operation creates the cache that is used by the dictionary. |
IDictionary |
getBackingDictionary()
Returns the dictionary that is wrapped by this dictionary; will never return null |
ICachingDictionary.IItemCache |
getCache()
Returns the cache used by this dictionary, so that it may be configured or manipulated directly. |
java.nio.charset.Charset |
getCharset()
Returns the character set associated with this object. |
IExceptionEntry |
getExceptionEntry(IExceptionEntryID id)
Retrieves the exception entry for the specified id from the database. |
IExceptionEntry |
getExceptionEntry(java.lang.String surfaceForm,
POS pos)
Retrieves the exception entry for the specified surface form and part of speech from the database. |
java.util.Iterator<IExceptionEntry> |
getExceptionEntryIterator(POS pos)
Returns an iterator that will iterate over all exception entries of the specified part of speech. |
IIndexWord |
getIndexWord(IIndexWordID id)
Retrieves the specified index word object from the database. |
IIndexWord |
getIndexWord(java.lang.String lemma,
POS pos)
This method is identical to getIndexWord(IIndexWordID) and
is provided as a convenience. |
java.util.Iterator<IIndexWord> |
getIndexWordIterator(POS pos)
Returns an iterator that will iterate over all index words of the specified part of speech. |
ISenseEntry |
getSenseEntry(ISenseKey key)
Retrieves the sense entry for the specified sense key from the database. |
java.util.Iterator<ISenseEntry> |
getSenseEntryIterator()
Returns an iterator that will iterate over all sense entries in the dictionary. |
ISynset |
getSynset(ISynsetID id)
Retrieves the synset with the specified id from the database. |
java.util.Iterator<ISynset> |
getSynsetIterator(POS pos)
Returns an iterator that will iterate over all synsets of the specified part of speech. |
IVersion |
getVersion()
Returns the associated version for this object. |
IWord |
getWord(ISenseKey key)
Retrieves the word with the specified sense key from the database. |
IWord |
getWord(IWordID id)
Retrieves the word with the specified id from the database. |
boolean |
isOpen()
Returns true if the dictionary is open, that is, ready to
accept queries; returns false otherwise |
boolean |
open()
This opens the object by performing any required initialization steps. |
void |
setCharset(java.nio.charset.Charset charset)
Sets the character set associated with this dictionary. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CachingDictionary(IDictionary backing)
backing
- the dictionary whose results should be cachedMethod Detail |
---|
public IDictionary getBackingDictionary()
null
protected ICachingDictionary.IItemCache createCache()
protected void checkOpen()
ObjectClosedException
s if
the dictionary has not yet been opened.
ObjectClosedException
- if the dictionary is closed.public ICachingDictionary.IItemCache getCache()
ICachingDictionary
getCache
in interface ICachingDictionary
public void setCharset(java.nio.charset.Charset charset)
IDictionary
null
.
setCharset
in interface IDictionary
charset
- the possibly null
character set to use when
decoding files.public java.nio.charset.Charset getCharset()
IHasCharset
null
.
getCharset
in interface IHasCharset
null
public boolean open() throws java.io.IOException
IHasLifecycle
false
, then subsequent calls to
IHasLifecycle.isOpen()
will return false
.
open
in interface IHasLifecycle
true
if there were no errors in initialization;
false
otherwise.
java.io.IOException
- if there was IO error while performing initializataionpublic boolean isOpen()
IHasLifecycle
true
if the dictionary is open, that is, ready to
accept queries; returns false
otherwise
isOpen
in interface IHasLifecycle
true
if the object is open; false
otherwisepublic void close()
IClosable
close
in interface IClosable
public IVersion getVersion()
IHasVersion
null
.
getVersion
in interface IHasVersion
null
if none.public IIndexWord getIndexWord(java.lang.String lemma, POS pos)
IDictionary
getIndexWord(IIndexWordID)
and
is provided as a convenience.
getIndexWord
in interface IDictionary
lemma
- the lemma for the index word requested; may not be
null
, empty, or all whitespacepos
- the part of speech; may not be null
null
if none is foundpublic IIndexWord getIndexWord(IIndexWordID id)
IDictionary
null
.
Note: This call does no stemming on the specified lemma, it is
taken as specified. That is, if you submit the word "dogs", it will
search for "dogs", not "dog"; in the standard Wordnet distribution, there
is no entry for "dogs" and therefore the call will return
null
. This is in contrast to the Wordnet API provided by
Princeton. If you want your searches to capture morphological variation,
use the descendants of the IStemmer
class.
getIndexWord
in interface IDictionary
id
- the id of the index word to search for; may not be
null
null
otherwisepublic java.util.Iterator<IIndexWord> getIndexWordIterator(POS pos)
IDictionary
getIndexWordIterator
in interface IDictionary
pos
- the part of speech over which to iterate; may not be
null
public IWord getWord(IWordID id)
IDictionary
null
getWord
in interface IDictionary
id
- the id of the word to search for; may not be null
null
otherwisepublic IWord getWord(ISenseKey key)
IDictionary
null
getWord
in interface IDictionary
key
- the sense key of the word to search for; may not be
null
null
otherwisepublic ISynset getSynset(ISynsetID id)
IDictionary
null
getSynset
in interface IDictionary
id
- the id of the synset to search for; may not be
null
null
otherwiseprotected void cacheSynset(ISynset synset)
synset
- the synset to be cached; may not be null
java.lang.NullPointerException
- if the specified synset is null
public java.util.Iterator<ISynset> getSynsetIterator(POS pos)
IDictionary
getSynsetIterator
in interface IDictionary
pos
- the part of speech over which to iterate; may not be
null
public ISenseEntry getSenseEntry(ISenseKey key)
IDictionary
null
getSenseEntry
in interface IDictionary
key
- the sense key of the entry to search for; may not be
null
null
otherwisepublic java.util.Iterator<ISenseEntry> getSenseEntryIterator()
IDictionary
getSenseEntryIterator
in interface IDictionary
public IExceptionEntry getExceptionEntry(java.lang.String surfaceForm, POS pos)
IDictionary
null
getExceptionEntry
in interface IDictionary
surfaceForm
- the surface form to be looked up; may not be null
, empty, or all whitespacepos
- the part of speech; may not be null
null
otherwisepublic IExceptionEntry getExceptionEntry(IExceptionEntryID id)
IDictionary
null
getExceptionEntry
in interface IDictionary
id
- the exception entry id of the entry to search for; may not be
null
public java.util.Iterator<IExceptionEntry> getExceptionEntryIterator(POS pos)
IDictionary
getExceptionEntryIterator
in interface IDictionary
pos
- the part of speech over which to iterate; may not be
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |