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
ExposesTermsEnumAPI, merged fromTermsEnumAPI 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
-
-
Constructor Summary
Constructors Constructor Description MultiTermsEnum(ReaderSlice[] slices)Sole constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intdocFreq()Returns the number of documents containing the current term.org.apache.lucene.index.MultiTermsEnum.TermsEnumWithSlice[]getMatchArray()Returns sub-reader slices positioned to the current term.intgetMatchCount()Returns how many sub-reader slices contain the current term.ImpactsEnumimpacts(int flags)Return aImpactsEnum.BytesRefnext()Increments the iteration to the nextBytesRefin the iterator.longord()Returns ordinal position for current term.PostingsEnumpostings(PostingsEnum reuse, int flags)GetPostingsEnumfor the current term, with control over whether freqs, positions, offsets or payloads are required.TermsEnumreset(org.apache.lucene.index.TermsEnumIndex[] termsEnumsIndex)The terms array must be newly created TermsEnum, ieBytesRefIterator.next()has not yet been called.TermsEnum.SeekStatusseekCeil(BytesRef term)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().booleanseekExact(BytesRef term)Attempts to seek to the exact term, returning true if the term is found.BytesRefterm()Returns current term.StringtoString()longtotalTermFreq()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
-
-
-
-
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 org.apache.lucene.index.MultiTermsEnum.TermsEnumWithSlice[] getMatchArray()
Returns sub-reader slices positioned to the current term.
-
term
public BytesRef term()
Description copied from class:TermsEnumReturns current term. Do not call this when the enum is unpositioned.
-
reset
public TermsEnum reset(org.apache.lucene.index.TermsEnumIndex[] termsEnumsIndex) throws IOException
The terms array must be newly created TermsEnum, ieBytesRefIterator.next()has not yet been called.- Throws:
IOException
-
seekExact
public boolean seekExact(BytesRef term) throws IOException
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
public TermsEnum.SeekStatus seekCeil(BytesRef term) throws IOException
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
public BytesRef next() throws IOException
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
public int docFreq() throws IOExceptionDescription 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
public long totalTermFreq() throws IOExceptionDescription 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
public PostingsEnum postings(PostingsEnum reuse, int flags) throws IOException
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
public ImpactsEnum impacts(int flags) throws IOException
Description copied from class:TermsEnumReturn aImpactsEnum.- Specified by:
impactsin classTermsEnum- Throws:
IOException- See Also:
TermsEnum.postings(PostingsEnum, int)
-
-