Package org.apache.lucene.index
Class MultiTermsEnum
- java.lang.Object
-
- org.apache.lucene.index.TermsEnum
-
- org.apache.lucene.index.MultiTermsEnum
-
- All Implemented Interfaces:
BytesRefIterator
public final class MultiTermsEnum extends TermsEnum
-
-
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 int
docFreq()
Returns the number of documents containing the current term.DocsEnum
docs(Bits liveDocs, DocsEnum reuse, int flags)
GetDocsEnum
for the current term, with control over whether freqs are required.DocsAndPositionsEnum
docsAndPositions(Bits liveDocs, DocsAndPositionsEnum reuse, int flags)
GetDocsAndPositionsEnum
for the current term, with control over whether offsets and payloads are required.java.util.Comparator<BytesRef>
getComparator()
Return theBytesRef
Comparator used to sort terms provided by the iterator.org.apache.lucene.index.MultiTermsEnum.TermsEnumWithSlice[]
getMatchArray()
Returns sub-reader slices positioned to the current term.int
getMatchCount()
Returns how many sub-reader slices contain the current term.BytesRef
next()
Increments the iteration to the nextBytesRef
in the iterator.long
ord()
Returns ordinal position for current term.TermsEnum
reset(org.apache.lucene.index.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.TermsEnum
attributes, docs, docsAndPositions, 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:TermsEnum
Returns current term. Do not call this when the enum is unpositioned.
-
getComparator
public java.util.Comparator<BytesRef> getComparator()
Description copied from interface:BytesRefIterator
Return theBytesRef
Comparator used to sort terms provided by the iterator. This may return null if there are no items or the iterator is not sorted. Callers may invoke this method many times, so it's best to cache a single instance & reuse it.
-
reset
public TermsEnum reset(org.apache.lucene.index.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)
.
-
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.
-
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). This will be -1 if the codec doesn't support this measure. Note that, like other term measures, this measure does not take deleted documents into account.- Specified by:
totalTermFreq
in classTermsEnum
- Throws:
java.io.IOException
-
docs
public DocsEnum docs(Bits liveDocs, DocsEnum reuse, int flags) throws java.io.IOException
Description copied from class:TermsEnum
GetDocsEnum
for the current term, with control over whether freqs are required. Do not call this when the enum is unpositioned. This method will not return null.- Specified by:
docs
in classTermsEnum
- Parameters:
liveDocs
- unset bits are documents that should not be returnedreuse
- pass a prior DocsEnum for possible reuseflags
- specifies which optional per-document values you require; seeDocsEnum.FLAG_FREQS
- Throws:
java.io.IOException
- See Also:
TermsEnum.docs(Bits, DocsEnum, int)
-
docsAndPositions
public DocsAndPositionsEnum docsAndPositions(Bits liveDocs, DocsAndPositionsEnum reuse, int flags) throws java.io.IOException
Description copied from class:TermsEnum
GetDocsAndPositionsEnum
for the current term, with control over whether offsets and payloads are required. Some codecs may be able to optimize their implementation when offsets and/or payloads are not required. Do not call this when the enum is unpositioned. This will return null if positions were not indexed.- Specified by:
docsAndPositions
in classTermsEnum
- Parameters:
liveDocs
- unset bits are documents that should not be returnedreuse
- pass a prior DocsAndPositionsEnum for possible reuseflags
- specifies which optional per-position values you require; seeDocsAndPositionsEnum.FLAG_OFFSETS
andDocsAndPositionsEnum.FLAG_PAYLOADS
.- Throws:
java.io.IOException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-