Method Detail

intersect

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.

iterator

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.

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). Note that, just like other term
measures, this measure does not take deleted documents
into account.

getSumDocFreq

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.

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. Note that, just like other term
measures, this measure does not take deleted documents
into account.

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.