Class LuceneSearchOptions

Namespace

Examine.Lucene.Search

Assembly

Examine.Lucene.dll

Options to configure LuceneSearchQuery

public class LuceneSearchOptions

Inheritance

object

LuceneSearchOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowLeadingWildcard

Set to true to allow leading wildcard characters. When set, * or ? are allowed as the first character of a Lucene.Net.Search.PrefixQuery and Lucene.Net.Search.WildcardQuery. Note that this can produce very slow queries on big indexes. Default: false.

public bool? AllowLeadingWildcard { get; set; }

Property Value

bool?

DateResolution

Sets the default Lucene.Net.Documents.DateTools.Resolution used for certain field when no Lucene.Net.Documents.DateTools.Resolution is defined for this field.

public DateResolution? DateResolution { get; set; }

Property Value

DateResolution?

EnablePositionIncrements

Set to true to enable position increments in result query. When set, result phrase and multi-phrase queries will be aware of position increments. Useful when e.g. a Lucene.Net.Analysis.Core.StopFilter increases the position increment of the token that follows an omitted token. Default: false.

public bool? EnablePositionIncrements { get; set; }

Property Value

bool?

FuzzyMinSim

Get the minimal similarity for fuzzy queries.

public float? FuzzyMinSim { get; set; }

Property Value

float?

FuzzyPrefixLength

Get or Set the prefix length for fuzzy queries. Default is 0.

public int? FuzzyPrefixLength { get; set; }

Property Value

int?

Locale

Get or Set locale used by date range parsing.

public CultureInfo? Locale { get; set; }

Property Value

CultureInfo

LowercaseExpandedTerms

Whether terms of multi-term queries (e.g., wildcard, prefix, fuzzy and range) should be automatically lower-cased or not. Default is true.

public bool? LowercaseExpandedTerms { get; set; }

Property Value

bool?

MultiTermRewriteMethod

By default, it uses Lucene.Net.Search.MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT when creating a prefix, wildcard and range queries. This implementation is generally preferable because it a) Runs faster b) Does not have the scarcity of terms unduly influence score c) avoids any exception due to too many listeners. However, if your application really needs to use the old-fashioned boolean queries expansion rewriting and the above points are not relevant then use this change the rewrite method.

public MultiTermQuery.RewriteMethod? MultiTermRewriteMethod { get; set; }

Property Value

MultiTermQuery.RewriteMethod

PhraseSlop

Gets or Sets the default slop for phrases. If zero, then exact phrase matches are required. Default value is zero.

public int? PhraseSlop { get; set; }

Property Value

int?

TimeZone

Gets or Sets the time zone.

public TimeZoneInfo? TimeZone { get; set; }

Property Value

TimeZoneInfo