java.lang.Object
org.apache.lucene.index.TermsEnum
org.apache.lucene.index.FilteredTermsEnum
org.apache.lucene.search.join.SeekingTermSetTermsEnum
- All Implemented Interfaces:
BytesRefIterator
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
FieldsModifier and TypeFieldDescriptionprivate final int
private final BytesRef
private final int[]
private BytesRef
private final BytesRef
private final BytesRefHash
private int
Fields inherited from class org.apache.lucene.index.FilteredTermsEnum
actualTerm, tenum
-
Constructor Summary
ConstructorsConstructorDescriptionSeekingTermSetTermsEnum
(TermsEnum tenum, BytesRefHash terms, int[] ords) Constructor -
Method Summary
Modifier and TypeMethodDescriptionprotected FilteredTermsEnum.AcceptStatus
Return if term is accepted, not accepted or the iteration should ended (and possibly seek).protected BytesRef
nextSeekTerm
(BytesRef currentTerm) On the first call toFilteredTermsEnum.next()
or ifFilteredTermsEnum.accept(org.apache.lucene.util.BytesRef)
returnsFilteredTermsEnum.AcceptStatus.YES_AND_SEEK
orFilteredTermsEnum.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, prepareSeekExact, seekCeil, seekExact, seekExact, seekExact, setInitialSeekTerm, term, termState, totalTermFreq
-
Field Details
-
terms
-
ords
private final int[] ords -
lastElement
private final int lastElement -
lastTerm
-
spare
-
seekTerm
-
upto
private int upto
-
-
Constructor Details
-
SeekingTermSetTermsEnum
Constructor
-
-
Method Details
-
nextSeekTerm
Description copied from class:FilteredTermsEnum
On the first call toFilteredTermsEnum.next()
or ifFilteredTermsEnum.accept(org.apache.lucene.util.BytesRef)
returnsFilteredTermsEnum.AcceptStatus.YES_AND_SEEK
orFilteredTermsEnum.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 benull
, 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 thennull
, 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 classFilteredTermsEnum
- Throws:
IOException
-
accept
Description copied from class:FilteredTermsEnum
Return if term is accepted, not accepted or the iteration should ended (and possibly seek).- Specified by:
accept
in classFilteredTermsEnum
- Throws:
IOException
-