Package org.apache.lucene.index

Class FilterLeafReader.FilterTerms

java.lang.Object
org.apache.lucene.index.Terms
org.apache.lucene.index.FilterLeafReader.FilterTerms
Direct Known Subclasses:
ExitableDirectoryReader.ExitableTerms
Enclosing class:
FilterLeafReader
public abstract static class FilterLeafReader.FilterTerms extends Terms
Base class for filtering Terms implementations.

NOTE: If the order of terms and documents is not changed, and if these terms are going to be intersected with automata, you could consider overriding Terms.intersect(org.apache.lucene.util.automaton.CompiledAutomaton, org.apache.lucene.util.BytesRef) for better performance.

  • Field Details

    • in

      protected final Terms in
      The underlying Terms instance.

  • Constructor Details

    • FilterTerms

      protected FilterTerms(Terms in)
      Creates a new FilterTerms
      Parameters:
      in - the underlying Terms instance.

  • Method Details

    • iterator

      public TermsEnum iterator() throws IOException
      Description copied from class: Terms
      Returns an iterator that will step through all terms. This method will not return null.
      Specified by:
      iterator in class Terms
      Throws:
      IOException

    • size

      public long size() throws IOException
      Description copied from class: Terms
      Returns the number of terms for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.
      Specified by:
      size in class Terms
      Throws:
      IOException

    • getSumTotalTermFreq

      public long getSumTotalTermFreq() throws IOException
      Description copied from class: Terms
      Returns the sum of TermsEnum.totalTermFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.
      Specified by:
      getSumTotalTermFreq in class Terms
      Throws:
      IOException

    • getSumDocFreq

      public long getSumDocFreq() throws IOException
      Description copied from class: Terms
      Returns the sum of TermsEnum.docFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.
      Specified by:
      getSumDocFreq in class Terms
      Throws:
      IOException

    • getDocCount

      public int getDocCount() throws IOException
      Description copied from class: Terms
      Returns the number of documents that have at least one term for this field. Note that, just like other term measures, this measure does not take deleted documents into account.
      Specified by:
      getDocCount in class Terms
      Throws:
      IOException

    • hasFreqs

      public boolean hasFreqs()
      Description copied from class: Terms
      Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).
      Specified by:
      hasFreqs in class Terms

    • hasOffsets

      public boolean hasOffsets()
      Description copied from class: Terms
      Returns true if documents in this field store offsets.
      Specified by:
      hasOffsets in class Terms

    • hasPositions

      public boolean hasPositions()
      Description copied from class: Terms
      Returns true if documents in this field store positions.
      Specified by:
      hasPositions in class Terms

    • hasPayloads

      public boolean hasPayloads()
      Description copied from class: Terms
      Returns true if documents in this field store payloads.
      Specified by:
      hasPayloads in class Terms

    • getStats

      public Object getStats() throws IOException
      Description copied from class: Terms
      Expert: returns additional information about this Terms instance for debugging purposes.
      Overrides:
      getStats in class Terms
      Throws:
      IOException