Class IDVersionSegmentTermsEnum
- java.lang.Object
-
- org.apache.lucene.index.TermsEnum
-
- org.apache.lucene.index.BaseTermsEnum
-
- org.apache.lucene.sandbox.codecs.idversion.IDVersionSegmentTermsEnum
-
- All Implemented Interfaces:
BytesRefIterator
public final class IDVersionSegmentTermsEnum extends BaseTermsEnum
Iterates through terms in this field; this class is public so users can cast it to callseekExact(BytesRef, long)
for optimistic-concurrency, and alsogetVersion()
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
Fields Modifier and Type Field Description private FST.Arc<PairOutputs.Pair<BytesRef,java.lang.Long>>[]
arcs
(package private) IDVersionSegmentTermsEnumFrame
currentFrame
private boolean
eof
(package private) VersionFieldReader
fr
private FST.BytesReader
fstReader
(package private) IndexInput
in
private ByteArrayDataInput
scratchReader
private IDVersionSegmentTermsEnumFrame[]
stack
private IDVersionSegmentTermsEnumFrame
staticFrame
private int
targetBeforeCurrentLength
(package private) BytesRefBuilder
term
(package private) boolean
termExists
private int
validIndexPrefix
-
Constructor Summary
Constructors Constructor Description IDVersionSegmentTermsEnum(VersionFieldReader fr)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) static java.lang.String
brToString(BytesRef b)
private boolean
clearEOF()
int
docFreq()
Returns the number of documents containing the current term.private FST.Arc<PairOutputs.Pair<BytesRef,java.lang.Long>>
getArc(int ord)
private IDVersionSegmentTermsEnumFrame
getFrame(int ord)
long
getVersion()
Get the version of the currently seek'd term; only valid if we are positioned.ImpactsEnum
impacts(int flags)
Return aImpactsEnum
.(package private) void
initIndexInput()
BytesRef
next()
Increments the iteration to the nextBytesRef
in the iterator.long
ord()
Returns ordinal position for current term.PostingsEnum
postings(PostingsEnum reuse, int flags)
GetPostingsEnum
for the current term, with control over whether freqs, positions, offsets or payloads are required.private void
printSeekState(java.io.PrintStream out)
(package private) IDVersionSegmentTermsEnumFrame
pushFrame(FST.Arc<PairOutputs.Pair<BytesRef,java.lang.Long>> arc, long fp, int length)
(package private) IDVersionSegmentTermsEnumFrame
pushFrame(FST.Arc<PairOutputs.Pair<BytesRef,java.lang.Long>> arc, PairOutputs.Pair<BytesRef,java.lang.Long> frameData, int length)
TermsEnum.SeekStatus
seekCeil(BytesRef target)
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
seekExact(BytesRef target)
Attempts to seek to the exact term, returning true if the term is found.boolean
seekExact(BytesRef target, long minIDVersion)
Optimized version ofseekExact(BytesRef)
that can sometimes fail-fast if the version indexed with the requested ID is less than the specified minIDVersion.void
seekExact(BytesRef target, TermState otherState)
Expert: Seeks a specific position byTermState
previously obtained fromTermsEnum.termState()
.private boolean
setEOF()
BytesRef
term()
Returns current term.TermState
termState()
Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.java.lang.String
toString()
long
totalTermFreq()
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 Detail
-
in
IndexInput in
-
stack
private IDVersionSegmentTermsEnumFrame[] stack
-
staticFrame
private final IDVersionSegmentTermsEnumFrame staticFrame
-
currentFrame
IDVersionSegmentTermsEnumFrame currentFrame
-
termExists
boolean termExists
-
fr
final VersionFieldReader fr
-
targetBeforeCurrentLength
private int targetBeforeCurrentLength
-
scratchReader
private final ByteArrayDataInput scratchReader
-
validIndexPrefix
private int validIndexPrefix
-
eof
private boolean eof
-
term
final BytesRefBuilder term
-
fstReader
private final FST.BytesReader fstReader
-
arcs
private FST.Arc<PairOutputs.Pair<BytesRef,java.lang.Long>>[] arcs
-
-
Constructor Detail
-
IDVersionSegmentTermsEnum
IDVersionSegmentTermsEnum(VersionFieldReader fr) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
initIndexInput
void initIndexInput()
-
getFrame
private IDVersionSegmentTermsEnumFrame getFrame(int ord) throws java.io.IOException
- Throws:
java.io.IOException
-
getArc
private FST.Arc<PairOutputs.Pair<BytesRef,java.lang.Long>> getArc(int ord)
-
pushFrame
IDVersionSegmentTermsEnumFrame pushFrame(FST.Arc<PairOutputs.Pair<BytesRef,java.lang.Long>> arc, PairOutputs.Pair<BytesRef,java.lang.Long> frameData, int length) throws java.io.IOException
- Throws:
java.io.IOException
-
pushFrame
IDVersionSegmentTermsEnumFrame pushFrame(FST.Arc<PairOutputs.Pair<BytesRef,java.lang.Long>> arc, long fp, int length) throws java.io.IOException
- Throws:
java.io.IOException
-
clearEOF
private boolean clearEOF()
-
setEOF
private boolean setEOF()
-
seekExact
public boolean seekExact(BytesRef target) throws java.io.IOException
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:
java.io.IOException
-
brToString
static java.lang.String brToString(BytesRef b)
-
getVersion
public long getVersion()
Get the version of the currently seek'd term; only valid if we are positioned.
-
seekExact
public boolean seekExact(BytesRef target, long minIDVersion) throws java.io.IOException
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:
java.io.IOException
-
seekCeil
public TermsEnum.SeekStatus seekCeil(BytesRef target) throws java.io.IOException
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.
-
printSeekState
private void printSeekState(java.io.PrintStream out) throws java.io.IOException
- Throws:
java.io.IOException
-
next
public BytesRef next() throws java.io.IOException
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:
java.io.IOException
- If there is a low-level I/O error.
-
term
public BytesRef term()
Description copied from class:TermsEnum
Returns current term. Do not call this when the enum is unpositioned.
-
docFreq
public int docFreq() throws java.io.IOException
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() throws java.io.IOException
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:
java.io.IOException
-
postings
public PostingsEnum postings(PostingsEnum reuse, int flags) throws java.io.IOException
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:
java.io.IOException
-
impacts
public ImpactsEnum impacts(int flags) throws java.io.IOException
Description copied from class:TermsEnum
Return aImpactsEnum
.- Specified by:
impacts
in classTermsEnum
- Throws:
java.io.IOException
- See Also:
TermsEnum.postings(PostingsEnum, int)
-
seekExact
public void seekExact(BytesRef target, TermState otherState)
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
public TermState termState() throws java.io.IOException
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:
java.io.IOException
- See Also:
TermState
,TermsEnum.seekExact(BytesRef, TermState)
-
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
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-