public final class MultiTermsEnum extends TermsEnum
TermsEnum
API, merged from TermsEnum
API of sub-segments.
This does a merge sort, by term text, of the sub-readers.TermsEnum.SeekStatus
Constructor and Description |
---|
MultiTermsEnum(ReaderSlice[] slices)
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
int |
docFreq()
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.
|
int |
getMatchCount()
Returns how many sub-reader slices contain the current
term.
|
BytesRef |
next()
Increments the iteration to the next
BytesRef in the iterator. |
long |
ord()
Returns ordinal position for current term.
|
PostingsEnum |
postings(PostingsEnum reuse,
int flags)
Get
PostingsEnum for the current term, with
control over whether freqs, positions, offsets or payloads
are required. |
TermsEnum |
reset(org.apache.lucene.index.MultiTermsEnum.TermsEnumIndex[] termsEnumsIndex)
The terms array must be newly created TermsEnum, ie
BytesRefIterator.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.
|
boolean |
seekExact(BytesRef term)
Attempts to seek to the exact term, returning
true if the term is found.
|
void |
seekExact(long ord)
Seeks to the specified term by ordinal (position) as
previously returned by
TermsEnum.ord() . |
BytesRef |
term()
Returns current term.
|
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).
|
attributes, postings, seekExact, termState
public MultiTermsEnum(ReaderSlice[] slices)
slices
- Which sub-reader slices we should
merge.public int getMatchCount()
public org.apache.lucene.index.MultiTermsEnum.TermsEnumWithSlice[] getMatchArray()
public BytesRef term()
TermsEnum
public TermsEnum reset(org.apache.lucene.index.MultiTermsEnum.TermsEnumIndex[] termsEnumsIndex) throws IOException
BytesRefIterator.next()
has not yet been called.IOException
public boolean seekExact(BytesRef term) throws IOException
TermsEnum
TermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.seekExact
in class TermsEnum
IOException
public TermsEnum.SeekStatus seekCeil(BytesRef term) throws IOException
TermsEnum
seekCeil
in class TermsEnum
IOException
public void seekExact(long ord)
TermsEnum
TermsEnum.ord()
. The target ord
may be before or after the current ord, and must be
within bounds.public long ord()
TermsEnum
UnsupportedOperationException
). Do not call this
when the enum is unpositioned.public BytesRef next() throws IOException
BytesRefIterator
BytesRef
in the iterator.
Returns the resulting BytesRef
or null
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.BytesRef
in the iterator or null
if
the end of the iterator is reached.IOException
- If there is a low-level I/O error.public int docFreq() throws IOException
TermsEnum
TermsEnum.SeekStatus.END
.docFreq
in class TermsEnum
IOException
public long totalTermFreq() throws IOException
TermsEnum
totalTermFreq
in class TermsEnum
IOException
public PostingsEnum postings(PostingsEnum reuse, int flags) throws IOException
TermsEnum
PostingsEnum
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 may return null if the postings
information required is not available from the index
NOTE: the returned iterator may return deleted documents, so
deleted documents have to be checked on top of the PostingsEnum
.
postings
in class TermsEnum
reuse
- pass a prior PostingsEnum for possible reuseflags
- specifies which optional per-document values
you require; see PostingsEnum.FREQS
IOException
Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.