Class SegmentTermsEnum
- java.lang.Object
-
- org.apache.lucene.index.TermsEnum
-
- org.apache.lucene.index.BaseTermsEnum
-
- org.apache.lucene.codecs.blocktree.SegmentTermsEnum
-
- All Implemented Interfaces:
BytesRefIterator
final class SegmentTermsEnum extends BaseTermsEnum
Iterates through terms in this field.
-
-
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<BytesRef>[]
arcs
(package private) SegmentTermsEnumFrame
currentFrame
private boolean
eof
(package private) FieldReader
fr
private FST.BytesReader
fstReader
(package private) IndexInput
in
private ByteArrayDataInput
scratchReader
private SegmentTermsEnumFrame[]
stack
private SegmentTermsEnumFrame
staticFrame
private int
targetBeforeCurrentLength
(package private) BytesRefBuilder
term
(package private) boolean
termExists
private int
validIndexPrefix
-
Constructor Summary
Constructors Constructor Description SegmentTermsEnum(FieldReader fr)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private boolean
clearEOF()
Stats
computeBlockStats()
Runs next() through the entire terms dict, computing aggregate statistics.int
docFreq()
Returns the number of documents containing the current term.private FST.Arc<BytesRef>
getArc(int ord)
private SegmentTermsEnumFrame
getFrame(int ord)
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) SegmentTermsEnumFrame
pushFrame(FST.Arc<BytesRef> arc, long fp, int length)
(package private) SegmentTermsEnumFrame
pushFrame(FST.Arc<BytesRef> arc, BytesRef 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.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.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 SegmentTermsEnumFrame[] stack
-
staticFrame
private final SegmentTermsEnumFrame staticFrame
-
currentFrame
SegmentTermsEnumFrame currentFrame
-
termExists
boolean termExists
-
fr
final FieldReader 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
-
-
Constructor Detail
-
SegmentTermsEnum
public SegmentTermsEnum(FieldReader fr) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
initIndexInput
void initIndexInput()
-
computeBlockStats
public Stats computeBlockStats() throws java.io.IOException
Runs next() through the entire terms dict, computing aggregate statistics.- Throws:
java.io.IOException
-
getFrame
private SegmentTermsEnumFrame getFrame(int ord) throws java.io.IOException
- Throws:
java.io.IOException
-
pushFrame
SegmentTermsEnumFrame pushFrame(FST.Arc<BytesRef> arc, BytesRef frameData, int length) throws java.io.IOException
- Throws:
java.io.IOException
-
pushFrame
SegmentTermsEnumFrame pushFrame(FST.Arc<BytesRef> 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
-
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.
-
-