Module org.apache.lucene.join

Package org.apache.lucene.search.join

Class SeekingTermSetTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.index.FilteredTermsEnum

org.apache.lucene.search.join.SeekingTermSetTermsEnum

All Implemented Interfaces:

BytesRefIterator

public class SeekingTermSetTermsEnum
extends FilteredTermsEnum

A filtered TermsEnum that uses a BytesRefHash as a filter

Nested Class Summary

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

FilteredTermsEnum.AcceptStatus

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

TermsEnum.SeekStatus

Field Summary

Fields

Modifier and Type	Field	Description
private final int	lastElement
private final BytesRef	lastTerm
private final int[]	ords
private BytesRef	seekTerm
private final BytesRef	spare
private final BytesRefHash	terms
private int	upto

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

actualTerm, tenum

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
SeekingTermSetTermsEnum(TermsEnum tenum, BytesRefHash terms, int[] ords)	Constructor

Method Summary

Modifier and Type	Method	Description
protected FilteredTermsEnum.AcceptStatus	accept(BytesRef term)	Return if term is accepted, not accepted or the iteration should ended (and possibly seek).
protected BytesRef	nextSeekTerm(BytesRef currentTerm)	On the first call to FilteredTermsEnum.next() or if FilteredTermsEnum.accept(org.apache.lucene.util.BytesRef) returns FilteredTermsEnum.AcceptStatus.YES_AND_SEEK or FilteredTermsEnum.AcceptStatus.NO_AND_SEEK, this method will be called to eventually seek the underlying TermsEnum to a new position.

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

attributes, docFreq, impacts, next, ord, postings, seekCeil, seekExact, seekExact, seekExact, setInitialSeekTerm, 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 Details

terms

private final BytesRefHash terms

ords

private final int[] ords

lastElement

private final int lastElement

lastTerm

private final BytesRef lastTerm

spare

private final BytesRef spare

seekTerm

private BytesRef seekTerm

upto

private int upto

Constructor Details

SeekingTermSetTermsEnum

public SeekingTermSetTermsEnum(TermsEnum tenum,
 BytesRefHash terms,
 int[] ords)

Constructor

Method Details

nextSeekTerm

protected BytesRef nextSeekTerm(BytesRef currentTerm)
                         throws IOException

Description copied from class: FilteredTermsEnum

On the first call to FilteredTermsEnum.next() or if FilteredTermsEnum.accept(org.apache.lucene.util.BytesRef) returns FilteredTermsEnum.AcceptStatus.YES_AND_SEEK or FilteredTermsEnum.AcceptStatus.NO_AND_SEEK, this method will be called to eventually seek the underlying TermsEnum to a new position. On the first call, currentTerm will be null, later calls will provide the term the underlying enum is positioned at. This method returns per default only one time the initial seek term and then null, so no repositioning is ever done.

Override this method, if you want a more sophisticated TermsEnum, that repositions the iterator during enumeration. If this method always returns null the enum is empty.

Please note: This method should always provide a greater term than the last enumerated term, else the behaviour of this enum violates the contract for TermsEnums.

Overrides:

nextSeekTerm in class FilteredTermsEnum

Throws:

IOException

accept

protected FilteredTermsEnum.AcceptStatus accept(BytesRef term)
                                         throws IOException

Description copied from class: FilteredTermsEnum

Return if term is accepted, not accepted or the iteration should ended (and possibly seek).

Specified by:

accept in class FilteredTermsEnum

Throws:

IOException