Package net.didion.jwnl.dictionary

Class MapBackedDictionary

  • All Implemented Interfaces:
    Installable
    public class MapBackedDictionary
extends Dictionary
    A Dictionary backed by Maps. Warning: this has huge memory requirements. Make sure to start the interpreter with a large enough free memory pool to accomodate this.

    • Field Detail

      • MORPH

        public static final java.lang.String MORPH
        MorphologicalProcessor class install parameter. The value should be the class of MorphologicalProcessor to use.
        See Also:
        Constant Field Values

      • FILE_TYPE

        public static final java.lang.String FILE_TYPE
        File type install parameter. The value should be * the name of the appropriate subclass of DictionaryFileType.
        See Also:
        Constant Field Values

      • PATH

        public static final java.lang.String PATH
        The path of the dictionary files
        See Also:
        Constant Field Values

      • _rand

        private static final java.util.Random _rand
        Random number generator used by getRandomIndexWord()

      • _tableMap

        private java.util.Map _tableMap

    • Method Detail

      • install

        public static void install​(java.lang.String searchDir,
                           java.lang.Class dictionaryFileType)
                    throws JWNLException
        Throws:
        JWNLException

      • install

        public void install​(java.util.Map params)
             throws JWNLException
        Install a MapBackedDictionary from a map of parameters. The parameters are chosen from the static variables above.
        Throws:
        JWNLException

      • checkFileType

        private static void checkFileType​(java.lang.Class c)

      • getIndexWord

        public IndexWord getIndexWord​(POS pos,
                              java.lang.String lemma)
        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.

      • getIndexWordIterator

        public java.util.Iterator getIndexWordIterator​(POS pos,
                                               java.lang.String substring)
        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.

      • getIndexWordIterator

        public java.util.Iterator getIndexWordIterator​(POS pos)
        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

      • getSynsetIterator

        public java.util.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.

      • getExceptionIterator

        public java.util.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

      • getIterator

        private java.util.Iterator getIterator​(java.util.Map map)

      • getSynsetAt

        public Synset getSynsetAt​(POS pos,
                          long offset)
        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

      • getException

        public Exc getException​(POS pos,
                        java.lang.String derivation)
        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

      • close

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

      • putTable

        private void putTable​(POS pos,
                      DictionaryFileType fileType,
                      java.util.Map table)
        Use table for lookups to the file represented by pos and fileType.

      • getUsageCount

        public int getUsageCount​(long offset,
                         java.lang.String lemma)
        Not implemented in Map yet.

      • getSenseKey

        public java.lang.String getSenseKey​(long offset,
                                    java.lang.String lemma)
        Not implemented in Map yet.