public final class OrdsSegmentTermsEnum extends TermsEnum
TermsEnum.SeekStatus
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 target)
Seeks to the specified term, if it exists, or to the
next (ceiling) term.
|
boolean |
seekExact(BytesRef target)
Attempts to seek to the exact term, returning
true if the term is found.
|
void |
seekExact(BytesRef target,
TermState otherState)
Expert: Seeks a specific position by
TermState previously obtained
from TermsEnum.termState() . |
void |
seekExact(long targetOrd)
Seeks to the specified term by ordinal (position) as
previously returned by
TermsEnum.ord() . |
BytesRef |
term()
Returns current term.
|
TermState |
termState()
Expert: Returns the TermsEnums internal state to position the TermsEnum
without re-seeking the term dictionary.
|
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, docs, docs, docsAndPositions, docsAndPositions, postings
public boolean seekExact(BytesRef target) throws IOException
TermsEnum
TermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.seekExact
in class TermsEnum
IOException
public TermsEnum.SeekStatus seekCeil(BytesRef target) throws IOException
TermsEnum
seekCeil
in class TermsEnum
IOException
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 BytesRef term()
TermsEnum
public long ord()
TermsEnum
UnsupportedOperationException
). Do not call this
when the enum is unpositioned.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
public void seekExact(BytesRef target, TermState otherState)
TermsEnum
TermState
previously obtained
from TermsEnum.termState()
. Callers should maintain the TermState
to
use this method. Low-level implementations may position the TermsEnum
without re-seeking the term dictionary.
Seeking by TermState
should only be used iff the state was obtained
from the same TermsEnum
instance.
NOTE: Using this method with an incompatible TermState
might leave
this TermsEnum
in undefined state. On a segment level
TermState
instances are compatible only iff the source and the
target TermsEnum
operate on the same field. If operating on segment
level, TermState instances must not be used across segments.
NOTE: A seek by TermState
might not restore the
AttributeSource
's state. AttributeSource
states must be
maintained separately if this method is used.
public TermState termState() throws IOException
TermsEnum
NOTE: A seek by TermState
might not capture the
AttributeSource
's state. Callers must maintain the
AttributeSource
states separately
termState
in class TermsEnum
IOException
TermState
,
TermsEnum.seekExact(BytesRef, TermState)
public void seekExact(long targetOrd) throws IOException
TermsEnum
TermsEnum.ord()
. The target ord
may be before or after the current ord, and must be
within bounds.seekExact
in class TermsEnum
IOException
Copyright © 2000–2015 The Apache Software Foundation. All rights reserved.