Package org.apache.lucene.queryparser.classic

Class QueryParserBase

java.lang.Object

org.apache.lucene.util.QueryBuilder

org.apache.lucene.queryparser.classic.QueryParserBase

All Implemented Interfaces:

CommonQueryParserConfiguration

Direct Known Subclasses:

QueryParser

public abstract class QueryParserBase
extends QueryBuilder
implements CommonQueryParserConfiguration

This class is overridden by QueryParser in QueryParser.jj and acts to separate the majority of the Java code from the .jj grammar file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryParserBase.MethodRemovedUseAnother	Do not catch this exception in your code, it means you are using methods that you should no longer use.

Field Summary

Fields

Modifier and Type	Field	Description
static QueryParser.Operator	AND_OPERATOR	Alternative form of QueryParser.Operator.AND
static QueryParser.Operator	OR_OPERATOR	Alternative form of QueryParser.Operator.OR

Method Summary

Modifier and Type	Method	Description
static String	escape(String s)	Returns a String where those characters that QueryParser expects to be escaped are escaped by a preceding \.
boolean	getAllowLeadingWildcard()
boolean	getAnalyzeRangeTerms()
boolean	getAutoGeneratePhraseQueries()
DateTools.Resolution	getDateResolution(String fieldName)	Returns the date resolution that is used by RangeQueries for the given field.
QueryParser.Operator	getDefaultOperator()	Gets implicit operator setting, which will be either AND_OPERATOR or OR_OPERATOR.
String	getField()
float	getFuzzyMinSim()	Get the minimal similarity for fuzzy queries.
int	getFuzzyPrefixLength()	Get the prefix length for fuzzy queries.
Locale	getLocale()	Returns current locale, allowing access by subclasses.
boolean	getLowercaseExpandedTerms()
MultiTermQuery.RewriteMethod	getMultiTermRewriteMethod()
int	getPhraseSlop()	Gets the default slop for phrases.
TimeZone	getTimeZone()
void	init(Version matchVersion, String f, Analyzer a)	Initializes a query parser.
Query	parse(String query)	Parses a query string, returning a Query.
abstract void	ReInit(CharStream stream)
void	setAllowLeadingWildcard(boolean allowLeadingWildcard)	Set to true to allow leading wildcard characters.
void	setAnalyzeRangeTerms(boolean analyzeRangeTerms)	Set whether or not to analyze range terms when constructing TermRangeQuerys.
void	setAutoGeneratePhraseQueries(boolean value)	Set to true if phrase queries will be automatically generated when the analyzer returns more than one term from whitespace delimited text.
void	setDateResolution(String fieldName, DateTools.Resolution dateResolution)	Sets the date resolution used by RangeQueries for a specific field.
void	setDateResolution(DateTools.Resolution dateResolution)	Sets the default date resolution used by RangeQueries for fields for which no specific date resolutions has been set.
void	setDefaultOperator(QueryParser.Operator op)	Sets the boolean operator of the QueryParser.
void	setFuzzyMinSim(float fuzzyMinSim)	Set the minimum similarity for fuzzy queries.
void	setFuzzyPrefixLength(int fuzzyPrefixLength)	Set the prefix length for fuzzy queries.
void	setLocale(Locale locale)	Set locale used by date range parsing, lowercasing, and other locale-sensitive operations.
void	setLowercaseExpandedTerms(boolean lowercaseExpandedTerms)	Whether terms of wildcard, prefix, fuzzy and range queries are to be automatically lower-cased or not.
void	setMultiTermRewriteMethod(MultiTermQuery.RewriteMethod method)	By default QueryParser uses MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT when creating a PrefixQuery, WildcardQuery or TermRangeQuery.
void	setPhraseSlop(int phraseSlop)	Sets the default slop for phrases.
void	setTimeZone(TimeZone timeZone)
abstract Query	TopLevelQuery(String field)

Methods inherited from class org.apache.lucene.util.QueryBuilder

