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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BytesRefgetMax()Returns the largest term (in lexicographic order) in the field.BytesRefgetMin()Returns the smallest term (in lexicographic order) in the field.TermsEnumintersect(CompiledAutomaton compiled, BytesRef startTerm)Returns a TermsEnum that iterates over all terms and documents that are accepted by the providedCompiledAutomaton.TermsEnumiterator()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
-
-
-
-
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:TermsReturns a TermsEnum that iterates over all terms and documents that are accepted by the providedCompiledAutomaton. If thestartTermis 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 providedstartTermmust be accepted by the automaton.This is an expert low-level API and will only work for
NORMALcompiled automata. To handle any compiled automata you should instead useCompiledAutomaton.getTermsEnum(org.apache.lucene.index.Terms)instead.NOTE: the returned TermsEnum cannot seek.
- Overrides:
intersectin classTerms- Throws:
IOException
-
iterator
public TermsEnum iterator() throws IOException
Description copied from class:TermsReturns an iterator that will step through all terms. This method will not return null.- Overrides:
iteratorin classFilterLeafReader.FilterTerms- Throws:
IOException
-
getMin
public BytesRef getMin() throws IOException
Description copied from class:TermsReturns the smallest term (in lexicographic order) in the field. Note that, just like other term measures, this measure does not take deleted documents into account. This returns null when there are no terms.- Overrides:
getMinin classTerms- Throws:
IOException
-
getMax
public BytesRef getMax() throws IOException
Description copied from class:TermsReturns the largest term (in lexicographic order) in the field. Note that, just like other term measures, this measure does not take deleted documents into account. This returns null when there are no terms.- Overrides:
getMaxin classTerms- Throws:
IOException
-
-