Class FuzzyTermsEnum

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

Term enumerations are always ordered by Comparer. Each term in the enumeration is greater than all that precede it.

Inheritance
System.Object
TermsEnum
FuzzyTermsEnum
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Search
Assembly: Lucene.Net.dll
Syntax
public class FuzzyTermsEnum : TermsEnum, IBytesRefEnumerator, IBytesRefIterator

Constructors

| Improve this Doc View Source

FuzzyTermsEnum(Terms, AttributeSource, Term, Single, Int32, Boolean)

Constructor for enumeration of all terms from specified reader which share a prefix of length prefixLength with term and which have a fuzzy similarity > minSimilarity.

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

Declaration
public FuzzyTermsEnum(Terms terms, AttributeSource atts, Term term, float minSimilarity, int prefixLength, bool transpositions)
Parameters
Type Name Description
Terms terms

Delivers terms.

AttributeSource atts

AttributeSource created by the rewrite method of MultiTermQuery thats contains information about competitive boosts during rewrite. It is also used to cache DFAs between segment transitions.

Term term

Pattern term.

System.Single minSimilarity

Minimum required similarity for terms from the reader. Pass an integer value representing edit distance. Passing a fraction is deprecated.

System.Int32 prefixLength

Length of required common prefix. Default value is 0.

System.Boolean transpositions

Transpositions

Exceptions
Type Condition
System.IO.IOException

if there is a low-level IO error

Fields

| Improve this Doc View Source

m_maxEdits

Declaration
protected int m_maxEdits
Field Value
Type Description
System.Int32
| Improve this Doc View Source

m_minSimilarity

Declaration
protected readonly float m_minSimilarity
Field Value
Type Description
System.Single
| Improve this Doc View Source

m_raw

Declaration
protected readonly bool m_raw
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

m_realPrefixLength

Declaration
protected readonly int m_realPrefixLength
Field Value
Type Description
System.Int32
| Improve this Doc View Source

m_scaleFactor

Declaration
protected readonly float m_scaleFactor
Field Value
Type Description
System.Single
| Improve this Doc View Source

m_termLength

Declaration
protected readonly int m_termLength
Field Value
Type Description
System.Int32
| Improve this Doc View Source

m_terms

Declaration
protected readonly Terms m_terms
Field Value
Type Description
Terms
| Improve this Doc View Source

m_termText

Declaration
protected readonly int[] m_termText
Field Value
Type Description
System.Int32[]

Properties

| Improve this Doc View Source

Comparer

Declaration
public override IComparer<BytesRef> Comparer { get; }
Property Value
Type Description
System.Collections.Generic.IComparer<BytesRef>
Overrides
| Improve this Doc View Source

DocFreq

Declaration
public override int DocFreq { get; }
Property Value
Type Description
System.Int32
Overrides
| Improve this Doc View Source

MinSimilarity

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration
public virtual float MinSimilarity { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Ord

Declaration
public override long Ord { get; }
Property Value
Type Description
System.Int64
Overrides
| Improve this Doc View Source

ScaleFactor

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration
public virtual float ScaleFactor { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Term

Declaration
public override BytesRef Term { get; }
Property Value
Type Description
BytesRef
Overrides
| Improve this Doc View Source

TotalTermFreq

Declaration
public override long TotalTermFreq { get; }
Property Value
Type Description
System.Int64
Overrides

Methods

| Improve this Doc View Source

Docs(IBits, DocsEnum, DocsFlags)

Declaration
public override DocsEnum Docs(IBits liveDocs, DocsEnum reuse, DocsFlags flags)
Parameters
Type Name Description
IBits liveDocs
DocsEnum reuse
DocsFlags flags
Returns
Type Description
DocsEnum
Overrides
| Improve this Doc View Source

DocsAndPositions(IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)

Declaration
public override DocsAndPositionsEnum DocsAndPositions(IBits liveDocs, DocsAndPositionsEnum reuse, DocsAndPositionsFlags flags)
Parameters
Type Name Description
IBits liveDocs
DocsAndPositionsEnum reuse
DocsAndPositionsFlags flags
Returns
Type Description
DocsAndPositionsEnum
Overrides
| Improve this Doc View Source

GetAutomatonEnum(Int32, BytesRef)

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

Declaration
protected virtual TermsEnum GetAutomatonEnum(int editDistance, BytesRef lastTerm)
Parameters
Type Name Description
System.Int32 editDistance
BytesRef lastTerm
Returns
Type Description
TermsEnum
| Improve this Doc View Source

GetTermState()

Declaration
public override TermState GetTermState()
Returns
Type Description
TermState
Overrides
| Improve this Doc View Source

MaxEditDistanceChanged(BytesRef, Int32, Boolean)

Declaration
protected virtual void MaxEditDistanceChanged(BytesRef lastTerm, int maxEdits, bool init)
Parameters
Type Name Description
BytesRef lastTerm
System.Int32 maxEdits
System.Boolean init
| Improve this Doc View Source

MoveNext()

Declaration
public override bool MoveNext()
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

SeekCeil(BytesRef)

Declaration
public override TermsEnum.SeekStatus SeekCeil(BytesRef text)
Parameters
Type Name Description
BytesRef text
Returns
Type Description
TermsEnum.SeekStatus
Overrides
| Improve this Doc View Source

SeekExact(BytesRef)

Declaration
public override bool SeekExact(BytesRef text)
Parameters
Type Name Description
BytesRef text
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

SeekExact(BytesRef, TermState)

Declaration
public override void SeekExact(BytesRef term, TermState state)
Parameters
Type Name Description
BytesRef term
TermState state
Overrides
| Improve this Doc View Source

SeekExact(Int64)

Declaration
public override void SeekExact(long ord)
Parameters
Type Name Description
System.Int64 ord
Overrides
| Improve this Doc View Source

SetEnum(TermsEnum)

Swap in a new actual enum to proxy to

Declaration
protected virtual void SetEnum(TermsEnum actualEnum)
Parameters
Type Name Description
TermsEnum actualEnum

Implements