org.apache.lucene.index

Class FilterLeafReader.FilterTermsEnum

    • Field Detail

      • in

        protected final TermsEnum in
        The underlying TermsEnum instance.
    • Constructor Detail

      • FilterTermsEnum

        public FilterTermsEnum(TermsEnum in)
        Creates a new FilterTermsEnum
        Parameters:
        in - the underlying TermsEnum instance.
    • Method Detail

      • seekCeil

        public TermsEnum.SeekStatus seekCeil(BytesRef text)
                                      throws IOException
        Description copied from class: TermsEnum
        Seeks to the specified term, if it exists, or to the next (ceiling) term. Returns SeekStatus to indicate whether exact term was found, a different term was found, or EOF was hit. The target term may be before or after the current term. If this returns SeekStatus.END, the enum is unpositioned.
        Specified by:
        seekCeil in class TermsEnum
        Throws:
        IOException
      • 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.
        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.
      • totalTermFreq

        public long totalTermFreq()
                           throws IOException
        Description copied from class: TermsEnum
        Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term). This will be -1 if the codec doesn't support this measure. Note that, like other term measures, this measure does not take deleted documents into account.
        Specified by:
        totalTermFreq in class TermsEnum
        Throws:
        IOException
      • postings

        public PostingsEnum postings(PostingsEnum reuse,
                                     int flags)
                              throws IOException
        Description copied from class: TermsEnum
        Get PostingsEnum for the current term, with control over whether freqs, positions, offsets or payloads are required. Do not call this when the enum is unpositioned. This method may return null if the postings information required is not available from the index

        NOTE: the returned iterator may return deleted documents, so deleted documents have to be checked on top of the PostingsEnum.

        Specified by:
        postings in class TermsEnum
        Parameters:
        reuse - pass a prior PostingsEnum for possible reuse
        flags - specifies which optional per-document values you require; see PostingsEnum.FREQS
        Throws:
        IOException