Class FSTTermsReader.TermsReader.BaseTermsEnum

    • Constructor Detail

      • BaseTermsEnum

        BaseTermsEnum()
               throws java.io.IOException
        Throws:
        java.io.IOException
    • Method Detail

      • decodeMetaData

        abstract void decodeMetaData()
                              throws java.io.IOException
        Decodes metadata into customized term state
        Throws:
        java.io.IOException
      • docFreq

        public int docFreq()
                    throws java.io.IOException
        Description copied from class: TermsEnum
        Returns the number of documents containing the current term. Do not call this when the enum is unpositioned. TermsEnum.SeekStatus.END.
        Specified by:
        docFreq in class TermsEnum
        Throws:
        java.io.IOException
      • totalTermFreq

        public long totalTermFreq()
                           throws java.io.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). Note that, like other term measures, this measure does not take deleted documents into account.
        Specified by:
        totalTermFreq in class TermsEnum
        Throws:
        java.io.IOException
      • postings

        public PostingsEnum postings​(PostingsEnum reuse,
                                     int flags)
                              throws java.io.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 will not return null.

        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:
        java.io.IOException
      • seekExact

        public void seekExact​(long ord)
                       throws java.io.IOException
        Description copied from class: TermsEnum
        Seeks to the specified term by ordinal (position) as previously returned by TermsEnum.ord(). The target ord may be before or after the current ord, and must be within bounds.
        Specified by:
        seekExact in class TermsEnum
        Throws:
        java.io.IOException
      • ord

        public long ord()
        Description copied from class: TermsEnum
        Returns ordinal position for current term. This is an optional method (the codec may throw UnsupportedOperationException). Do not call this when the enum is unpositioned.
        Specified by:
        ord in class TermsEnum