Package org.apache.lucene.search.suggest.jaspell

Class JaspellLookup

java.lang.Object
org.apache.lucene.search.suggest.Lookup
org.apache.lucene.search.suggest.jaspell.JaspellLookup
All Implemented Interfaces:
Accountable
@Deprecated public class JaspellLookup extends Lookup implements Accountable
Deprecated.
Migrate to one of the newer suggesters which are much more RAM efficient.
Suggest implementation based on JaSpell.
See Also:

  • Field Details

    • trie

      JaspellTernarySearchTrie trie
      Deprecated.

    • usePrefix

      private boolean usePrefix
      Deprecated.

    • editDistance

      private int editDistance
      Deprecated.

    • count

      private long count
      Deprecated.
      Number of entries the lookup was built with

    • LO_KID

      private static final byte LO_KID
      Deprecated.
      See Also:

    • EQ_KID

      private static final byte EQ_KID
      Deprecated.
      See Also:

    • HI_KID

      private static final byte HI_KID
      Deprecated.
      See Also:

    • HAS_VALUE

      private static final byte HAS_VALUE
      Deprecated.
      See Also:

  • Constructor Details

    • JaspellLookup

      public JaspellLookup()
      Deprecated.
      Creates a new empty trie
      See Also:

  • Method Details

    • build

      public void build(InputIterator iterator) throws IOException
      Deprecated.
      Description copied from class: Lookup
      Builds up a new internal Lookup representation based on the given InputIterator. The implementation might re-sort the data internally.
      Specified by:
      build in class Lookup
      Throws:
      IOException

    • add

      public boolean add(CharSequence key, Object value)
      Deprecated.
      Adds a new node if key already exists, otherwise replaces its value.

      This method always returns false.

    • get

      public Object get(CharSequence key)
      Deprecated.
      Returns the value for the specified key, or null if the key does not exist.

    • lookup

      public List<Lookup.LookupResult> lookup(CharSequence key, Set<BytesRef> contexts, boolean onlyMorePopular, int num)
      Deprecated.
      Description copied from class: Lookup
      Look up a key and return possible completion for this key.
      Specified by:
      lookup in class Lookup
      Parameters:
      key - lookup key. Depending on the implementation this may be a prefix, misspelling, or even infix.
      contexts - contexts to filter the lookup by, or null if all contexts are allowed; if the suggestion contains any of the contexts, it's a match
      onlyMorePopular - return only more popular results
      num - maximum number of results to return
      Returns:
      a list of possible completions, with their relative weight (e.g. popularity)

    • readRecursively

      private void readRecursively(DataInput in, JaspellTernarySearchTrie.TSTNode node) throws IOException
      Deprecated.
      Throws:
      IOException

    • writeRecursively

      private void writeRecursively(DataOutput out, JaspellTernarySearchTrie.TSTNode node) throws IOException
      Deprecated.
      Throws:
      IOException

    • store

      public boolean store(DataOutput output) throws IOException
      Deprecated.
      Description copied from class: Lookup
      Persist the constructed lookup data to a directory. Optional operation.
      Specified by:
      store in class Lookup
      Parameters:
      output - DataOutput to write the data to.
      Returns:
      true if successful, false if unsuccessful or not supported.
      Throws:
      IOException - when fatal IO error occurs.

    • load

      public boolean load(DataInput input) throws IOException
      Deprecated.
      Description copied from class: Lookup
      Discard current lookup data and load it from a previously saved copy. Optional operation.
      Specified by:
      load in class Lookup
      Parameters:
      input - the DataInput to load the lookup data.
      Returns:
      true if completed successfully, false if unsuccessful or not supported.
      Throws:
      IOException - when fatal IO error occurs.

    • ramBytesUsed

      public long ramBytesUsed()
      Deprecated.
      Description copied from interface: Accountable
      Return the memory usage of this object in bytes. Negative values are illegal.
      Specified by:
      ramBytesUsed in interface Accountable

    • getCount

      public long getCount()
      Deprecated.
      Description copied from class: Lookup
      Get the number of entries the lookup was built with
      Specified by:
      getCount in class Lookup
      Returns:
      total number of suggester entries