public class QueryParser extends Object implements QueryParserConstants
parse(String)
.
The syntax for query strings is as follows:
A Query is a series of clauses.
A clause may be prefixed by:
+
) or a minus (-
) sign, indicating
that the clause is required or prohibited respectively; or
+
/-
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
.
By default a date is converted into a search term using the deprecated
DateField
for compatibility reasons.
To use the new DateTools
to convert dates, a
DateTools.Resolution
has to be set.
The date resolution that shall be used for RangeQueries can be set
using setDateResolution(DateTools.Resolution)
or 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 use neither DateField
nor DateTools
in your
index, you can create your own
query parser that inherits QueryParser and overwrites
getRangeQuery(String, String, String, 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.
NOTE: You must specify the required Version
compatibility when creating QueryParser:
setEnablePositionIncrements(boolean)
is true by
default.
setAutoGeneratePhraseQueries(boolean)
is false by
default.
Modifier and Type | Class and Description |
---|---|
static class |
QueryParser.Operator
The default operator for parsing queries.
|
Modifier and Type | Field and Description |
---|---|
static QueryParser.Operator |
AND_OPERATOR
Alternative form of QueryParser.Operator.AND
|
Token |
jj_nt
Next token.
|
static QueryParser.Operator |
OR_OPERATOR
Alternative form of QueryParser.Operator.OR
|
Token |
token
Current token.
|
QueryParserTokenManager |
token_source
Generated Token Manager.
|
_ESCAPED_CHAR, _NUM_CHAR, _QUOTED_CHAR, _TERM_CHAR, _TERM_START_CHAR, _WHITESPACE, AND, Boost, CARAT, COLON, DEFAULT, EOF, FUZZY_SLOP, LPAREN, MINUS, NOT, NUMBER, OR, PLUS, PREFIXTERM, QUOTED, RangeEx, RANGEEX_END, RANGEEX_GOOP, RANGEEX_QUOTED, RANGEEX_START, RANGEEX_TO, RangeIn, RANGEIN_END, RANGEIN_GOOP, RANGEIN_QUOTED, RANGEIN_START, RANGEIN_TO, RPAREN, STAR, TERM, tokenImage, WILDTERM
Modifier | Constructor and Description |
---|---|
protected |
QueryParser(CharStream stream)
Constructor with user supplied CharStream.
|
protected |
QueryParser(QueryParserTokenManager tm)
Constructor with generated Token Manager.
|
|
QueryParser(Version matchVersion,
String f,
Analyzer a)
Constructs a query parser.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addClause(List<BooleanClause> clauses,
int conj,
int mods,
Query q) |
Query |
Clause(String field) |
int |
Conjunction() |
void |
disable_tracing()
Disable tracing.
|
void |
enable_tracing()
Enable tracing.
|
static String |
escape(String s)
Returns a String where those characters that QueryParser
expects to be escaped are escaped by a preceding
\ . |
ParseException |
generateParseException()
Generate ParseException.
|
boolean |
getAllowLeadingWildcard() |
Analyzer |
getAnalyzer() |
boolean |
getAutoGeneratePhraseQueries() |
protected Query |
getBooleanQuery(List<BooleanClause> clauses)
Factory method for generating query, given a set of clauses.
|
protected Query |
getBooleanQuery(List<BooleanClause> clauses,
boolean disableCoord)
Factory method for generating query, given a set of clauses.
|
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.
|
boolean |
getEnablePositionIncrements() |
String |
getField() |
protected Query |
getFieldQuery(String field,
String queryText)
Deprecated.
Use
getFieldQuery(String,String,boolean) instead. |
protected Query |
getFieldQuery(String field,
String queryText,
boolean quoted) |
protected Query |
getFieldQuery(String field,
String queryText,
int slop)
Base implementation delegates to
getFieldQuery(String,String,boolean) . |
float |
getFuzzyMinSim()
Get the minimal similarity for fuzzy queries.
|
int |
getFuzzyPrefixLength()
Get the prefix length for fuzzy queries.
|
protected Query |
getFuzzyQuery(String field,
String termStr,
float minSimilarity)
Factory method for generating a query (similar to
getWildcardQuery(java.lang.String, java.lang.String) ). |
Locale |
getLocale()
Returns current locale, allowing access by subclasses.
|
boolean |
getLowercaseExpandedTerms() |
MultiTermQuery.RewriteMethod |
getMultiTermRewriteMethod() |
Token |
getNextToken()
Get the next Token.
|
int |
getPhraseSlop()
Gets the default slop for phrases.
|
protected Query |
getPrefixQuery(String field,
String termStr)
Factory method for generating a query (similar to
getWildcardQuery(java.lang.String, java.lang.String) ). |
Collator |
getRangeCollator() |
protected Query |
getRangeQuery(String field,
String part1,
String part2,
boolean inclusive) |
Token |
getToken(int index)
Get the specific Token.
|
protected Query |
getWildcardQuery(String field,
String termStr)
Factory method for generating a query.
|
static void |
main(String[] args)
Command line tool to test QueryParser, using
SimpleAnalyzer . |
int |
Modifiers() |
protected BooleanClause |
newBooleanClause(Query q,
BooleanClause.Occur occur)
Builds a new BooleanClause instance
|
protected BooleanQuery |
newBooleanQuery(boolean disableCoord)
Builds a new BooleanQuery instance
|
protected Query |
newFuzzyQuery(Term term,
float minimumSimilarity,
int prefixLength)
Builds a new FuzzyQuery instance
|
protected Query |
newMatchAllDocsQuery()
Builds a new MatchAllDocsQuery instance
|
protected MultiPhraseQuery |
newMultiPhraseQuery()
Builds a new MultiPhraseQuery instance
|
protected PhraseQuery |
newPhraseQuery()
Builds a new PhraseQuery instance
|
protected Query |
newPrefixQuery(Term prefix)
Builds a new PrefixQuery instance
|
protected Query |
newRangeQuery(String field,
String part1,
String part2,
boolean inclusive)
Builds a new TermRangeQuery instance
|
protected Query |
newTermQuery(Term term)
Builds a new TermQuery instance
|
protected Query |
newWildcardQuery(Term t)
Builds a new WildcardQuery instance
|
Query |
parse(String query)
Parses a query string, returning a
Query . |
Query |
Query(String field) |
void |
ReInit(CharStream stream)
Reinitialise.
|
void |
ReInit(QueryParserTokenManager tm)
Reinitialise.
|
void |
setAllowLeadingWildcard(boolean allowLeadingWildcard)
Set to
true to allow leading wildcard characters. |
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(DateTools.Resolution dateResolution)
Sets the default date resolution used by RangeQueries for fields for which no
specific date resolutions has been set.
|
void |
setDateResolution(String fieldName,
DateTools.Resolution dateResolution)
Sets the date resolution used by RangeQueries for a specific field.
|
void |
setDefaultOperator(QueryParser.Operator op)
Sets the boolean operator of the QueryParser.
|
void |
setEnablePositionIncrements(boolean enable)
Set to
true to enable position increments in result query. |
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.
|
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 RangeQuery. |
void |
setPhraseSlop(int phraseSlop)
Sets the default slop for phrases.
|
void |
setRangeCollator(Collator rc)
Sets the collator used to determine index term inclusion in ranges
for RangeQuerys.
|
Query |
Term(String field) |
Query |
TopLevelQuery(String field) |
public static final QueryParser.Operator AND_OPERATOR
public static final QueryParser.Operator OR_OPERATOR
public QueryParserTokenManager token_source
public Token token
public Token jj_nt
public QueryParser(Version matchVersion, String f, Analyzer a)
matchVersion
- Lucene version to match. See above.f
- the default field for query terms.a
- used to find terms in the query text.protected QueryParser(CharStream stream)
protected QueryParser(QueryParserTokenManager tm)
public Query parse(String query) throws ParseException
Query
.query
- the query string to be parsed.ParseException
- if the parsing failspublic Analyzer getAnalyzer()
public String getField()
public final boolean getAutoGeneratePhraseQueries()
public final void setAutoGeneratePhraseQueries(boolean value)
Set to false if phrase queries should only be generated when surrounded by double quotes.
public float getFuzzyMinSim()
public void setFuzzyMinSim(float fuzzyMinSim)
public int getFuzzyPrefixLength()
public void setFuzzyPrefixLength(int fuzzyPrefixLength)
fuzzyPrefixLength
- The fuzzyPrefixLength to set.public void setPhraseSlop(int phraseSlop)
public int getPhraseSlop()
public void setAllowLeadingWildcard(boolean allowLeadingWildcard)
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.
public boolean getAllowLeadingWildcard()
setAllowLeadingWildcard(boolean)
public void setEnablePositionIncrements(boolean enable)
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 StopFilter increases the position increment of the token that follows an omitted token.
Default: false.
public boolean getEnablePositionIncrements()
setEnablePositionIncrements(boolean)
public void setDefaultOperator(QueryParser.Operator op)
OR_OPERATOR
) terms without any modifiers
are considered optional: for example capital of Hungary
is equal to
capital OR of OR Hungary
.AND_OPERATOR
mode terms are considered to be in conjunction: the
above mentioned query is parsed as capital AND of AND Hungary
public QueryParser.Operator getDefaultOperator()
public void setLowercaseExpandedTerms(boolean lowercaseExpandedTerms)
true
.public boolean getLowercaseExpandedTerms()
setLowercaseExpandedTerms(boolean)
public void setMultiTermRewriteMethod(MultiTermQuery.RewriteMethod method)
MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT
when creating a PrefixQuery, WildcardQuery or RangeQuery. This implementation is generally preferable because it
a) Runs faster b) Does not have the scarcity of terms unduly influence score
c) avoids any "TooManyBooleanClauses" 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.public MultiTermQuery.RewriteMethod getMultiTermRewriteMethod()
public void setLocale(Locale locale)
public Locale getLocale()
public void setDateResolution(DateTools.Resolution dateResolution)
setDateResolution(String, DateTools.Resolution)
.dateResolution
- the default date resolution to setpublic void setDateResolution(String fieldName, DateTools.Resolution dateResolution)
fieldName
- field for which the date resolution is to be setdateResolution
- date resolution to setpublic DateTools.Resolution getDateResolution(String fieldName)
public void setRangeCollator(Collator rc)
rc
- the collator to use when constructing RangeQueryspublic Collator getRangeCollator()
protected void addClause(List<BooleanClause> clauses, int conj, int mods, Query q)
@Deprecated protected Query getFieldQuery(String field, String queryText) throws ParseException
getFieldQuery(String,String,boolean)
instead.ParseException
protected Query getFieldQuery(String field, String queryText, boolean quoted) throws ParseException
ParseException
- throw in overridden method to disallowprotected Query getFieldQuery(String field, String queryText, int slop) throws ParseException
getFieldQuery(String,String,boolean)
.
This method may be overridden, for example, to return
a SpanNearQuery instead of a PhraseQuery.ParseException
- throw in overridden method to disallowprotected Query getRangeQuery(String field, String part1, String part2, boolean inclusive) throws ParseException
ParseException
- throw in overridden method to disallowprotected BooleanQuery newBooleanQuery(boolean disableCoord)
disableCoord
- disable coordprotected BooleanClause newBooleanClause(Query q, BooleanClause.Occur occur)
q
- sub queryoccur
- how this clause should occur when matching documentsprotected Query newTermQuery(Term term)
term
- termprotected PhraseQuery newPhraseQuery()
protected MultiPhraseQuery newMultiPhraseQuery()
protected Query newPrefixQuery(Term prefix)
prefix
- Prefix termprotected Query newFuzzyQuery(Term term, float minimumSimilarity, int prefixLength)
term
- TermminimumSimilarity
- minimum similarityprefixLength
- prefix lengthprotected Query newRangeQuery(String field, String part1, String part2, boolean inclusive)
field
- Fieldpart1
- minpart2
- maxinclusive
- true if range is inclusiveprotected Query newMatchAllDocsQuery()
protected Query newWildcardQuery(Term t)
t
- wildcard termprotected Query getBooleanQuery(List<BooleanClause> clauses) throws ParseException
clauses
- List that contains BooleanClause
instances
to join.Query
object.ParseException
- throw in overridden method to disallowprotected Query getBooleanQuery(List<BooleanClause> clauses, boolean disableCoord) throws ParseException
clauses
- List that contains BooleanClause
instances
to join.disableCoord
- true if coord scoring should be disabled.Query
object.ParseException
- throw in overridden method to disallowprotected Query getWildcardQuery(String field, String termStr) throws ParseException
Depending on settings, prefix term may be lower-cased automatically. It will not go through the default Analyzer, however, since normal Analyzers are unlikely to work properly with wildcard templates.
Can be overridden by extending classes, to provide custom handling for wildcard queries, which may be necessary due to missing analyzer calls.
field
- Name of the field query will use.termStr
- Term token that contains one or more wild card
characters (? or *), but is not simple prefix termQuery
built for the termParseException
- throw in overridden method to disallowprotected Query getPrefixQuery(String field, String termStr) throws ParseException
getWildcardQuery(java.lang.String, java.lang.String)
). Called when parser parses an input term
token 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 settings, a prefix term may be lower-cased automatically. It will not go through the default Analyzer, however, since normal Analyzers are unlikely to work properly with wildcard templates.
Can be overridden by extending classes, to provide custom handling for wild card queries, which may be necessary due to missing analyzer calls.
field
- Name of the field query will use.termStr
- Term token to use for building term for the query
(without trailing '*' character!)Query
built for the termParseException
- throw in overridden method to disallowprotected Query getFuzzyQuery(String field, String termStr, float minSimilarity) throws ParseException
getWildcardQuery(java.lang.String, java.lang.String)
). Called when parser parses
an input term token that has the fuzzy suffix (~) appended.field
- Name of the field query will use.termStr
- Term token to use for building term for the queryQuery
built for the termParseException
- throw in overridden method to disallowpublic static String escape(String s)
\
.public static void main(String[] args) throws Exception
SimpleAnalyzer
.
Usage:java org.apache.lucene.queryParser.QueryParser <input>
Exception
public final int Conjunction() throws ParseException
ParseException
public final int Modifiers() throws ParseException
ParseException
public final Query TopLevelQuery(String field) throws ParseException
ParseException
public final Query Query(String field) throws ParseException
ParseException
public final Query Clause(String field) throws ParseException
ParseException
public final Query Term(String field) throws ParseException
ParseException
public void ReInit(CharStream stream)
public void ReInit(QueryParserTokenManager tm)
public final Token getNextToken()
public final Token getToken(int index)
public ParseException generateParseException()
public final void enable_tracing()
public final void disable_tracing()