public final class FuzzyTermsEnum extends TermsEnum
Term enumerations are always ordered by
BytesRef.compareTo(org.apache.lucene.util.BytesRef)
. Each term in the enumeration is
greater than all that precede it.
Modifier and Type | Class and Description |
---|---|
static class |
FuzzyTermsEnum.FuzzyTermsException
Thrown to indicate that there was an issue creating a fuzzy query for a given term.
|
TermsEnum.SeekStatus
Constructor and Description |
---|
FuzzyTermsEnum(Terms terms,
Term term,
int maxEdits,
int prefixLength,
boolean transpositions)
Constructor for enumeration of all terms from specified
reader which share a prefix of
length prefixLength with term and which have at most maxEdits edits. |
Modifier and Type | Method and Description |
---|---|
AttributeSource |
attributes()
Returns the related attributes.
|
int |
docFreq()
Returns the number of documents containing the current
term.
|
float |
getBoost()
Gets the boost of the current term
|
ImpactsEnum |
impacts(int flags)
Return a
ImpactsEnum . |
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.
|
boolean |
seekExact(BytesRef text)
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() . |
void |
setMaxNonCompetitiveBoost(float boost)
Sets the maximum non-competitive boost, which may allow switching to a
lower max-edit automaton at run time
|
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).
|
public FuzzyTermsEnum(Terms terms, Term term, int maxEdits, int prefixLength, boolean transpositions) throws
reader
which share a prefix of
length prefixLength
with term
and which have at most maxEdits
edits.
After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.
terms
- Delivers terms.term
- Pattern term.maxEdits
- Maximum edit distance.prefixLength
- the length of the required common prefixtranspositions
- whether transpositions should count as a single edit
- if there is a low-level IO errorpublic void setMaxNonCompetitiveBoost(float boost)
public float getBoost()
public BytesRef next() throws
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.
- If there is a low-level I/O error.public int docFreq() throws
TermsEnum
TermsEnum.SeekStatus.END
.public long totalTermFreq() throws
TermsEnum
totalTermFreq
in class TermsEnum
public PostingsEnum postings(PostingsEnum reuse, int flags) throws
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 will not return null.
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
public ImpactsEnum impacts(int flags) throws
TermsEnum
ImpactsEnum
.impacts
in class TermsEnum
TermsEnum.postings(PostingsEnum, int)
public void seekExact(BytesRef term, TermState state) throws
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
TermsEnum
NOTE: A seek by TermState
might not capture the
AttributeSource
's state. Callers must maintain the
AttributeSource
states separately
termState
in class TermsEnum
TermState
,
TermsEnum.seekExact(BytesRef, TermState)
public long ord() throws
TermsEnum
public AttributeSource attributes()
TermsEnum
attributes
in class TermsEnum
public boolean seekExact(BytesRef text) throws
TermsEnum
TermsEnum.seekCeil(org.apache.lucene.util.BytesRef)
.public TermsEnum.SeekStatus seekCeil(BytesRef text) throws
TermsEnum
public void seekExact(long ord) throws
TermsEnum
TermsEnum.ord()
. The target ord
may be before or after the current ord, and must be
within bounds.Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.