Interface BytesRefSorter

  • All Known Implementing Classes:
    ExternalRefSorter, InMemorySorter

    public interface BytesRefSorter
    Collects BytesRef and then allows one to iterate over their sorted order. Implementations of this interface will be called in a single-threaded scenario.
    WARNING: This API is experimental and might change in incompatible ways in the next release.
    NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void add​(org.apache.lucene.util.BytesRef utf8)
      Adds a single suggestion entry (possibly compound with its bucket).
      Comparator<org.apache.lucene.util.BytesRef> getComparator()  
      org.apache.lucene.util.BytesRefIterator iterator()
      Sorts the entries added in add(BytesRef) and returns an iterator over all sorted entries.
    • Method Detail

      • iterator

        org.apache.lucene.util.BytesRefIterator iterator()
                                                  throws IOException
        Sorts the entries added in add(BytesRef) and returns an iterator over all sorted entries.
        Throws:
        IOException - If an I/O exception occurs.
      • getComparator

        Comparator<org.apache.lucene.util.BytesRef> getComparator()