Class BaseTermsEnum

    • Constructor Detail

      • BaseTermsEnum

        protected BaseTermsEnum()
        Sole constructor. (For invocation by subclass constructors, typically implicit.)
    • 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).
        Specified by:
        seekExact in class TermsEnum
        Returns:
        true if the term is found; return false if the enum is unpositioned.
        Throws:
        java.io.IOException
      • seekExact

        public void seekExact​(BytesRef term,
                              TermState state)
                       throws java.io.IOException
        Description copied from class: TermsEnum
        Expert: Seeks a specific position by TermState previously obtained from TermsEnum.termState(). Callers should maintain the TermState to use this method. Low-level implementations may position the TermsEnum without re-seeking the term dictionary.

        Seeking by TermState should only be used iff the state was obtained from the same TermsEnum instance.

        NOTE: Using this method with an incompatible TermState might leave this TermsEnum in undefined state. On a segment level TermState instances are compatible only iff the source and the target TermsEnum operate on the same field. If operating on segment level, TermState instances must not be used across segments.

        NOTE: A seek by TermState might not restore the AttributeSource's state. AttributeSource states must be maintained separately if this method is used.

        Specified by:
        seekExact in class TermsEnum
        Parameters:
        term - the term the TermState corresponds to
        state - the TermState
        Throws:
        java.io.IOException