Package org.apache.lucene.index
Class MultiTermsEnum
- java.lang.Object
-
- org.apache.lucene.index.TermsEnum
-
- org.apache.lucene.index.BaseTermsEnum
-
- org.apache.lucene.index.MultiTermsEnum
-
- All Implemented Interfaces:
BytesRefIterator
public final class MultiTermsEnum extends BaseTermsEnum
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
MultiTermsEnum.TermMergeQueue
(package private) static class
MultiTermsEnum.TermsEnumIndex
(package private) static class
MultiTermsEnum.TermsEnumWithSlice
-
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus
-
-
Field Summary
Fields Modifier and Type Field Description private BytesRef
current
private MultiTermsEnum.TermsEnumWithSlice[]
currentSubs
private static java.util.Comparator<MultiTermsEnum.TermsEnumWithSlice>
INDEX_COMPARATOR
private BytesRef
lastSeek
private boolean
lastSeekExact
private BytesRefBuilder
lastSeekScratch
private int
numSubs
private int
numTop
private MultiTermsEnum.TermMergeQueue
queue
private MultiPostingsEnum.EnumWithSlice[]
subDocs
private MultiTermsEnum.TermsEnumWithSlice[]
subs
private MultiTermsEnum.TermsEnumWithSlice[]
top
-
Constructor Summary
Constructors Constructor Description MultiTermsEnum(ReaderSlice[] slices)
Sole constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
docFreq()
Returns the number of documents containing the current term.MultiTermsEnum.TermsEnumWithSlice[]
getMatchArray()
Returns sub-reader slices positioned to the current term.int
getMatchCount()
Returns how many sub-reader slices contain the current term.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.PostingsEnum
postings(PostingsEnum reuse, int flags)
GetPostingsEnum
for the current term, with control over whether freqs, positions, offsets or payloads are required.private void
pullTop()
private void
pushTop()
TermsEnum
reset(MultiTermsEnum.TermsEnumIndex[] termsEnumsIndex)
The terms array must be newly created TermsEnum, ieBytesRefIterator.next()
has not yet been called.TermsEnum.SeekStatus
seekCeil(BytesRef term)
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 term)
Attempts to seek to the exact term, returning true if the term is found.BytesRef
term()
Returns current term.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, seekExact, termState
-
-
-
-
Field Detail
-
INDEX_COMPARATOR
private static final java.util.Comparator<MultiTermsEnum.TermsEnumWithSlice> INDEX_COMPARATOR
-
queue
private final MultiTermsEnum.TermMergeQueue queue
-
subs
private final MultiTermsEnum.TermsEnumWithSlice[] subs
-
currentSubs
private final MultiTermsEnum.TermsEnumWithSlice[] currentSubs
-
top
private final MultiTermsEnum.TermsEnumWithSlice[] top
-
subDocs
private final MultiPostingsEnum.EnumWithSlice[] subDocs
-
lastSeek
private BytesRef lastSeek
-
lastSeekExact
private boolean lastSeekExact
-
lastSeekScratch
private final BytesRefBuilder lastSeekScratch
-
numTop
private int numTop
-
numSubs
private int numSubs
-
current
private BytesRef current
-
-
Constructor Detail
-
MultiTermsEnum
public MultiTermsEnum(ReaderSlice[] slices)
Sole constructor.- Parameters:
slices
- Which sub-reader slices we should merge.
-
-
Method Detail
-
getMatchCount
public int getMatchCount()
Returns how many sub-reader slices contain the current term. @see #getMatchArray
-
getMatchArray
public MultiTermsEnum.TermsEnumWithSlice[] getMatchArray()
Returns sub-reader slices positioned to the current term.
-
term
public BytesRef term()
Description copied from class:TermsEnum
Returns current term. Do not call this when the enum is unpositioned.
-
reset
public TermsEnum reset(MultiTermsEnum.TermsEnumIndex[] termsEnumsIndex) throws java.io.IOException
The terms array must be newly created TermsEnum, ieBytesRefIterator.next()
has not yet been called.- Throws:
java.io.IOException
-
seekExact
public boolean seekExact(BytesRef term) 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 term) 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.
-
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.
-
pullTop
private void pullTop()
-
pushTop
private void pushTop() 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.
-
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)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-