Class IDVersionSegmentTermsEnum
- All Implemented Interfaces:
BytesRefIterator
seekExact(BytesRef, long)
for optimistic-concurrency, and also getVersion()
to get the
version of the currently seek'd term.-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate FST.Arc<PairOutputs.Pair<BytesRef,
Long>>[] (package private) IDVersionSegmentTermsEnumFrame
private boolean
(package private) final VersionFieldReader
private final FST.BytesReader
(package private) IndexInput
private final ByteArrayDataInput
private IDVersionSegmentTermsEnumFrame[]
private final IDVersionSegmentTermsEnumFrame
private int
(package private) final BytesRefBuilder
(package private) boolean
private int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) static String
private boolean
clearEOF()
int
docFreq()
Returns the number of documents containing the current term.private FST.Arc<PairOutputs.Pair<BytesRef,
Long>> getArc
(int ord) private IDVersionSegmentTermsEnumFrame
getFrame
(int ord) long
Get the version of the currently seek'd term; only valid if we are positioned.impacts
(int flags) Return aImpactsEnum
.(package private) void
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.private void
(package private) IDVersionSegmentTermsEnumFrame
pushFrame
(FST.Arc<PairOutputs.Pair<BytesRef, Long>> arc, long fp, int length) (package private) IDVersionSegmentTermsEnumFrame
pushFrame
(FST.Arc<PairOutputs.Pair<BytesRef, Long>> arc, PairOutputs.Pair<BytesRef, Long> frameData, int length) 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.boolean
Optimized version ofseekExact(BytesRef)
that can sometimes fail-fast if the version indexed with the requested ID is less than the specified minIDVersion.void
Expert: Seeks a specific position byTermState
previously obtained fromTermsEnum.termState()
.private boolean
setEOF()
term()
Returns current term.Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.toString()
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
-
Field Details
-
in
IndexInput in -
stack
-
staticFrame
-
currentFrame
IDVersionSegmentTermsEnumFrame currentFrame -
termExists
boolean termExists -
fr
-
targetBeforeCurrentLength
private int targetBeforeCurrentLength -
scratchReader
-
validIndexPrefix
private int validIndexPrefix -
eof
private boolean eof -
term
-
fstReader
-
arcs
-
-
Constructor Details
-
IDVersionSegmentTermsEnum
IDVersionSegmentTermsEnum(VersionFieldReader fr) throws IOException - Throws:
IOException
-
-
Method Details
-
initIndexInput
void initIndexInput() -
getFrame
- Throws:
IOException
-
getArc
-
pushFrame
IDVersionSegmentTermsEnumFrame pushFrame(FST.Arc<PairOutputs.Pair<BytesRef, Long>> arc, PairOutputs.Pair<BytesRef, throws IOExceptionLong> frameData, int length) - Throws:
IOException
-
pushFrame
IDVersionSegmentTermsEnumFrame pushFrame(FST.Arc<PairOutputs.Pair<BytesRef, Long>> arc, long fp, int length) throws IOException- Throws:
IOException
-
clearEOF
private boolean clearEOF() -
setEOF
private boolean setEOF() -
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
-
brToString
-
getVersion
public long getVersion()Get the version of the currently seek'd term; only valid if we are positioned. -
seekExact
Optimized version ofseekExact(BytesRef)
that can sometimes fail-fast if the version indexed with the requested ID is less than the specified minIDVersion. Applications that index a monotonically increasing global version with each document can use this for fast optimistic concurrency.- 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
-
printSeekState
- 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. -
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
.- Specified by:
docFreq
in classTermsEnum
- Throws:
IOException
-
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
- Throws:
IOException
-
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:
-
seekExact
Description copied from class:TermsEnum
Expert: Seeks a specific position byTermState
previously obtained fromTermsEnum.termState()
. Callers should maintain theTermState
to use this method. Low-level implementations may position the TermsEnum without re-seeking the term dictionary.Seeking by
TermState
should only be used iff the state was obtained from the sameTermsEnum
instance.NOTE: Using this method with an incompatible
TermState
might leave thisTermsEnum
in undefined state. On a segment levelTermState
instances are compatible only iff the source and the targetTermsEnum
operate on the same field. If operating on segment level, TermState instances must not be used across segments.NOTE: A seek by
TermState
might not restore theAttributeSource
's state.AttributeSource
states must be maintained separately if this method is used.- Overrides:
seekExact
in classBaseTermsEnum
- Parameters:
target
- the term the TermState corresponds tootherState
- theTermState
-
termState
Description copied from class:TermsEnum
Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.NOTE: A seek by
TermState
might not capture theAttributeSource
's state. Callers must maintain theAttributeSource
states separately- Overrides:
termState
in classBaseTermsEnum
- Throws:
IOException
- See Also:
-
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. -
ord
public long 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. -
toString
-