class BitSetTermsEnum extends TermsEnum
PostingsWriterBase.writeTerm(org.apache.lucene.util.BytesRef, org.apache.lucene.index.TermsEnum, org.apache.lucene.util.FixedBitSet)
so
that it can pull .docs() multiple times for the
current term.TermsEnum.SeekStatus
Modifier and Type | Field and Description |
---|---|
private BitSetPostingsEnum |
postingsEnum |
Constructor and Description |
---|
BitSetTermsEnum(BitSet docs) |
Modifier and Type | Method and Description |
---|---|
int |
docFreq()
Returns the number of documents containing 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.SeekStatus |
seekCeil(BytesRef text)
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 by
TermsEnum.ord() . |
BytesRef |
term()
Returns current term.
|
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).
|
private final BitSetPostingsEnum postingsEnum
public BitSetTermsEnum(BitSet docs)
public TermsEnum.SeekStatus seekCeil(BytesRef text)
TermsEnum
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 BytesRef term()
TermsEnum
public BytesRef next()
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.public long ord()
TermsEnum
UnsupportedOperationException
). Do not call this
when the enum is unpositioned.public int docFreq()
TermsEnum
TermsEnum.SeekStatus.END
.public long totalTermFreq()
TermsEnum
totalTermFreq
in class TermsEnum
public PostingsEnum postings(PostingsEnum reuse, int flags)
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