Class FileBackedDictionary

All Implemented Interfaces:
Installable

public class FileBackedDictionary extends AbstractCachingDictionary
A Dictionary that retrieves objects from the text files in the WordNet distribution directory.
  • Field Details

    • _log

      private static final MessageLog _log
    • MORPH

      public static final String MORPH
      Morphological processor class install parameter. The value should be the class of MorphologicalProcessor to use.
      See Also:
    • FILE_MANAGER

      public static final String FILE_MANAGER
      File manager install parameter. The value should be the class of FileManager to use.
      See Also:
    • DICTIONARY_ELEMENT_FACTORY

      public static final String DICTIONARY_ELEMENT_FACTORY
      The class of FileDictionaryElementFactory to use.
      See Also:
    • ENABLE_CACHING

      public static final String ENABLE_CACHING
      The value should be "true" or "false". The default is "true".
      See Also:
    • CACHE_SIZE

      public static final String CACHE_SIZE
      The default cache size.
      See Also:
    • INDEX_WORD_CACHE_SIZE

      public static final String INDEX_WORD_CACHE_SIZE
      Size of the index word cache. Overrides the default cache size
      See Also:
    • SYNSET_WORD_CACHE_SIZE

      public static final String SYNSET_WORD_CACHE_SIZE
      Size of the synset cache. Overrides the default cache size
      See Also:
    • EXCEPTION_WORD_CACHE_SIZE

      public static final String EXCEPTION_WORD_CACHE_SIZE
      Size of the exception cache. Overrides the default cache size
      See Also:
    • senseMap

      private Map senseMap
      A sense map, key is offsetlemma, word is populated with lemma, usage, and sense key.
    • _db

      private FileManager _db
    • _factory

      private FileDictionaryElementFactory _factory
  • Constructor Details

  • Method Details

    • install

      public static void install(FileManager fileManager, FileDictionaryElementFactory factory)
      Construct a Dictionary that retrieves file data from fileManager. A client can use this to create a Dictionary backed by a RemoteFileManager.
      See Also:
    • install

      public static void install(FileManager fileManager, MorphologicalProcessor morph, FileDictionaryElementFactory factory)
      Construct a Dictionary that retrieves file data from fileManager. If enableCaching is true, lookup operations will check the relavant cache before doing a lookup and will cache their results after doing a lookup.
    • install

      public static void install(FileManager fileManager, FileDictionaryElementFactory factory, boolean enableCaching)
    • install

      public static void install(FileManager fileManager, MorphologicalProcessor morph, FileDictionaryElementFactory factory, boolean enableCaching)
    • install

      public void install(Map params) throws JWNLException
      Install a FileBackedDictionary from a map of parameters. The keys are chose from the static variables above.
      Throws:
      JWNLException
    • close

      public void close()
      Description copied from class: Dictionary
      Shut down the dictionary
      Specified by:
      close in class Dictionary
    • getFileManager

      protected FileManager getFileManager()
      Get the file manager that backs this database.
    • getDictionaryElementFactory

      public FileDictionaryElementFactory getDictionaryElementFactory()
    • getIndexWordIterator

      public Iterator getIndexWordIterator(POS pos) throws JWNLException
      Description copied from class: Dictionary
      Return an Iterator over all the IndexWords of part-of-speech pos in the database.
      Specified by:
      getIndexWordIterator in class Dictionary
      Parameters:
      pos - The part-of-speech
      Returns:
      An iterator over IndexWords
      Throws:
      JWNLException
    • getIndexWordIterator

      public Iterator getIndexWordIterator(POS pos, String substring) throws JWNLException
      Description copied from class: Dictionary
      Return 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.
      Returns:
      An iterator over IndexWords.
      Throws:
      JWNLException
    • getIndexWord

      public IndexWord getIndexWord(POS pos, String lemma) throws JWNLException
      Description copied from class: Dictionary
      Look up a word in the database. 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.
      Throws:
      JWNLException
    • getRandomIndexWord

      public IndexWord getRandomIndexWord(POS pos) throws JWNLException
      Specified by:
      getRandomIndexWord in class Dictionary
      Throws:
      JWNLException
    • parseAndCacheIndexWordLine

      private IndexWord parseAndCacheIndexWordLine(POS pos, long offset, String line)
    • getSynsetIterator

      public Iterator getSynsetIterator(POS pos)
      Description copied from class: Dictionary
      Return an Iterator over all the Synsets of part-of-speech pos in the database.
      Specified by:
      getSynsetIterator in class Dictionary
      Parameters:
      pos - The part-of-speech.
      Returns:
      An iterator over Synsets.
    • getSynsetAt

      public Synset getSynsetAt(POS pos, long offset) throws JWNLException
      Description copied from class: Dictionary
      Return the Synset at offset offset from the database.
      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
      Throws:
      JWNLException
    • getSynset

      private Synset getSynset(POS pos, long offset, String line) throws JWNLException
      Throws:
      JWNLException
    • getExceptionIterator

      public Iterator getExceptionIterator(POS pos)
      Description copied from class: Dictionary
      Return an Iterator over all the Exceptions in the database.
      Specified by:
      getExceptionIterator in class Dictionary
      Parameters:
      pos - the part-of-speech
      Returns:
      Iterator An iterator over Strings
    • getException

      public Exc getException(POS pos, String derivation) throws JWNLException
      Description copied from class: Dictionary
      Lookup 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:
      Exc the Exc object
      Throws:
      JWNLException
    • parseAndCacheExceptionLine

      private Exc parseAndCacheExceptionLine(POS pos, long offset, String line)