Class IntersectTermsEnum
java.lang.Object
org.apache.lucene.index.TermsEnum
org.apache.lucene.index.BaseTermsEnum
org.apache.lucene.codecs.lucene90.blocktree.IntersectTermsEnum
- All Implemented Interfaces:
BytesRefIterator
This is used to implement efficient
Terms.intersect(org.apache.lucene.util.automaton.CompiledAutomaton, org.apache.lucene.util.BytesRef)
for block-tree. Note that it cannot
seek, except for the initial term on init. It just "nexts" through the intersection of the
automaton and the terms. It does not use the terms index at all: on init, it loads the root
block, and scans its way to the initial term. Likewise, in next it scans until it finds a term
that matches the current automaton transition.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final Automaton
(package private) final BytesRef
private IntersectTermsEnumFrame
private Transition
(package private) final FieldReader
private final FST.BytesReader
(package private) final IndexInput
(package private) final RunAutomaton
private BytesRef
(package private) IntersectTermsEnumFrame[]
private final BytesRef
-
Constructor Summary
ConstructorsConstructorDescriptionIntersectTermsEnum
(FieldReader fr, Automaton automaton, RunAutomaton runAutomaton, BytesRef commonSuffix, BytesRef startTerm) -
Method Summary
Modifier and TypeMethodDescriptionprivate BytesRef
_next()
(package private) static String
private void
copyTerm()
int
docFreq()
Returns the number of documents containing the current term.getArc
(int ord) private IntersectTermsEnumFrame
getFrame
(int ord) private int
getState()
impacts
(int flags) Return aImpactsEnum
.next()
Increments the iteration to the nextBytesRef
in the iterator.long
ord()
Returns ordinal position for current term.private boolean
postings
(PostingsEnum reuse, int flags) GetPostingsEnum
for the current term, with control over whether freqs, positions, offsets or payloads are required.private IntersectTermsEnumFrame
pushFrame
(int state) 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.private void
seekToStartTerm
(BytesRef target) private boolean
setSavedStartTerm
(BytesRef startTerm) term()
Returns current term.Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.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
-
Field Details
-
in
-
fstOutputs
-
stack
IntersectTermsEnumFrame[] stack -
arcs
-
runAutomaton
-
automaton
-
commonSuffix
-
currentFrame
-
currentTransition
-
term
-
fstReader
-
fr
-
savedStartTerm
-
-
Constructor Details
-
IntersectTermsEnum
public IntersectTermsEnum(FieldReader fr, Automaton automaton, RunAutomaton runAutomaton, BytesRef commonSuffix, BytesRef startTerm) throws IOException - Throws:
IOException
-
-
Method Details
-
setSavedStartTerm
-
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:
-
getFrame
- Throws:
IOException
-
getArc
-
pushFrame
- Throws:
IOException
-
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:
-
getState
private int getState() -
seekToStartTerm
- Throws:
IOException
-
popPushNext
- 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.
-
_next
- Throws:
IOException
-
brToString
-
copyTerm
private void copyTerm() -
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.
-
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. -
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.
-