createBooleanQuery, createBooleanQuery, createMinShouldMatchQuery, createPhraseQuery, createPhraseQuery, getAnalyzer, getEnablePositionIncrements, setAnalyzer, setEnablePositionIncrements

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.lucene.queryparser.flexible.standard.CommonQueryParserConfiguration

getAnalyzer, getEnablePositionIncrements, setEnablePositionIncrements

Field Detail

AND_OPERATOR

public static final QueryParser.Operator AND_OPERATOR

Alternative form of QueryParser.Operator.AND

OR_OPERATOR

public static final QueryParser.Operator OR_OPERATOR

Alternative form of QueryParser.Operator.OR

Method Detail

init

public void init(Version matchVersion,
                 String f,
                 Analyzer a)

Initializes a query parser. Called by the QueryParser constructor

Parameters:

matchVersion - Lucene version to match. See here.

f - the default field for query terms.

a - used to find terms in the query text.

ReInit

public abstract void ReInit(CharStream stream)

TopLevelQuery

public abstract Query TopLevelQuery(String field)
                             throws ParseException

Throws:

ParseException

parse

public Query parse(String query)
            throws ParseException

Parses a query string, returning a Query.

Parameters:

query - the query string to be parsed.

Throws:

ParseException - if the parsing fails

getField

public String getField()

Returns:

Returns the default field.

getAutoGeneratePhraseQueries

public final boolean getAutoGeneratePhraseQueries()

See Also:

setAutoGeneratePhraseQueries(boolean)

setAutoGeneratePhraseQueries

public final void setAutoGeneratePhraseQueries(boolean value)

Set to true if phrase queries will be automatically generated when the analyzer returns more than one term from whitespace delimited text. NOTE: this behavior may not be suitable for all languages.

Set to false if phrase queries should only be generated when surrounded by double quotes.

getFuzzyMinSim

public float getFuzzyMinSim()

Get the minimal similarity for fuzzy queries.

Specified by:

getFuzzyMinSim in interface CommonQueryParserConfiguration

setFuzzyMinSim

public void setFuzzyMinSim(float fuzzyMinSim)

Set the minimum similarity for fuzzy queries. Default is 2f.

Specified by:

setFuzzyMinSim in interface CommonQueryParserConfiguration

getFuzzyPrefixLength

public int getFuzzyPrefixLength()

Get the prefix length for fuzzy queries.

Specified by:

getFuzzyPrefixLength in interface CommonQueryParserConfiguration

Returns:

Returns the fuzzyPrefixLength.

setFuzzyPrefixLength

public void setFuzzyPrefixLength(int fuzzyPrefixLength)

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

Specified by:

setFuzzyPrefixLength in interface CommonQueryParserConfiguration

Parameters:

fuzzyPrefixLength - The fuzzyPrefixLength to set.

setPhraseSlop

public void setPhraseSlop(int phraseSlop)

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

Specified by:

setPhraseSlop in interface CommonQueryParserConfiguration

getPhraseSlop

public int getPhraseSlop()

Gets the default slop for phrases.

Specified by:

getPhraseSlop in interface CommonQueryParserConfiguration

setAllowLeadingWildcard

public void setAllowLeadingWildcard(boolean allowLeadingWildcard)

Set to true to allow leading wildcard characters.

When set, * or ? are allowed as the first character of a PrefixQuery and WildcardQuery. Note that this can produce very slow queries on big indexes.

Default: false.

Specified by:

setAllowLeadingWildcard in interface CommonQueryParserConfiguration

getAllowLeadingWildcard

public boolean getAllowLeadingWildcard()

Specified by:

getAllowLeadingWildcard in interface CommonQueryParserConfiguration

See Also:

setAllowLeadingWildcard(boolean)

setDefaultOperator

public void setDefaultOperator(QueryParser.Operator op)

