Package net.didion.jwnl.dictionary

Class Dictionary

java.lang.Object
net.didion.jwnl.dictionary.Dictionary
All Implemented Interfaces:
Installable
Direct Known Subclasses:
AbstractCachingDictionary, MapBackedDictionary
public abstract class Dictionary extends Object implements Installable
Abstract representation of a WordNet dictionary. See the architecture documentation for information on subclassing Dictionary.

  • Field Details

    • _log

      private static final MessageLog _log

    • _dictionary

      private static Dictionary _dictionary
      The singleton instance of the dictionary to be used throughout the system.

    • _morph

      private MorphologicalProcessor _morph

  • Constructor Details

    • Dictionary

      protected Dictionary()
      Create a Dictionary that does not do morphological processing.

    • Dictionary

      protected Dictionary(MorphologicalProcessor morph)
      Create a Dictionary using the specified MorphologicalProcessor.

  • Method Details

    • getInstance

      public static Dictionary getInstance()

    • setDictionary

      protected static void setDictionary(Dictionary dictionary)

    • uninstall

      public static void uninstall()

    • prepareQueryString

      protected static String prepareQueryString(String lemma)
      Prepares the lemma for being used in a lookup operation. Specifically, this method trims whitespace and converts the lemma to lower case.
      Parameters:
      lemma - the lemma to be prepared
      Returns:
      String the prepared lemma

    • getIndexWordIterator

      public abstract Iterator getIndexWordIterator(POS pos) throws JWNLException
      Return an Iterator over all the IndexWords of part-of-speech pos in the database.
      Parameters:
      pos - The part-of-speech
      Returns:
      An iterator over IndexWords
      Throws:
      JWNLException

    • getIndexWordIterator

      public abstract Iterator getIndexWordIterator(POS pos, String substring) throws JWNLException
      Return an Iterator over all the IndexWords of part-of-speech pos whose lemmas contain substring as a substring.
      Parameters:
      pos - The part-of-speech.
      Returns:
      An iterator over IndexWords.
      Throws:
      JWNLException

    • getIndexWord

      public abstract IndexWord getIndexWord(POS pos, String lemma) throws JWNLException
      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 lookupIndexWord(POS, String).
      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 abstract IndexWord getRandomIndexWord(POS pos) throws JWNLException
      Throws:
      JWNLException

    • getSynsetIterator

      public abstract Iterator getSynsetIterator(POS pos) throws JWNLException
      Return an Iterator over all the Synsets of part-of-speech pos in the database.
      Parameters:
      pos - The part-of-speech.
      Returns:
      An iterator over Synsets.
      Throws:
      JWNLException

    • getSynsetAt

      public abstract Synset getSynsetAt(POS pos, long offset) throws JWNLException
      Return the Synset at offset offset from the database.
      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

    • getExceptionIterator

      public abstract Iterator getExceptionIterator(POS pos) throws JWNLException
      Return an Iterator over all the Exceptions in the database.
      Parameters:
      pos - the part-of-speech
      Returns:
      Iterator An iterator over Strings
      Throws:
      JWNLException

    • getException

      public abstract Exc getException(POS pos, String derivation) throws JWNLException
      Lookup derivation in the exceptions file of part-of-speech pos and return an Exc object containing the results.
      Parameters:
      pos - the exception file to look in
      derivation - the word to look up
      Returns:
      Exc the Exc object
      Throws:
      JWNLException

    • close

      public abstract void close()
      Shut down the dictionary

    • getMorphologicalProcessor

      public MorphologicalProcessor getMorphologicalProcessor()

    • lookupIndexWord

      public IndexWord lookupIndexWord(POS pos, String lemma) throws JWNLException
      Main word lookup procedure. First try a normal lookup. If that doesn't work, try looking up the stemmed form of the lemma.
      Parameters:
      pos - the part-of-speech of the word to look up
      lemma - the lemma to look up
      Returns:
      IndexWord the IndexWord found by the lookup procedure, or null if an IndexWord is not found
      Throws:
      JWNLException

    • lookupAllIndexWords

      public IndexWordSet lookupAllIndexWords(String lemma) throws JWNLException
      Return a set of IndexWords, with each element in the set corresponding to a part-of-speech of word.
      Parameters:
      lemma - the word for which to lookup senses
      Returns:
      An array of IndexWords, each of which is a sense of word
      Throws:
      JWNLException