org.apache.lucene.index

Class SortingLeafReader.SortingTerms

java.lang.Object

org.apache.lucene.index.Terms

org.apache.lucene.index.FilterLeafReader.FilterTerms

org.apache.lucene.index.SortingLeafReader.SortingTerms

Enclosing class:

SortingLeafReader

private static class SortingLeafReader.SortingTerms
extends FilterLeafReader.FilterTerms

Field Summary

Fields

Modifier and Type	Field and Description
private Sorter.DocMap	docMap
private IndexOptions	indexOptions

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 and Description
SortingTerms(Terms in, IndexOptions indexOptions, Sorter.DocMap docMap)

Method Summary

Modifier and Type	Method and 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

Field Detail

docMap

private final Sorter.DocMap docMap

indexOptions

private final IndexOptions indexOptions

Constructor Detail

SortingTerms

public SortingTerms(Terms in,
                    IndexOptions indexOptions,
                    Sorter.DocMap docMap)

Method Detail

iterator

public TermsEnum iterator()
                   throws java.io.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:

java.io.IOException

intersect

public TermsEnum intersect(CompiledAutomaton compiled,
                           BytesRef startTerm)
                    throws java.io.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

.

Overrides:

intersect in class Terms

Throws:

java.io.IOException