Class QueryParserHelper<TQuery>

This class is a helper for the query parser framework, it does all the three query parser phrases at once: text parsing, query processing and query building.

It contains methods that allows the user to change the implementation used on the three phases.

Inheritance
System.Object
QueryParserHelper<TQuery>
StandardQueryParser
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Lucene.Net.QueryParser.dll
Syntax
[Serializable]
public class QueryParserHelper<TQuery>
Type Parameters
Name Description
TQuery

Constructors

Name Description
QueryParserHelper(QueryConfigHandler, ISyntaxParser, IQueryNodeProcessor, IQueryBuilder<TQuery>)

Creates a query parser helper object using the specified configuration, text parser, processor and builder.

Properties

Name Description
QueryBuilder

Returns the query builder used to build a object from the query node tree. The object produced by this builder is returned by Parse(String, String).
QueryConfigHandler

Returns the query configuration handler, which is used during the query node tree processing. It can be null.
QueryNodeProcessor

Gets the processor object used to process the query node tree, it returns null if no processor is used.
SyntaxParser

Returns the text parser used to build a query node tree from a query string. The default text parser instance returned by this method is a ISyntaxParser.

Methods

Name Description
Parse(String, String)

Parses a query string to an object, usually some query object.

In this method the three phases are executed:

  1. the query string is parsed using the text parser returned by SyntaxParser, the result is a query node tree.
  2. the query node tree is processed by the processor returned by QueryNodeProcessor.
  3. a object is built from the query node tree using the builder returned by QueryBuilder.

SetQueryBuilder(IQueryBuilder<TQuery>)

The query builder that will be used to build an object from the query node tree. It cannot be null.
SetQueryConfigHandler(QueryConfigHandler)

Sets the query configuration handler that will be used during query processing. It can be null. It's also set to the processor returned by QueryNodeProcessor.
SetQueryNodeProcessor(IQueryNodeProcessor)

Sets the processor that will be used to process the query node tree. If there is any QueryConfigHandler returned by QueryConfigHandler, it will be set on the processor. The argument can be null, which means that no processor will be used to process the query node tree.
SetSyntaxParser(ISyntaxParser)

Sets the text parser that will be used to parse the query string, it cannot be null.

Extension Methods

See Also