Package org.apache.lucene.codecs.simpletext

Class SimpleTextFieldsReader.SimpleTextTermsEnum

    • Field Detail

      • docFreq

        private int docFreq

      • totalTermFreq

        private long totalTermFreq

      • docsStart

        private long docsStart

      • ended

        private boolean ended

    • Method Detail

      • seekExact

        public boolean seekExact​(BytesRef text)
                  throws java.io.IOException
        Description copied from class: TermsEnum
        Attempts to seek to the exact term, returning true if the term is found. If this returns false, the enum is unpositioned. For some codecs, seekExact may be substantially faster than TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

        Overrides:
        seekExact in class BaseTermsEnum
        Returns:
        true if the term is found; return false if the enum is unpositioned.
        Throws:
        java.io.IOException

      • seekCeil

        public TermsEnum.SeekStatus seekCeil​(BytesRef text)
                              throws java.io.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:
        java.io.IOException

      • next

        public BytesRef next()
              throws java.io.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:
        java.io.IOException - If there is a low-level I/O error.

      • term

        public BytesRef term()
        Description copied from class: TermsEnum
        Returns current term. Do not call this when the enum is unpositioned.
        Specified by:
        term in class TermsEnum

      • ord

        public long ord()
         throws java.io.IOException
        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
        Throws:
        java.io.IOException

      • seekExact

        public void seekExact​(long ord)
        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

      • docFreq

        public int docFreq()
        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

      • totalTermFreq

        public long totalTermFreq()
        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

      • 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