Class AbstractAllGroupHeadsCollector.GroupHead<GROUP_VALUE_TYPE>

  • Enclosing class:
    AbstractAllGroupHeadsCollector<GH extends AbstractAllGroupHeadsCollector.GroupHead>

    public abstract static class AbstractAllGroupHeadsCollector.GroupHead<GROUP_VALUE_TYPE>
    extends Object
    Represents a group head. A group head is the most relevant document for a particular group. The relevancy is based is usually based on the sort. The group head contains a group value with its associated most relevant document id.
    • Method Detail

      • compare

        protected abstract int compare​(int compIDX,
                                       int doc)
                                throws IOException
        Compares the specified document for a specified comparator against the current most relevant document.
        Parameters:
        compIDX - The comparator index of the specified comparator.
        doc - The specified document.
        Returns:
        -1 if the specified document wasn't competitive against the current most relevant document, 1 if the specified document was competitive against the current most relevant document. Otherwise 0.
        Throws:
        IOException - If I/O related errors occur
      • updateDocHead

        protected abstract void updateDocHead​(int doc)
                                       throws IOException
        Updates the current most relevant document with the specified document.
        Parameters:
        doc - The specified document
        Throws:
        IOException - If I/O related errors occur