|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.index.TermsEnum
org.apache.lucene.index.FilterAtomicReader.FilterTermsEnum
public static class FilterAtomicReader.FilterTermsEnum
Base class for filtering TermsEnum
implementations.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum |
---|
TermsEnum.SeekStatus |
Field Summary | |
---|---|
protected TermsEnum |
in
|
Fields inherited from class org.apache.lucene.index.TermsEnum |
---|
EMPTY |
Constructor Summary | |
---|---|
FilterAtomicReader.FilterTermsEnum(TermsEnum in)
|
Method Summary | |
---|---|
AttributeSource |
attributes()
Returns the related attributes. |
int |
docFreq()
Returns the number of documents containing the current term. |
DocsEnum |
docs(Bits liveDocs,
DocsEnum reuse,
boolean needsFreqs)
Get DocsEnum for the current term. |
DocsAndPositionsEnum |
docsAndPositions(Bits liveDocs,
DocsAndPositionsEnum reuse,
boolean needsOffsets)
Get DocsAndPositionsEnum for the current term. |
Comparator<BytesRef> |
getComparator()
Return the BytesRef Comparator used to sort terms provided by the
iterator. |
BytesRef |
next()
Increments the iteration to the next BytesRef in the iterator. |
long |
ord()
Returns ordinal position for current term. |
TermsEnum.SeekStatus |
seekCeil(BytesRef text,
boolean useCache)
Expert: just like TermsEnum.seekCeil(BytesRef) but allows
you to control whether the implementation should
attempt to use its term cache (if it uses one). |
boolean |
seekExact(BytesRef text,
boolean useCache)
Attempts to seek to the exact term, returning true if the term is found. |
void |
seekExact(BytesRef term,
TermState state)
Expert: Seeks a specific position by TermState previously obtained
from TermsEnum.termState() . |
void |
seekExact(long ord)
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. |
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 |
---|
seekCeil |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final TermsEnum in
Constructor Detail |
---|
public FilterAtomicReader.FilterTermsEnum(TermsEnum in)
Method Detail |
---|
public boolean seekExact(BytesRef text, boolean useCache) throws IOException
TermsEnum
TermsEnum.seekCeil(org.apache.lucene.util.BytesRef, boolean)
.
seekExact
in class TermsEnum
IOException
public TermsEnum.SeekStatus seekCeil(BytesRef text, boolean useCache) throws IOException
TermsEnum
TermsEnum.seekCeil(BytesRef)
but allows
you to control whether the implementation should
attempt to use its term cache (if it uses one).
seekCeil
in class TermsEnum
IOException
public void seekExact(long ord) 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
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
public BytesRef term() throws IOException
TermsEnum
term
in class TermsEnum
IOException
public long ord() throws IOException
TermsEnum
UnsupportedOperationException
). Do not call this
when the enum is unpositioned.
ord
in class TermsEnum
IOException
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 DocsEnum docs(Bits liveDocs, DocsEnum reuse, boolean needsFreqs) throws IOException
TermsEnum
DocsEnum
for the current term. Do not
call this when the enum is unpositioned. This method
may return null (if needsFreqs is true but freqs were
not indexed for this field).
docs
in class TermsEnum
liveDocs
- unset bits are documents that should not
be returnedreuse
- pass a prior DocsEnum for possible reuseneedsFreqs
- true if the caller intends to call
DocsEnum.freq()
. If you pass false you must not
call DocsEnum.freq()
in the returned DocsEnum.
IOException
public DocsAndPositionsEnum docsAndPositions(Bits liveDocs, DocsAndPositionsEnum reuse, boolean needsOffsets) throws IOException
TermsEnum
DocsAndPositionsEnum
for the current term.
Do not call this when the enum is unpositioned.
This method will only return null if needsOffsets is
true but offsets were not indexed.
docsAndPositions
in class TermsEnum
liveDocs
- unset bits are documents that should not
be returnedreuse
- pass a prior DocsAndPositionsEnum for possible reuseneedsOffsets
- true if offsets are required
IOException
public Comparator<BytesRef> getComparator()
BytesRefIterator
BytesRef
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.
public void seekExact(BytesRef term, TermState state) throws IOException
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 enum the state was
obtained from and the enum the state is used for seeking are obtained from
the same IndexReader
.
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.
seekExact
in class TermsEnum
term
- the term the TermState corresponds tostate
- the TermState
IOException
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 AttributeSource attributes()
TermsEnum
attributes
in class TermsEnum
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |