Module org.apache.lucene.suggest
Package org.apache.lucene.search.spell

Class HighFrequencyDictionary.HighFrequencyIterator

java.lang.Object
org.apache.lucene.search.spell.HighFrequencyDictionary.HighFrequencyIterator
All Implemented Interfaces:
InputIterator, BytesRefIterator
Enclosing class:
HighFrequencyDictionary
final class HighFrequencyDictionary.HighFrequencyIterator extends Object implements InputIterator

  • Field Details

    • spare

      private final BytesRefBuilder spare

    • termsEnum

      private final TermsEnum termsEnum

    • minNumDocs

      private int minNumDocs

    • freq

      private long freq

  • Constructor Details

  • Method Details

    • isFrequent

      private boolean isFrequent(int freq)

    • weight

      public long weight()
      Description copied from interface: InputIterator
      A term's weight, higher numbers mean better suggestions.
      Specified by:
      weight in interface InputIterator

    • next

      public BytesRef next() throws IOException
      Description copied from interface: BytesRefIterator
      Increments the iteration to the next BytesRef in the iterator. Returns the resulting BytesRef or null if the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.
      Specified by:
      next in interface BytesRefIterator
      Returns:
      the next BytesRef in the iterator or null if the end of the iterator is reached.
      Throws:
      IOException - If there is a low-level I/O error.

    • payload

      public BytesRef payload()
      Description copied from interface: InputIterator
      An arbitrary byte[] to record per suggestion. See Lookup.LookupResult.payload to retrieve the payload for each suggestion.
      Specified by:
      payload in interface InputIterator

    • hasPayloads

      public boolean hasPayloads()
      Description copied from interface: InputIterator
      Returns true if the iterator has payloads
      Specified by:
      hasPayloads in interface InputIterator

    • contexts

      public Set<BytesRef> contexts()
      Description copied from interface: InputIterator
      A term's contexts context can be used to filter suggestions. May return null, if suggest entries do not have any context
      Specified by:
      contexts in interface InputIterator

    • hasContexts

      public boolean hasContexts()
      Description copied from interface: InputIterator
      Returns true if the iterator has contexts
      Specified by:
      hasContexts in interface InputIterator