Sets the boolean operator of the QueryParser. In default mode (OR_OPERATOR) terms without any modifiers are considered optional: for example capital of Hungary is equal to capital OR of OR Hungary.
In AND_OPERATOR mode terms are considered to be in conjunction: the above mentioned query is parsed as capital AND of AND Hungary

getDefaultOperator

public QueryParser.Operator getDefaultOperator()

Gets implicit operator setting, which will be either AND_OPERATOR or OR_OPERATOR.

setLowercaseExpandedTerms

public void setLowercaseExpandedTerms(boolean lowercaseExpandedTerms)

Whether terms of wildcard, prefix, fuzzy and range queries are to be automatically lower-cased or not. Default is true.

Specified by:

setLowercaseExpandedTerms in interface CommonQueryParserConfiguration

getLowercaseExpandedTerms

public boolean getLowercaseExpandedTerms()

Specified by:

getLowercaseExpandedTerms in interface CommonQueryParserConfiguration

See Also:

setLowercaseExpandedTerms(boolean)

setMultiTermRewriteMethod

public void setMultiTermRewriteMethod(MultiTermQuery.RewriteMethod method)

By default QueryParser uses MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT when creating a PrefixQuery, WildcardQuery or TermRangeQuery. This implementation is generally preferable because it a) Runs faster b) Does not have the scarcity of terms unduly influence score c) avoids any BooleanQuery.TooManyClauses exception. However, if your application really needs to use the old-fashioned BooleanQuery expansion rewriting and the above points are not relevant then use this to change the rewrite method.

Specified by:

setMultiTermRewriteMethod in interface CommonQueryParserConfiguration

getMultiTermRewriteMethod

public MultiTermQuery.RewriteMethod getMultiTermRewriteMethod()

Specified by:

getMultiTermRewriteMethod in interface CommonQueryParserConfiguration

See Also:

setMultiTermRewriteMethod(org.apache.lucene.search.MultiTermQuery.RewriteMethod)

setLocale

public void setLocale(Locale locale)

Set locale used by date range parsing, lowercasing, and other locale-sensitive operations.

Specified by:

setLocale in interface CommonQueryParserConfiguration

getLocale

public Locale getLocale()

Returns current locale, allowing access by subclasses.

Specified by:

getLocale in interface CommonQueryParserConfiguration

setTimeZone

public void setTimeZone(TimeZone timeZone)

Specified by:

setTimeZone in interface CommonQueryParserConfiguration

getTimeZone

public TimeZone getTimeZone()

Specified by:

getTimeZone in interface CommonQueryParserConfiguration

setDateResolution

public void setDateResolution(DateTools.Resolution dateResolution)

Sets the default date resolution used by RangeQueries for fields for which no specific date resolutions has been set. Field specific resolutions can be set with setDateResolution(String, org.apache.lucene.document.DateTools.Resolution).

Specified by:

setDateResolution in interface CommonQueryParserConfiguration

Parameters:

dateResolution - the default date resolution to set

setDateResolution

public void setDateResolution(String fieldName,
                              DateTools.Resolution dateResolution)

Sets the date resolution used by RangeQueries for a specific field.

Parameters:

fieldName - field for which the date resolution is to be set

dateResolution - date resolution to set

getDateResolution

public DateTools.Resolution getDateResolution(String fieldName)

Returns the date resolution that is used by RangeQueries for the given field. Returns null, if no default or field specific date resolution has been set for the given field.

setAnalyzeRangeTerms

public void setAnalyzeRangeTerms(boolean analyzeRangeTerms)

Set whether or not to analyze range terms when constructing TermRangeQuerys. For example, setting this to true can enable analyzing terms into collation keys for locale-sensitive TermRangeQuery.

Parameters:

analyzeRangeTerms - whether or not terms should be analyzed for RangeQuerys

getAnalyzeRangeTerms

public boolean getAnalyzeRangeTerms()

Returns:

whether or not to analyze range terms when constructing TermRangeQuerys.

escape

public static String escape(String s)

Returns a String where those characters that QueryParser expects to be escaped are escaped by a preceding \.