Class SimpleTextFieldsReader.SimpleTextTermsEnum
java.lang.Object
org.apache.lucene.index.TermsEnum
org.apache.lucene.index.BaseTermsEnum
org.apache.lucene.codecs.simpletext.SimpleTextFieldsReader.SimpleTextTermsEnum
- All Implemented Interfaces:
BytesRefIterator
- Enclosing class:
- SimpleTextFieldsReader
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private long
private boolean
private final BytesRefFSTEnum<PairOutputs.Pair<PairOutputs.Pair<Long,
Long>, PairOutputs.Pair<Long, Long>>> private final IndexOptions
private long
private long
-
Constructor Summary
ConstructorsConstructorDescriptionSimpleTextTermsEnum
(FST<PairOutputs.Pair<PairOutputs.Pair<Long, Long>, PairOutputs.Pair<Long, Long>>> fst, IndexOptions indexOptions) -
Method Summary
Modifier and TypeMethodDescriptionint
docFreq()
Returns the number of documents containing the current term.impacts
(int flags) Return aImpactsEnum
.next()
Increments the iteration to the nextBytesRef
in the iterator.long
ord()
Returns ordinal position for current term.postings
(PostingsEnum reuse, int flags) GetPostingsEnum
for the current term, with control over whether freqs, positions, offsets or payloads are required.Seeks to the specified term, if it exists, or to the next (ceiling) term.void
seekExact
(long ord) Seeks to the specified term by ordinal (position) as previously returned byTermsEnum.ord()
.boolean
Attempts to seek to the exact term, returning true if the term is found.term()
Returns current term.long
Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term).Methods inherited from class org.apache.lucene.index.BaseTermsEnum
attributes, seekExact, termState
-
Field Details
-
indexOptions
-
docFreq
private int docFreq -
totalTermFreq
private long totalTermFreq -
docsStart
private long docsStart -
skipPointer
private long skipPointer -
ended
private boolean ended -
fstEnum
private final BytesRefFSTEnum<PairOutputs.Pair<PairOutputs.Pair<Long,Long>, fstEnumPairOutputs.Pair<Long, Long>>>
-
-
Constructor Details
-
SimpleTextTermsEnum
public SimpleTextTermsEnum(FST<PairOutputs.Pair<PairOutputs.Pair<Long, Long>, PairOutputs.Pair<Long, Long>>> fst, IndexOptions indexOptions)
-
-
Method Details
-
seekExact
Description copied from class:TermsEnum
Attempts to seek to the exact term, returning true if the term is found. If this returns false, the enum is unpositioned. For some codecs, seekExact may be substantially faster thanTermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.- Overrides:
seekExact
in classBaseTermsEnum
- Returns:
- true if the term is found; return false if the enum is unpositioned.
- Throws:
IOException
-
seekCeil
Description copied from class:TermsEnum
Seeks to the specified term, if it exists, or to the next (ceiling) term. Returns SeekStatus to indicate whether exact term was found, a different term was found, or EOF was hit. The target term may be before or after the current term. If this returns SeekStatus.END, the enum is unpositioned.- Specified by:
seekCeil
in classTermsEnum
- Throws:
IOException
-
next
Description copied from interface:BytesRefIterator
Increments the iteration to the nextBytesRef
in the iterator. Returns the resultingBytesRef
ornull
if the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.- Returns:
- the next
BytesRef
in the iterator ornull
if the end of the iterator is reached. - Throws:
IOException
- If there is a low-level I/O error.
-
term
Description copied from class:TermsEnum
Returns current term. Do not call this when the enum is unpositioned. -
ord
Description copied from class:TermsEnum
Returns ordinal position for current term. This is an optional method (the codec may throwUnsupportedOperationException
). Do not call this when the enum is unpositioned.- Specified by:
ord
in classTermsEnum
- Throws:
IOException
-
seekExact
public void seekExact(long ord) Description copied from class:TermsEnum
Seeks to the specified term by ordinal (position) as previously returned byTermsEnum.ord()
. The target ord may be before or after the current ord, and must be within bounds. -
docFreq
public int docFreq()Description copied from class:TermsEnum
Returns the number of documents containing the current term. Do not call this when the enum is unpositioned.TermsEnum.SeekStatus.END
. -
totalTermFreq
public long totalTermFreq()Description copied from class:TermsEnum
Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term). Note that, like other term measures, this measure does not take deleted documents into account.- Specified by:
totalTermFreq
in classTermsEnum
-
postings
Description copied from class:TermsEnum
GetPostingsEnum
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
.- Specified by:
postings
in classTermsEnum
- Parameters:
reuse
- pass a prior PostingsEnum for possible reuseflags
- specifies which optional per-document values you require; seePostingsEnum.FREQS
- Throws:
IOException
-
impacts
Description copied from class:TermsEnum
Return aImpactsEnum
.- Specified by:
impacts
in classTermsEnum
- Throws:
IOException
- See Also:
-