org.apache.lucene.queryParser
public class QueryParser extends Object implements QueryParserConstants
+
) 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 RangeQuerys, 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
Resolution has to be set.
The date resolution that shall be used for RangeQueries can be set using setDateResolution or QueryParser. 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 QueryParser to use a different method for date conversion.
Note that QueryParser is not thread-safe.
Nested Class Summary | |
---|---|
static class | QueryParser.Operator The default operator for parsing queries.
|
Field Summary | |
---|---|
static QueryParser.Operator | AND_OPERATOR Alternative form of QueryParser.Operator.AND |
Token | jj_nt |
boolean | lookingAhead |
static QueryParser.Operator | OR_OPERATOR Alternative form of QueryParser.Operator.OR |
Token | token |
QueryParserTokenManager | token_source |
Constructor Summary | |
---|---|
QueryParser(String f, Analyzer a) Constructs a query parser. | |
QueryParser(CharStream stream) | |
QueryParser(QueryParserTokenManager tm) |
Method Summary | |
---|---|
protected void | addClause(Vector clauses, int conj, int mods, Query q) |
Query | Clause(String field) |
int | Conjunction() |
void | disable_tracing() |
void | 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() |
boolean | getAllowLeadingWildcard() |
Analyzer | getAnalyzer() |
protected Query | getBooleanQuery(Vector clauses)
Factory method for generating query, given a set of clauses.
|
protected Query | getBooleanQuery(Vector 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. |
String | getField() |
protected Query | getFieldQuery(String field, String queryText) |
protected Query | getFieldQuery(String field, String queryText, int slop)
Base implementation delegates to getFieldQuery.
|
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
QueryParser). |
Locale | getLocale()
Returns current locale, allowing access by subclasses. |
boolean | getLowercaseExpandedTerms() |
Token | getNextToken() |
int | getPhraseSlop()
Gets the default slop for phrases. |
protected Query | getPrefixQuery(String field, String termStr)
Factory method for generating a query (similar to
QueryParser). |
protected Query | getRangeQuery(String field, String part1, String part2, boolean inclusive) |
Token | getToken(int index) |
boolean | getUseOldRangeQuery() |
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() |
Query | parse(String query) Parses a query string, returning a Query. |
Query | Query(String field) |
void | ReInit(CharStream stream) |
void | ReInit(QueryParserTokenManager tm) |
void | setAllowLeadingWildcard(boolean allowLeadingWildcard)
Set to true to allow leading wildcard characters.
|
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 | 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 | setPhraseSlop(int phraseSlop)
Sets the default slop for phrases. |
void | setUseOldRangeQuery(boolean useOldRangeQuery)
By default QueryParser uses new ConstantScoreRangeQuery in preference to RangeQuery
for range queries. |
Query | Term(String field) |
Query | TopLevelQuery(String field) |
Parameters: f the default field for query terms. a used to find terms in the query text.
\
.See Also: QueryParser
Returns: Returns the analyzer.
Parameters: clauses Vector that contains BooleanClause instances to join.
Returns: Resulting Query object.
Throws: ParseException throw in overridden method to disallow
Parameters: clauses Vector that contains BooleanClause instances to join. disableCoord true if coord scoring should be disabled.
Returns: Resulting Query object.
Throws: ParseException throw in overridden method to disallow
Returns: Returns the field.
Throws: ParseException throw in overridden method to disallow
Throws: ParseException throw in overridden method to disallow
Returns: Returns the fuzzyPrefixLength.
Parameters: field Name of the field query will use. termStr Term token to use for building term for the query
Returns: Resulting Query built for the term
Throws: ParseException throw in overridden method to disallow
See Also: QueryParser
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.
Parameters: field Name of the field query will use. termStr Term token to use for building term for the query (without trailing '*' character!)
Returns: Resulting Query built for the term
Throws: ParseException throw in overridden method to disallow
Throws: ParseException throw in overridden method to disallow
See Also: QueryParser
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.
Parameters: 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 term
Returns: Resulting Query built for the term
Throws: ParseException throw in overridden method to disallow
java org.apache.lucene.queryParser.QueryParser <input>
Parameters: query the query string to be parsed.
Throws: ParseException if the parsing fails
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.
Parameters: dateResolution the default date resolution to set
Parameters: fieldName field for which the date resolution is to be set dateResolution date resolution to set
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 conjuction: the
above mentioned query is parsed as capital AND of AND Hungary
Parameters: fuzzyPrefixLength The fuzzyPrefixLength to set.
true
.true
Default is false
.