Class QueryParser
- All Implemented Interfaces:
QueryParserConstants
,CommonQueryParserConfiguration
- Direct Known Subclasses:
ComplexPhraseQueryParser
,ExtendableQueryParser
,MultiFieldQueryParser
QueryParserBase.parse(String)
.
The syntax for query strings is as follows:
A Query is a series of clauses.
A clause may be prefixed by:
- a plus (
+
) or a minus (-
) sign, indicating that the clause is required or prohibited respectively; or - a term followed by a colon, indicating the field to be searched. This enables one to construct queries which search multiple fields.
- a term, indicating all the documents that contain this term; or
- a nested query, enclosed in parentheses. Note that this may be used
with a
+
/-
prefix to require any of a set of terms.
Query ::= ( Clause )* Clause ::= ["+", "-"] [<TERM> ":"] ( <TERM> | "(" Query ")" )
Examples of appropriately formatted queries can be found in the query syntax documentation.
In TermRangeQuery
s, QueryParser tries to detect date values, e.g.
date:[6/1/2005 TO 6/4/2005]
produces a range query that searches
for "date" fields between 2005-06-01 and 2005-06-04. Note that the format
of the accepted input depends on the locale
.
A DateTools.Resolution
has to be set,
if you want to use DateTools
for date conversion.
The date resolution that shall be used for RangeQueries can be set
using QueryParserBase.setDateResolution(DateTools.Resolution)
or QueryParserBase.setDateResolution(String, DateTools.Resolution)
. The former
sets the default date resolution for all fields, whereas the latter can
be used to set field specific date resolutions. Field specific date
resolutions take, if set, precedence over the default date resolution.
If you don't use DateTools
in your index, you can create your own
query parser that inherits QueryParser and overwrites
QueryParserBase.getRangeQuery(String, String, String, boolean, boolean)
to
use a different method for date conversion.
Note that QueryParser is not thread-safe.
NOTE: there is a new QueryParser in contrib, which matches the same syntax as this class, but is more modular, enabling substantial customization to how a query is created.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static final class
private static final class
static enum
The default operator for parsing queries.Nested classes/interfaces inherited from class org.apache.lucene.util.QueryBuilder
QueryBuilder.TermAndBoost
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final boolean
default split on whitespace behaviorprivate final QueryParser.JJCalls[]
private int
private List<int[]>
private int[]
private int
private int
private int
private int
private final int[]
private static int[]
private static int[]
private Token
private int[]
private boolean
Whether we are looking ahead.private static final QueryParser.LookaheadSuccess
Next token.private int
private boolean
private Token
private boolean
private boolean
Current token.Generated Token Manager.private boolean
Fields inherited from class org.apache.lucene.queryparser.classic.QueryParserBase
allowLeadingWildcard, AND_OPERATOR, autoGeneratePhraseQueries, CONJ_AND, CONJ_NONE, CONJ_OR, dateResolution, determinizeWorkLimit, field, fieldToDateResolution, fuzzyMinSim, fuzzyPrefixLength, locale, MOD_NONE, MOD_NOT, MOD_REQ, multiTermRewriteMethod, operator, OR_OPERATOR, phraseSlop, timeZone
Fields inherited from class org.apache.lucene.util.QueryBuilder
analyzer, autoGenerateMultiTermSynonymsPhraseQuery, enableGraphQueries, enablePositionIncrements
Fields inherited from interface org.apache.lucene.queryparser.classic.QueryParserConstants
_ESCAPED_CHAR, _NUM_CHAR, _QUOTED_CHAR, _TERM_CHAR, _TERM_START_CHAR, _WHITESPACE, AND, BAREOPER, Boost, CARAT, COLON, DEFAULT, EOF, FUZZY_SLOP, LPAREN, MINUS, NOT, NUMBER, OR, PLUS, PREFIXTERM, QUOTED, Range, RANGE_GOOP, RANGE_QUOTED, RANGE_TO, RANGEEX_END, RANGEEX_START, RANGEIN_END, RANGEIN_START, REGEXPTERM, RPAREN, STAR, TERM, tokenImage, WILDTERM
-
Constructor Summary
ConstructorsModifierConstructorDescriptionQueryParser
(String f, Analyzer a) Create a query parser.protected
QueryParser
(CharStream stream) Constructor with user supplied CharStream.protected
Constructor with generated Token Manager. -
Method Summary
Modifier and TypeMethodDescriptionprivate static boolean
allowedPostMultiTerm
(int tokenKind) final Query
final int
final void
Disable tracing.final void
Enable tracing.Generate ParseException.final Token
Get the next Token.boolean
final Token
getToken
(int index) Get the specific Token.private boolean
jj_2_1
(int xla) private boolean
jj_2_2
(int xla) private boolean
jj_2_3
(int xla) private boolean
jj_3_1()
private boolean
jj_3_2()
private boolean
jj_3_3()
private boolean
private boolean
private boolean
private boolean
private boolean
private void
jj_add_error_token
(int kind, int pos) private Token
jj_consume_token
(int kind) private static void
private static void
private int
jj_ntk_f()
private void
private void
jj_save
(int index, int xla) private boolean
jj_scan_token
(int kind) final int
final Query
MultiTerm
(String field, List<BooleanClause> clauses) Returns the first query if splitOnWhitespace=true or otherwise the entire produced queryfinal Query
void
ReInit
(CharStream stream) Reinitialise.void
Reinitialise.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
setSplitOnWhitespace
(boolean splitOnWhitespace) Whether query text should be split on whitespace prior to analysis.final Query
final Query
TopLevelQuery
(String field) final boolean
Trace enabled.Methods inherited from class org.apache.lucene.queryparser.classic.QueryParserBase
addClause, addMultiTermClauses, discardEscapeChar, escape, getAllowLeadingWildcard, getAutoGeneratePhraseQueries, getBooleanQuery, getDateResolution, getDefaultOperator, getDeterminizeWorkLimit, getField, getFieldQuery, getFieldQuery, getFuzzyDistance, getFuzzyMinSim, getFuzzyPrefixLength, getFuzzyQuery, getLocale, getMultiTermRewriteMethod, getPhraseSlop, getPrefixQuery, getRangeQuery, getRegexpQuery, getTimeZone, getWildcardQuery, handleBareFuzzy, handleBareTokenQuery, handleBoost, handleQuotedTerm, hexToInt, init, newBooleanClause, newFieldQuery, newFuzzyQuery, newMatchAllDocsQuery, newPrefixQuery, newRangeQuery, newRegexpQuery, newWildcardQuery, parse, setAllowLeadingWildcard, setDateResolution, setDateResolution, setDefaultOperator, setDeterminizeWorkLimit, setFuzzyMinSim, setFuzzyPrefixLength, setLocale, setMultiTermRewriteMethod, setPhraseSlop, setTimeZone
Methods inherited from class org.apache.lucene.util.QueryBuilder
add, analyzeBoolean, analyzeGraphBoolean, analyzeGraphPhrase, analyzeMultiBoolean, analyzeMultiPhrase, analyzePhrase, analyzeTerm, createBooleanQuery, createBooleanQuery, createFieldQuery, createFieldQuery, createMinShouldMatchQuery, createPhraseQuery, createPhraseQuery, getAnalyzer, getAutoGenerateMultiTermSynonymsPhraseQuery, getEnableGraphQueries, getEnablePositionIncrements, newBooleanQuery, newGraphSynonymQuery, newMultiPhraseQueryBuilder, newSynonymQuery, newTermQuery, setAnalyzer, setAutoGenerateMultiTermSynonymsPhraseQuery, setEnableGraphQueries, setEnablePositionIncrements
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.lucene.queryparser.flexible.standard.CommonQueryParserConfiguration
getAnalyzer, getEnablePositionIncrements, setEnablePositionIncrements
-
Field Details
-
DEFAULT_SPLIT_ON_WHITESPACE
public static final boolean DEFAULT_SPLIT_ON_WHITESPACEdefault split on whitespace behavior- See Also:
-
splitOnWhitespace
private boolean splitOnWhitespace -
disallowedPostMultiTerm
-
token_source
Generated Token Manager. -
token
Current token. -
jj_nt
Next token. -
jj_ntk
private int jj_ntk -
jj_scanpos
-
jj_lastpos
-
jj_la
private int jj_la -
jj_lookingAhead
private boolean jj_lookingAheadWhether we are looking ahead. -
jj_semLA
private boolean jj_semLA -
jj_gen
private int jj_gen -
jj_la1
private final int[] jj_la1 -
jj_la1_0
private static int[] jj_la1_0 -
jj_la1_1
private static int[] jj_la1_1 -
jj_2_rtns
-
jj_rescan
private boolean jj_rescan -
jj_gc
private int jj_gc -
jj_ls
-
jj_expentries
-
jj_expentry
private int[] jj_expentry -
jj_kind
private int jj_kind -
jj_lasttokens
private int[] jj_lasttokens -
jj_endpos
private int jj_endpos -
trace_enabled
private boolean trace_enabled
-
-
Constructor Details
-
QueryParser
Create a query parser.- Parameters:
f
- the default field for query terms.a
- used to find terms in the query text.
-
QueryParser
Constructor with user supplied CharStream. -
QueryParser
Constructor with generated Token Manager.
-
-
Method Details
-
setAutoGeneratePhraseQueries
public 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.
The combination splitOnWhitespace=false and autoGeneratePhraseQueries=true is disallowed. See LUCENE-7533.
- Overrides:
setAutoGeneratePhraseQueries
in classQueryParserBase
-
getSplitOnWhitespace
public boolean getSplitOnWhitespace()- See Also:
-
setSplitOnWhitespace
public void setSplitOnWhitespace(boolean splitOnWhitespace) Whether query text should be split on whitespace prior to analysis. Default isfalse
.The combination splitOnWhitespace=false and autoGeneratePhraseQueries=true is disallowed. See LUCENE-7533.
-
allowedPostMultiTerm
private static boolean allowedPostMultiTerm(int tokenKind) -
Conjunction
- Throws:
ParseException
-
Modifiers
- Throws:
ParseException
-
TopLevelQuery
- Specified by:
TopLevelQuery
in classQueryParserBase
- Throws:
ParseException
-
Query
- Throws:
ParseException
-
Clause
- Throws:
ParseException
-
Term
- Throws:
ParseException
-
MultiTerm
Returns the first query if splitOnWhitespace=true or otherwise the entire produced query- Throws:
ParseException
-
jj_2_1
private boolean jj_2_1(int xla) -
jj_2_2
private boolean jj_2_2(int xla) -
jj_2_3
private boolean jj_2_3(int xla) -
jj_3R_MultiTerm_391_3_6
private boolean jj_3R_MultiTerm_391_3_6() -
jj_3R_Clause_308_9_5
private boolean jj_3R_Clause_308_9_5() -
jj_3R_Clause_307_7_4
private boolean jj_3R_Clause_307_7_4() -
jj_3_2
private boolean jj_3_2() -
jj_3_1
private boolean jj_3_1() -
jj_3R_MultiTerm_393_5_7
private boolean jj_3R_MultiTerm_393_5_7() -
jj_3_3
private boolean jj_3_3() -
jj_3R_MultiTerm_383_3_3
private boolean jj_3R_MultiTerm_383_3_3() -
jj_la1_init_0
private static void jj_la1_init_0() -
jj_la1_init_1
private static void jj_la1_init_1() -
ReInit
Reinitialise.- Specified by:
ReInit
in classQueryParserBase
-
ReInit
Reinitialise. -
jj_consume_token
- Throws:
ParseException
-
jj_scan_token
private boolean jj_scan_token(int kind) -
getNextToken
Get the next Token. -
getToken
Get the specific Token. -
jj_ntk_f
private int jj_ntk_f() -
jj_add_error_token
private void jj_add_error_token(int kind, int pos) -
generateParseException
Generate ParseException. -
trace_enabled
public final boolean trace_enabled()Trace enabled. -
enable_tracing
public final void enable_tracing()Enable tracing. -
disable_tracing
public final void disable_tracing()Disable tracing. -
jj_rescan_token
private void jj_rescan_token() -
jj_save
private void jj_save(int index, int xla)
-