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
Exposes
TermsEnum API, merged from TermsEnum API of sub-segments. This does a
merge sort, by term text, of the sub-readers.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
TermsEnum.SeekStatus -
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintdocFreq()Returns the number of documents containing the current term.org.apache.lucene.index.MultiTermsEnum.TermsEnumWithSlice[]Returns sub-reader slices positioned to the current term.intReturns how many sub-reader slices contain the current term.impacts(int flags) Return aImpactsEnum.next()Increments the iteration to the nextBytesRefin the iterator.longord()Returns ordinal position for current term.postings(PostingsEnum reuse, int flags) GetPostingsEnumfor the current term, with control over whether freqs, positions, offsets or payloads are required.reset(org.apache.lucene.index.TermsEnumIndex[] termsEnumsIndex) The terms array must be newly created TermsEnum, ieBytesRefIterator.next()has not yet been called.Seeks to the specified term, if it exists, or to the next (ceiling) term.voidseekExact(long ord) Seeks to the specified term by ordinal (position) as previously returned byTermsEnum.ord().booleanAttempts to seek to the exact term, returning true if the term is found.term()Returns current term.toString()longReturns 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, prepareSeekExact, seekExact, termState
-
Constructor Details
-
MultiTermsEnum
Sole constructor.- Parameters:
slices- Which sub-reader slices we should merge.
-
-
Method Details
-
getMatchCount
public int getMatchCount()Returns how many sub-reader slices contain the current term. @see #getMatchArray -
getMatchArray
public org.apache.lucene.index.MultiTermsEnum.TermsEnumWithSlice[] getMatchArray()Returns sub-reader slices positioned to the current term. -
term
Description copied from class:TermsEnumReturns current term. Do not call this when the enum is unpositioned. -
reset
The terms array must be newly created TermsEnum, ieBytesRefIterator.next()has not yet been called.- Throws:
IOException
-
seekExact
Description copied from class:TermsEnumAttempts 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:
seekExactin classBaseTermsEnum- Returns:
- true if the term is found; return false if the enum is unpositioned.
- Throws:
IOException
-
seekCeil
Description copied from class:TermsEnumSeeks 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.- Specified by:
seekCeilin classTermsEnum- Throws:
IOException
-
seekExact
public void seekExact(long ord) Description copied from class:TermsEnumSeeks 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:TermsEnumReturns ordinal position for current term. This is an optional method (the codec may throwUnsupportedOperationException). Do not call this when the enum is unpositioned. -
next
Description copied from interface:BytesRefIteratorIncrements the iteration to the nextBytesRefin the iterator. Returns the resultingBytesRefornullif 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
BytesRefin the iterator ornullif the end of the iterator is reached. - Throws:
IOException- If there is a low-level I/O error.
-
docFreq
Description copied from class:TermsEnumReturns the number of documents containing the current term. Do not call this when the enum is unpositioned.TermsEnum.SeekStatus.END.- Specified by:
docFreqin classTermsEnum- Throws:
IOException
-
totalTermFreq
Description copied from class:TermsEnumReturns 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:
totalTermFreqin classTermsEnum- Throws:
IOException
-
postings
Description copied from class:TermsEnumGetPostingsEnumfor 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:
postingsin 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:TermsEnumReturn aImpactsEnum.- Specified by:
impactsin classTermsEnum- Throws:
IOException- See Also:
-
toString
-