Package org.apache.lucene.index

Class Terms

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Terms[] EMPTY_ARRAY
      Zero-length array of Terms.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract java.util.Comparator<BytesRef> getComparator()
      Return the BytesRef Comparator used to sort terms provided by the iterator.
      abstract int getDocCount()
      Returns the number of documents that have at least one term for this field, or -1 if this measure isn't stored by the codec.
      abstract long getSumDocFreq()
      Returns the sum of TermsEnum.docFreq() for all terms in this field, or -1 if this measure isn't stored by the codec.
      abstract long getSumTotalTermFreq()
      Returns the sum of TermsEnum.totalTermFreq() for all terms in this field, or -1 if this measure isn't stored by the codec (or if this fields omits term freq and positions).
      abstract boolean hasFreqs()
      Returns true if documents in this field store per-document term frequency (DocsEnum.freq()).
      abstract boolean hasOffsets()
      Returns true if documents in this field store offsets.
      abstract boolean hasPayloads()
      Returns true if documents in this field store payloads.
      abstract boolean hasPositions()
      Returns true if documents in this field store positions.
      TermsEnum intersect​(CompiledAutomaton compiled, BytesRef startTerm)
      Returns a TermsEnum that iterates over all terms that are accepted by the provided CompiledAutomaton.
      abstract TermsEnum iterator​(TermsEnum reuse)
      Returns an iterator that will step through all terms.
      abstract long size()
      Returns the number of terms for this field, or -1 if this measure isn't stored by the codec.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • EMPTY_ARRAY

        public static final Terms[] EMPTY_ARRAY
        Zero-length array of Terms.

    • Method Detail

      • iterator

        public abstract TermsEnum iterator​(TermsEnum reuse)
                            throws java.io.IOException
        Returns an iterator that will step through all terms. This method will not return null. If you have a previous TermsEnum, for example from a different field, you can pass it for possible reuse if the implementation can do so.
        Throws:
        java.io.IOException

      • intersect

        public TermsEnum intersect​(CompiledAutomaton compiled,
                           BytesRef startTerm)
                    throws java.io.IOException
        Returns a TermsEnum that iterates over all terms that are accepted by the provided CompiledAutomaton. If the startTerm is provided then the returned enum will only accept terms > startTerm, but you still must call next() first to get to the first term. Note that the provided startTerm must be accepted by the automaton.

        NOTE: the returned TermsEnum cannot seek

        .
        Throws:
        java.io.IOException

      • getComparator

        public abstract java.util.Comparator<BytesRef> getComparator()
        Return the BytesRef Comparator used to sort terms provided by the iterator. This method may return null if there are no terms. This method may be invoked many times; it's best to cache a single instance & reuse it.

      • size

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

      • getSumTotalTermFreq

        public abstract long getSumTotalTermFreq()
                                  throws java.io.IOException
        Returns the sum of TermsEnum.totalTermFreq() for all terms in this field, or -1 if this measure isn't stored by the codec (or if this fields omits term freq and positions). Note that, just like other term measures, this measure does not take deleted documents into account.
        Throws:
        java.io.IOException

      • getSumDocFreq

        public abstract long getSumDocFreq()
                            throws java.io.IOException
        Returns the sum of TermsEnum.docFreq() for all terms in 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.
        Throws:
        java.io.IOException

      • getDocCount

        public abstract int getDocCount()
                         throws java.io.IOException
        Returns the number of documents that have at least one term 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.
        Throws:
        java.io.IOException

      • hasFreqs

        public abstract boolean hasFreqs()
        Returns true if documents in this field store per-document term frequency (DocsEnum.freq()).

      • hasOffsets

        public abstract boolean hasOffsets()
        Returns true if documents in this field store offsets.

      • hasPositions

        public abstract boolean hasPositions()
        Returns true if documents in this field store positions.

      • hasPayloads

        public abstract boolean hasPayloads()
        Returns true if documents in this field store payloads.