Class AnalyzingQueryParser

Overrides Lucene's default QueryParser so that Fuzzy-, Prefix-, Range-, and WildcardQuerys are also passed through the given analyzer, but wildcard characters * and ? don't get removed from the search terms.

Warning: This class should only be used with analyzers that do not use stopwords or that add tokens. Also, several stemming analyzers are inappropriate: for example, Lucene.Net.Analysis.De.GermanAnalyzer will turn Häuser into hau, but H?user will become h?user when using this parser and thus no match would be found (i.e. using this parser will be no improvement over QueryParser in such cases).
Inheritance
object
QueryBuilder
QueryParserBase
QueryParser
AnalyzingQueryParser
Inherited Members
QueryBuilder.Analyzer
QueryBuilder.EnablePositionIncrements
QueryBuilder.NewTermQuery(Term)
QueryBuilder.NewPhraseQuery()
QueryBuilder.NewMultiPhraseQuery()
Namespace: Lucene.Net.QueryParsers.Analyzing
Assembly: Lucene.Net.QueryParser.dll
Syntax
public class AnalyzingQueryParser : QueryParser, ICommonQueryParserConfiguration

Constructors

AnalyzingQueryParser(LuceneVersion, string, Analyzer)

Overrides Lucene's default QueryParser so that Fuzzy-, Prefix-, Range-, and WildcardQuerys are also passed through the given analyzer, but wildcard characters * and ? don't get removed from the search terms.

Warning: This class should only be used with analyzers that do not use stopwords or that add tokens. Also, several stemming analyzers are inappropriate: for example, Lucene.Net.Analysis.De.GermanAnalyzer will turn Häuser into hau, but H?user will become h?user when using this parser and thus no match would be found (i.e. using this parser will be no improvement over QueryParser in such cases).
Declaration
public AnalyzingQueryParser(LuceneVersion matchVersion, string field, Analyzer analyzer)
Parameters
Type Name Description
LuceneVersion matchVersion
string field
Analyzer analyzer

Methods

AnalyzeSingleChunk(string, string, string)

Returns the analyzed form for the given chunk.

If the analyzer produces more than one output token from the given chunk, a ParseException is thrown.

Declaration
protected virtual string AnalyzeSingleChunk(string field, string termStr, string chunk)
Parameters
Type Name Description
string field

The target field
string termStr

The full term from which the given chunk is excerpted
string chunk

The portion of the given termStr to be analyzed
Returns
Type Description
string

The result of analyzing the given chunk
Exceptions
Type Condition
ParseException

ParseException when analysis returns other than one output token

GetFuzzyQuery(string, string, float)

Called when parser parses an input term that has the fuzzy suffix (~) appended.

Depending on analyzer and settings, a fuzzy term may (most probably will) be lower-cased automatically. It will go through the default Analyzer.

Overrides super class, by passing terms through analyzer.
Declaration
protected override Query GetFuzzyQuery(string field, string termStr, float minSimilarity)
Parameters
Type Name Description
string field

Name of the field query will use.
string termStr

Term to use for building term for the query
float minSimilarity
Returns
Type Description
Query

Resulting Lucene.Net.Search.Query built for the term
Overrides

GetPrefixQuery(string, string)

Called when parser parses an input term that uses prefix notation; that is, contains a single '*' wildcard character as its last character. Since this is a special case of generic wildcard term, and such a query can be optimized easily, this usually results in a different query object.

Depending on analyzer and settings, a prefix term may (most probably will) be lower-cased automatically. It will go through the default Analyzer.

Overrides super class, by passing terms through analyzer.
Declaration
protected override Query GetPrefixQuery(string field, string termStr)
Parameters
Type Name Description
string field

Name of the field query will use.
string termStr

Term to use for building term for the query (without trailing '*' character!)
Returns
Type Description
Query

Resulting Lucene.Net.Search.Query built for the term
Overrides

GetWildcardQuery(string, string)

Called when parser parses an input term that uses prefix notation; that is, contains a single '*' wildcard character as its last character. Since this is a special case of generic wildcard term, and such a query can be optimized easily, this usually results in a different query object.

Depending on analyzer and settings, a prefix term may (most probably will) be lower-cased automatically. It will go through the default Analyzer.

Overrides super class, by passing terms through analyzer.
Declaration
protected override Query GetWildcardQuery(string field, string termStr)
Parameters
Type Name Description
string field

Name of the field query will use.
string termStr

Term to use for building term for the query (without trailing '*' character!)
Returns
Type Description
Query

Resulting Lucene.Net.Search.Query built for the term
Overrides

Implements