Package org.apache.lucene.search.spell

Interface TermFreqIterator

All Superinterfaces:
BytesRefIterator
All Known Implementing Classes:
BufferingTermFreqIteratorWrapper, SortedTermFreqIteratorWrapper, TermFreqIterator.TermFreqIteratorWrapper
public interface TermFreqIterator extends BytesRefIterator
Interface for enumerating term,weight pairs.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    TermFreqIterator.TermFreqIteratorWrapper
    Wraps a BytesRefIterator as a TermFreqIterator, with all weights set to 1

  • Field Summary

    Fields inherited from interface org.apache.lucene.util.BytesRefIterator

    EMPTY

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    weight()
    A term's weight, higher numbers mean better suggestions.

    Methods inherited from interface org.apache.lucene.util.BytesRefIterator

    getComparator, next

  • Method Details

    • weight

      long weight()
      A term's weight, higher numbers mean better suggestions.