Table of Contents

Class SearchExtensions

Namespace
Examine
Assembly
Examine.Core.dll

A set of helpers for working with Lucene.Net in Examine

public static class SearchExtensions
Inheritance
SearchExtensions
Inherited Members

Methods

Boost(string, float)

Configures the string for boosting in Lucene

public static IExamineValue Boost(this string s, float boost)

Parameters

s string

The string to wildcard.

boost float

The boost level.

Returns

IExamineValue

An IExamineValue for the required operation

Exceptions

ArgumentException

Thrown when the string is null or empty

Escape(string)

Escapes the string within Lucene

public static IExamineValue Escape(this string s)

Parameters

s string

The string to escape.

Returns

IExamineValue

An IExamineValue for the required operation

Exceptions

ArgumentException

Thrown when the string is null or empty

Fuzzy(string)

Configures the string for fuzzy matching in Lucene using the default fuzziness level

public static IExamineValue Fuzzy(this string s)

Parameters

s string

The string to configure fuzzy matching on.

Returns

IExamineValue

An IExamineValue for the required operation

Exceptions

ArgumentException

Thrown when the string is null or empty

Fuzzy(string, float)

Configures the string for fuzzy matching in Lucene using the supplied fuzziness level

public static IExamineValue Fuzzy(this string s, float fuzzieness)

Parameters

s string

The string to configure fuzzy matching on.

fuzzieness float

The fuzzieness level. A value between 0 and 2

Returns

IExamineValue

An IExamineValue for the required operation

Exceptions

ArgumentException

Thrown when the string is null or empty

MultipleCharacterWildcard(string)

Adds a multi-character wildcard to a string for Lucene wildcard matching

public static IExamineValue MultipleCharacterWildcard(this string s)

Parameters

s string

The string to wildcard.

Returns

IExamineValue

An IExamineValue for the required operation

Exceptions

ArgumentException

Thrown when the string is null or empty

Proximity(string, int)

Configures the string for proximity matching

public static IExamineValue Proximity(this string s, int proximity)

Parameters

s string

The string to wildcard.

proximity int

The proximity level.

Returns

IExamineValue

An IExamineValue for the required operation

Exceptions

ArgumentException

Thrown when the string is null or empty

SingleCharacterWildcard(string)

Adds a single character wildcard to the string for Lucene wildcard matching

public static IExamineValue SingleCharacterWildcard(this string s)

Parameters

s string

The string to wildcard.

Returns

IExamineValue

An IExamineValue for the required operation

Exceptions

ArgumentException

Thrown when the string is null or empty