Package org.apache.lucene.search

Class FuzzyTermsEnum

java.lang.Object

org.apache.lucene.index.TermsEnum

org.apache.lucene.search.FuzzyTermsEnum

All Implemented Interfaces:

BytesRefIterator

public final class FuzzyTermsEnum
extends TermsEnum

Subclass of TermsEnum for enumerating all terms that are similar to the specified filter term.

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	FuzzyTermsEnum.AutomatonAttribute	Used for sharing automata between segments Levenshtein automata are large and expensive to build; we don't want to build them directly on the query because this can blow up caches that use queries as keys; we also don't want to rebuild them for every segment.
private static class	FuzzyTermsEnum.AutomatonAttributeImpl
static class	FuzzyTermsEnum.FuzzyTermsException	Thrown to indicate that there was an issue creating a fuzzy query for a given term.

Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum

TermsEnum.SeekStatus

Field Summary

Fields

Modifier and Type	Field	Description
private TermsEnum	actualEnum
private AttributeSource	atts
private CompiledAutomaton[]	automata
private BoostAttribute	boostAtt
private float	bottom
private BytesRef	bottomTerm
private MaxNonCompetitiveBoostAttribute	maxBoostAtt
private int	maxEdits
private BytesRef	queuedBottom
private Term	term
private int	termLength
private Terms	terms

Fields inherited from class org.apache.lucene.index.TermsEnum

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	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.
(package private)	FuzzyTermsEnum(Terms terms, AttributeSource atts, 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.
private	FuzzyTermsEnum(Terms terms, AttributeSource atts, Term term, java.util.function.Supplier<FuzzyAutomatonBuilder> automatonBuilder)

Method Summary

Modifier and Type	Method	Description
AttributeSource	attributes()	Returns the related attributes.
private void	bottomChanged(BytesRef lastTerm)	fired when the max non-competitive boost has changed.
int	docFreq()	Returns the number of documents containing the current term.
private TermsEnum	getAutomatonEnum(int editDistance, BytesRef lastTerm)	return an automata-based enum for matching up to editDistance from lastTerm, if possible
float	getBoost()	Gets the boost of the current term
ImpactsEnum	impacts(int flags)	Return a ImpactsEnum.
private boolean	matches(BytesRef termIn, int k)	returns true if term is within k edits of the query 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().
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	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).

Methods inherited from class org.apache.lucene.index.TermsEnum

postings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

actualEnum

private TermsEnum actualEnum

atts

private final AttributeSource atts

boostAtt

private final BoostAttribute boostAtt

maxBoostAtt

private final MaxNonCompetitiveBoostAttribute maxBoostAtt

automata

private final CompiledAutomaton[] automata

terms

private final Terms terms

termLength

private final int termLength

term

private final Term term

bottom

private float bottom

bottomTerm

private BytesRef bottomTerm

queuedBottom

private BytesRef queuedBottom

maxEdits

private int maxEdits

Constructor Detail

FuzzyTermsEnum

public FuzzyTermsEnum(Terms terms,
                      Term term,
                      int maxEdits,
                      int prefixLength,
                      boolean transpositions)
               throws java.io.IOException

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.

After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.

Parameters:

terms - Delivers terms.

term - Pattern term.

maxEdits - Maximum edit distance.

prefixLength - the length of the required common prefix

transpositions - whether transpositions should count as a single edit

Throws:

java.io.IOException - if there is a low-level IO error

FuzzyTermsEnum

FuzzyTermsEnum(Terms terms,
               AttributeSource atts,
               Term term,
               int maxEdits,
               int prefixLength,
               boolean transpositions)
        throws java.io.IOException

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.

After calling the constructor the enumeration is already pointing to the first valid term if such a term exists.

Parameters:

terms - Delivers terms.

atts - An AttributeSource used to share automata between segments

term - Pattern term.

maxEdits - Maximum edit distance.

prefixLength - the length of the required common prefix

transpositions - whether transpositions should count as a single edit

Throws:

java.io.IOException - if there is a low-level IO error

FuzzyTermsEnum

private FuzzyTermsEnum(Terms terms,
                       AttributeSource atts,
                       Term term,
                       java.util.function.Supplier<FuzzyAutomatonBuilder> automatonBuilder)
                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

setMaxNonCompetitiveBoost

public void setMaxNonCompetitiveBoost(float boost)

Sets the maximum non-competitive boost, which may allow switching to a lower max-edit automaton at run time

getBoost

public float getBoost()

Gets the boost of the current term

getAutomatonEnum

private TermsEnum getAutomatonEnum(int editDistance,
                                   BytesRef lastTerm)
                            throws java.io.IOException

