Package org.apache.lucene.index

Class ExitableDirectoryReader.ExitableTerms

java.lang.Object

org.apache.lucene.index.Terms

org.apache.lucene.index.FilterLeafReader.FilterTerms

org.apache.lucene.index.ExitableDirectoryReader.ExitableTerms

Enclosing class:

ExitableDirectoryReader

public static class ExitableDirectoryReader.ExitableTerms
extends FilterLeafReader.FilterTerms

Wrapper class for another Terms implementation that is used by ExitableFields.

Field Summary

Fields inherited from class org.apache.lucene.index.FilterLeafReader.FilterTerms

in

Fields inherited from class org.apache.lucene.index.Terms

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
ExitableTerms(Terms terms, QueryTimeout queryTimeout)	Constructor

Method Summary

Modifier and Type	Method	Description
TermsEnum	intersect(CompiledAutomaton compiled, BytesRef startTerm)	Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided CompiledAutomaton.
TermsEnum	iterator()	Returns an iterator that will step through all terms.

Methods inherited from class org.apache.lucene.index.FilterLeafReader.FilterTerms

getDocCount, getStats, getSumDocFreq, getSumTotalTermFreq, hasFreqs, hasOffsets, hasPayloads, hasPositions, size

Methods inherited from class org.apache.lucene.index.Terms

getMax, getMin

Methods inherited from class java.lang.Object

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

Constructor Detail

ExitableTerms

public ExitableTerms(Terms terms,
                     QueryTimeout queryTimeout)

Constructor

Method Detail

intersect

public TermsEnum intersect(CompiledAutomaton compiled,
                           BytesRef startTerm)
                    throws IOException

Description copied from class: Terms

Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided CompiledAutomaton. If the startTerm is provided then the returned enum will only return 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.

This is an expert low-level API and will only work for NORMAL compiled automata. To handle any compiled automata you should instead use CompiledAutomaton.getTermsEnum(org.apache.lucene.index.Terms) instead.

NOTE: the returned TermsEnum cannot seek

.

NOTE: the terms dictionary is free to return arbitrary terms as long as the resulted visited docs is the same. E.g., BlockTreeTermsWriter creates auto-prefix terms during indexing to reduce the number of terms visited.

Overrides:

intersect in class Terms

Throws:

IOException

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.

Overrides:

iterator in class FilterLeafReader.FilterTerms

Throws:

IOException