Class PostingsConsumer

    • Constructor Detail

      • PostingsConsumer

        protected PostingsConsumer()
        Sole constructor. (For invocation by subclass constructors, typically implicit.)
    • Method Detail

      • startDoc

        public abstract void startDoc​(int docID,
                                      int freq)
                               throws IOException
        Adds a new doc in this term. freq will be -1 when term frequencies are omitted for the field.
        Throws:
        IOException
      • addPosition

        public abstract void addPosition​(int position,
                                         BytesRef payload,
                                         int startOffset,
                                         int endOffset)
                                  throws IOException
        Add a new position & payload, and start/end offset. A null payload means no payload; a non-null payload with zero length also means no payload. Caller may reuse the BytesRef for the payload between calls (method must fully consume the payload). startOffset and endOffset will be -1 when offsets are not indexed.
        Throws:
        IOException
      • finishDoc

        public abstract void finishDoc()
                                throws IOException
        Called when we are done adding positions & payloads for each doc.
        Throws:
        IOException