return an automata-based enum for matching up to editDistance from lastTerm, if possible

Throws:

java.io.IOException

bottomChanged

private void bottomChanged(BytesRef lastTerm)
                    throws java.io.IOException

fired when the max non-competitive boost has changed. this is the hook to swap in a smarter actualEnum.

Throws:

java.io.IOException

next

public BytesRef next()
              throws java.io.IOException

Description copied from interface: BytesRefIterator

Increments the iteration to the next 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.

Returns:

the next BytesRef in the iterator or null if the end of the iterator is reached.

Throws:

java.io.IOException - If there is a low-level I/O error.

matches

private boolean matches(BytesRef termIn,
                        int k)

returns true if term is within k edits of the query term

docFreq

public int docFreq()
            throws java.io.IOException

Description copied from class: TermsEnum

Returns the number of documents containing the current term. Do not call this when the enum is unpositioned. TermsEnum.SeekStatus.END.

Specified by:

docFreq in class TermsEnum

Throws:

java.io.IOException

totalTermFreq

public long totalTermFreq()
                   throws java.io.IOException

Description copied from class: TermsEnum

Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term). Note that, like other term measures, this measure does not take deleted documents into account.

Specified by:

totalTermFreq in class TermsEnum

Throws:

java.io.IOException

postings

public PostingsEnum postings(PostingsEnum reuse,
                             int flags)
                      throws java.io.IOException

Description copied from class: TermsEnum

Get 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.

Specified by:

postings in class TermsEnum

Parameters:

reuse - pass a prior PostingsEnum for possible reuse

flags - specifies which optional per-document values you require; see PostingsEnum.FREQS

Throws:

java.io.IOException

impacts

public ImpactsEnum impacts(int flags)
                    throws java.io.IOException

Description copied from class: TermsEnum

Return a ImpactsEnum.

Specified by:

impacts in class TermsEnum

Throws:

java.io.IOException

See Also:

TermsEnum.postings(PostingsEnum, int)

seekExact

public void seekExact(BytesRef term,
                      TermState state)
               throws java.io.IOException

Description copied from class: TermsEnum

Expert: Seeks a specific position by 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.

Specified by:

seekExact in class TermsEnum

Parameters:

term - the term the TermState corresponds to

state - the TermState

Throws:

java.io.IOException

termState

public TermState termState()
                    throws java.io.IOException

Description copied from class: TermsEnum

Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary.

NOTE: A seek by TermState might not capture the AttributeSource's state. Callers must maintain the AttributeSource states separately

Specified by:

termState in class TermsEnum

Throws:

java.io.IOException

See Also:

TermState, TermsEnum.seekExact(BytesRef, TermState)

ord

public long ord()
         throws java.io.IOException

Description copied from class: TermsEnum

Returns ordinal position for current term. This is an optional method (the codec may throw UnsupportedOperationException). Do not call this when the enum is unpositioned.

Specified by:

ord in class TermsEnum

Throws:

java.io.IOException

attributes

public AttributeSource attributes()

Description copied from class: TermsEnum

Returns the related attributes.

Specified by:

attributes in class TermsEnum

seekExact

public boolean seekExact(BytesRef text)
                  throws java.io.IOException

Description copied from class: TermsEnum

Attempts to seek to the exact term, returning true if the term is found. If this returns false, the enum is unpositioned. For some codecs, seekExact may be substantially faster than TermsEnum.seekCeil(org.apache.lucene.util.BytesRef).

Specified by:

seekExact in class TermsEnum

Returns:

true if the term is found; return false if the enum is unpositioned.

Throws:

java.io.IOException

seekCeil

public TermsEnum.SeekStatus seekCeil(BytesRef text)
                              throws java.io.IOException

Description copied from class: TermsEnum

Seeks to the specified term, if it exists, or to the next (ceiling) term. Returns SeekStatus to indicate whether exact term was found, a different term was found, or EOF was hit. The target term may be before or after the current term. If this returns SeekStatus.END, the enum is unpositioned.

Specified by:

seekCeil in class TermsEnum

Throws:

java.io.IOException

seekExact

public void seekExact(long ord)
               throws java.io.IOException

Description copied from class: TermsEnum

Seeks to the specified term by ordinal (position) as previously returned by TermsEnum.ord(). The target ord may be before or after the current ord, and must be within bounds.

Specified by:

seekExact in class TermsEnum

Throws:

java.io.IOException

term

public BytesRef term()
              throws java.io.IOException

Description copied from class: TermsEnum

Returns current term. Do not call this when the enum is unpositioned.

Specified by:

term in class TermsEnum

Throws:

java.io.IOException