org.apache.lucene.index

Class SortingLeafReader.SortingTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.index.FilterLeafReader.FilterTermsEnum

org.apache.lucene.index.SortingLeafReader.SortingTermsEnum

All Implemented Interfaces:

BytesRefIterator

Enclosing class:

SortingLeafReader

private static class SortingLeafReader.SortingTermsEnum
extends FilterLeafReader.FilterTermsEnum

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum

TermsEnum.SeekStatus

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Sorter.DocMap	docMap
private boolean	hasPositions
private IndexOptions	indexOptions

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

in

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
SortingTermsEnum(TermsEnum in, Sorter.DocMap docMap, IndexOptions indexOptions, boolean hasPositions)

Method Summary

Modifier and Type	Method and Description
PostingsEnum	postings(PostingsEnum reuse, int flags) Get PostingsEnum for the current term, with control over whether freqs, positions, offsets or payloads are required.

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

attributes, docFreq, impacts, next, ord, seekCeil, seekExact, seekExact, seekExact, term, termState, totalTermFreq

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

postings

Methods inherited from class java.lang.Object

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

Field Detail

docMap

final Sorter.DocMap docMap

indexOptions

private final IndexOptions indexOptions

hasPositions

private final boolean hasPositions

Constructor Detail

SortingTermsEnum

public SortingTermsEnum(TermsEnum in,
                        Sorter.DocMap docMap,
                        IndexOptions indexOptions,
                        boolean hasPositions)

Method Detail

postings

public PostingsEnum postings(PostingsEnum reuse,
                             int flags)
                      throws java.io.IOException

Description copied from class: TermsEnum

Get PostingsEnum for the current term, with control over whether freqs, positions, offsets or payloads are required. Do not call this when the enum is unpositioned. This method will not return null.

NOTE: the returned iterator may return deleted documents, so deleted documents have to be checked on top of the PostingsEnum.

Overrides:

postings in class FilterLeafReader.FilterTermsEnum

Parameters:

reuse - pass a prior PostingsEnum for possible reuse

flags - specifies which optional per-document values you require; see PostingsEnum.FREQS

Throws:

java.io.IOException