Class IntersectTermsEnum
- java.lang.Object
-
- org.apache.lucene.index.TermsEnum
-
- org.apache.lucene.index.BaseTermsEnum
-
- org.apache.lucene.backward_codecs.lucene40.blocktree.IntersectTermsEnum
-
- All Implemented Interfaces:
BytesRefIterator
final class IntersectTermsEnum extends BaseTermsEnum
This is used to implement efficientTerms.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 Classes Modifier and Type Class Description private static class
IntersectTermsEnum.NoMoreTermsException
-
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) Automaton
automaton
(package private) BytesRef
commonSuffix
private IntersectTermsEnumFrame
currentFrame
private Transition
currentTransition
(package private) FieldReader
fr
(package private) static Outputs<BytesRef>
fstOutputs
private FST.BytesReader
fstReader
(package private) IndexInput
in
(package private) RunAutomaton
runAutomaton
private BytesRef
savedStartTerm
(package private) IntersectTermsEnumFrame[]
stack
private BytesRef
term
-
Constructor Summary
Constructors Constructor Description IntersectTermsEnum(FieldReader fr, Automaton automaton, RunAutomaton runAutomaton, BytesRef commonSuffix, BytesRef startTerm)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private BytesRef
_next()
(package private) static java.lang.String
brToString(BytesRef b)
private void
copyTerm()
int
docFreq()
Returns the number of documents containing the current term.private FST.Arc<BytesRef>
getArc(int ord)
private IntersectTermsEnumFrame
getFrame(int ord)
private int
getState()
ImpactsEnum
impacts(int flags)
Return aImpactsEnum
.BytesRef
next()
Increments the iteration to the nextBytesRef
in the iterator.long
ord()
Returns ordinal position for current term.private boolean
popPushNext()
PostingsEnum
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)
TermsEnum.SeekStatus
seekCeil(BytesRef text)
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 text)
Attempts to seek to the exact term, returning true if the term is found.private void
seekToStartTerm(BytesRef target)
private boolean
setSavedStartTerm(BytesRef startTerm)
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, seekExact
-
-
-
-
Field Detail
-
in
final IndexInput in
-
stack
IntersectTermsEnumFrame[] stack
-
runAutomaton
final RunAutomaton runAutomaton
-
automaton
final Automaton automaton
-
commonSuffix
final BytesRef commonSuffix
-
currentFrame
private IntersectTermsEnumFrame currentFrame
-
currentTransition
private Transition currentTransition
-
term
private final BytesRef term
-
fstReader
private final FST.BytesReader fstReader
-
fr
final FieldReader fr
-
savedStartTerm
private BytesRef savedStartTerm
-
-
Constructor Detail
-
IntersectTermsEnum
public IntersectTermsEnum(FieldReader fr, Automaton automaton, RunAutomaton runAutomaton, BytesRef commonSuffix, BytesRef startTerm) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
setSavedStartTerm
private boolean setSavedStartTerm(BytesRef startTerm)
-
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)
-
getFrame
private IntersectTermsEnumFrame getFrame(int ord) throws java.io.IOException
- Throws:
java.io.IOException
-
pushFrame
private IntersectTermsEnumFrame pushFrame(int state) throws java.io.IOException
- Throws:
java.io.IOException
-
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)
-
getState
private int getState()
-
seekToStartTerm
private void seekToStartTerm(BytesRef target) throws java.io.IOException
- Throws:
java.io.IOException
-
popPushNext
private boolean popPushNext() 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.
-
_next
private BytesRef _next() throws java.io.IOException
- Throws:
java.io.IOException
-
brToString
static java.lang.String brToString(BytesRef b)
-
copyTerm
private void copyTerm()
-
seekExact
public boolean seekExact(BytesRef text)
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
public TermsEnum.SeekStatus seekCeil(BytesRef text)
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.
-
-