| java.lang.Object
 org.apache.lucene.queryParser.QueryParser
All known Subclasses: org.apache.lucene.queryParser.MultiFieldQueryParser, org.apache.lucene.queryParser.analyzing.AnalyzingQueryParser, net.bagaluten.jca.lucene.connector.impl.CompositeQuerySuggester,
| QueryParser | | public class QueryParser implements QueryParserConstants(Code) | | This class is generated by JavaCC. The most important method is
QueryParser.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 clause may be either:
- 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.
Thus, in BNF, the query grammar is:
Query ::= ( Clause )*
Clause ::= ["+", "-"] [<TERM> ":"] ( <TERM> | "(" Query ")" )
Examples of appropriately formatted queries can be found in the query syntax
documentation.
In
RangeQuery 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
QueryParser.setLocale(Locale) 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
org.apache.lucene.document.DateTools.Resolution has to be set.
The date resolution that shall be used for RangeQueries can be set
using
QueryParser.setDateResolution(DateTools.Resolution) or
QueryParser.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
QueryParser.getRangeQuery(String,String,String,boolean) to
use a different method for date conversion.
Note that QueryParser is not thread-safe.
author:
Brian Goetz
author:
Peter Halacsy
author:
Tatu Saloranta |
| Inner Class :final public static class Operator extends Parameter | |
| Inner Class :final static class JJCalls | |
| Method Summary | |
| final public Query | Clause(String field)
| | final public int | Conjunction()
| | final public int | Modifiers()
| | final public Query | Query(String field)
| | public void | ReInit(CharStream stream)
| | public void | ReInit(QueryParserTokenManager tm)
| | final public Query | Term(String field)
| | final public Query | TopLevelQuery(String field)
| | protected void | addClause(Vector clauses, int conj, int mods, Query q)
| | final public void | disable_tracing()
| | final public void | enable_tracing()
| | public static String | escape(String s)
Returns a String where those characters that QueryParser
expects to be escaped are escaped by a preceding \. | | public ParseException | generateParseException()
| | public boolean | getAllowLeadingWildcard()
| | public Analyzer | getAnalyzer()
| | protected Query | getBooleanQuery(Vector clauses)
Factory method for generating query, given a set of clauses.
By default creates a boolean query composed of clauses passed in.
Can be overridden by extending classes, to modify query being
returned.
Parameters:
clauses - Vector that contains BooleanClause instancesto join. | | protected Query | getBooleanQuery(Vector clauses, boolean disableCoord)
Factory method for generating query, given a set of clauses.
By default creates a boolean query composed of clauses passed in.
Can be overridden by extending classes, to modify query being
returned.
Parameters:
clauses - Vector that contains BooleanClause instancesto join.
Parameters:
disableCoord - true if coord scoring should be disabled. | | public DateTools.Resolution | getDateResolution(String fieldName)
Returns the date resolution that is used by RangeQueries for the given field. | | public Operator | getDefaultOperator()
Gets implicit operator setting, which will be either AND_OPERATOR
or OR_OPERATOR. | | public boolean | getEnablePositionIncrements()
| | public String | getField()
| | protected Query | getFieldQuery(String field, String queryText)
| | protected Query | getFieldQuery(String field, String queryText, int slop)
Base implementation delegates to
QueryParser.getFieldQuery(String,String) . | | public float | getFuzzyMinSim()
Get the minimal similarity for fuzzy queries. | | public 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.getWildcardQuery ). | | public Locale | getLocale()
Returns current locale, allowing access by subclasses. | | public boolean | getLowercaseExpandedTerms()
| | final public Token | getNextToken()
| | public int | getPhraseSlop()
Gets the default slop for phrases. | | protected Query | getPrefixQuery(String field, String termStr)
Factory method for generating a query (similar to
QueryParser.getWildcardQuery ). | | protected Query | getRangeQuery(String field, String part1, String part2, boolean inclusive)
| | final public Token | getToken(int index)
| | public boolean | getUseOldRangeQuery()
| | protected Query | getWildcardQuery(String field, String termStr)
Factory method for generating a query. | | public static void | main(String[] args)
Command line tool to test QueryParser, using
org.apache.lucene.analysis.SimpleAnalyzer . | | public Query | parse(String query)
Parses a query string, returning a
org.apache.lucene.search.Query . | | 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. | | 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. | | public void | setDateResolution(String fieldName, DateTools.Resolution dateResolution)
Sets the date resolution used by RangeQueries for a specific field. | | public void | setDefaultOperator(Operator op)
Sets the boolean operator of the QueryParser. | | public void | setEnablePositionIncrements(boolean enable)
Set to 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. | | public void | setFuzzyMinSim(float fuzzyMinSim)
Set the minimum similarity for fuzzy queries. | | public void | setFuzzyPrefixLength(int fuzzyPrefixLength)
Set the prefix length for fuzzy queries. | | public void | setLocale(Locale locale)
Set locale used by date range parsing. | | public void | setLowercaseExpandedTerms(boolean lowercaseExpandedTerms)
Whether terms of wildcard, prefix, fuzzy and range queries are to be automatically
lower-cased or not. | | public void | setPhraseSlop(int phraseSlop)
Sets the default slop for phrases. | | public void | setUseOldRangeQuery(boolean useOldRangeQuery)
By default QueryParser uses new ConstantScoreRangeQuery in preference to RangeQuery
for range queries. |
| AND_OPERATOR | | final public static Operator AND_OPERATOR(Code) | | Alternative form of QueryParser.Operator.AND
|
| OR_OPERATOR | | final public static Operator OR_OPERATOR(Code) | | Alternative form of QueryParser.Operator.OR
|
| allowLeadingWildcard | | boolean allowLeadingWildcard(Code) | | |
| enablePositionIncrements | | boolean enablePositionIncrements(Code) | | |
| fieldToDateResolution | | Map fieldToDateResolution(Code) | | |
| fuzzyMinSim | | float fuzzyMinSim(Code) | | |
| fuzzyPrefixLength | | int fuzzyPrefixLength(Code) | | |
| lookingAhead | | public boolean lookingAhead(Code) | | |
| lowercaseExpandedTerms | | boolean lowercaseExpandedTerms(Code) | | |
| phraseSlop | | int phraseSlop(Code) | | |
| useOldRangeQuery | | boolean useOldRangeQuery(Code) | | |
| QueryParser | | public QueryParser(String f, Analyzer a)(Code) | | Constructs a query parser.
Parameters:
f - the default field for query terms.
Parameters:
a - used to find terms in the query text. |
| disable_tracing | | final public void disable_tracing()(Code) | | |
| enable_tracing | | final public void enable_tracing()(Code) | | |
| escape | | public static String escape(String s)(Code) | | Returns a String where those characters that QueryParser
expects to be escaped are escaped by a preceding \.
|
| getBooleanQuery | | protected Query getBooleanQuery(Vector clauses) throws ParseException(Code) | | Factory method for generating query, given a set of clauses.
By default creates a boolean query composed of clauses passed in.
Can be overridden by extending classes, to modify query being
returned.
Parameters:
clauses - Vector that contains BooleanClause instancesto join. Resulting Query object.
exception:
ParseException - throw in overridden method to disallow |
| getBooleanQuery | | protected Query getBooleanQuery(Vector clauses, boolean disableCoord) throws ParseException(Code) | | Factory method for generating query, given a set of clauses.
By default creates a boolean query composed of clauses passed in.
Can be overridden by extending classes, to modify query being
returned.
Parameters:
clauses - Vector that contains BooleanClause instancesto join.
Parameters:
disableCoord - true if coord scoring should be disabled. Resulting Query object.
exception:
ParseException - throw in overridden method to disallow |
| getDateResolution | | public DateTools.Resolution getDateResolution(String fieldName)(Code) | | 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.
|
| getDefaultOperator | | public Operator getDefaultOperator()(Code) | | Gets implicit operator setting, which will be either AND_OPERATOR
or OR_OPERATOR.
|
| getFuzzyMinSim | | public float getFuzzyMinSim()(Code) | | Get the minimal similarity for fuzzy queries.
|
| getFuzzyPrefixLength | | public int getFuzzyPrefixLength()(Code) | | Get the prefix length for fuzzy queries.
Returns the fuzzyPrefixLength. |
| getFuzzyQuery | | protected Query getFuzzyQuery(String field, String termStr, float minSimilarity) throws ParseException(Code) | | Factory method for generating a query (similar to
QueryParser.getWildcardQuery ). Called when parser parses
an input term token that has the fuzzy suffix (~) appended.
Parameters:
field - Name of the field query will use.
Parameters:
termStr - Term token to use for building term for the query Resulting Query built for the term
exception:
ParseException - throw in overridden method to disallow |
| getLocale | | public Locale getLocale()(Code) | | Returns current locale, allowing access by subclasses.
|
| getPhraseSlop | | public int getPhraseSlop()(Code) | | Gets the default slop for phrases.
|
| getPrefixQuery | | protected Query getPrefixQuery(String field, String termStr) throws ParseException(Code) | | Factory method for generating a query (similar to
QueryParser.getWildcardQuery ). 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.
Parameters:
field - Name of the field query will use.
Parameters:
termStr - Term token to use for building term for the query(without trailing '*' character!) Resulting Query built for the term
exception:
ParseException - throw in overridden method to disallow |
| getWildcardQuery | | protected Query getWildcardQuery(String field, String termStr) throws ParseException(Code) | | Factory method for generating a query. Called when parser
parses an input term token that contains one or more wildcard
characters (? and *), but is not a prefix term token (one
that has just a single * character at the end)
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.
Parameters:
termStr - Term token that contains one or more wild cardcharacters (? or *), but is not simple prefix term Resulting Query built for the term
exception:
ParseException - throw in overridden method to disallow |
| setAllowLeadingWildcard | | public void setAllowLeadingWildcard(boolean allowLeadingWildcard)(Code) | | 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.
|
| setDateResolution | | public void setDateResolution(String fieldName, DateTools.Resolution dateResolution)(Code) | | Sets the date resolution used by RangeQueries for a specific field.
Parameters:
fieldName - field for which the date resolution is to be set
Parameters:
dateResolution - date resolution to set |
| setDefaultOperator | | public void setDefaultOperator(Operator op)(Code) | | 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 conjuction: the
above mentioned query is parsed as capital AND of AND Hungary
|
| setEnablePositionIncrements | | public void setEnablePositionIncrements(boolean enable)(Code) | | Set to 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.
|
| setFuzzyMinSim | | public void setFuzzyMinSim(float fuzzyMinSim)(Code) | | Set the minimum similarity for fuzzy queries.
Default is 0.5f.
|
| setFuzzyPrefixLength | | public void setFuzzyPrefixLength(int fuzzyPrefixLength)(Code) | | Set the prefix length for fuzzy queries. Default is 0.
Parameters:
fuzzyPrefixLength - The fuzzyPrefixLength to set. |
| setLocale | | public void setLocale(Locale locale)(Code) | | Set locale used by date range parsing.
|
| setLowercaseExpandedTerms | | public void setLowercaseExpandedTerms(boolean lowercaseExpandedTerms)(Code) | | Whether terms of wildcard, prefix, fuzzy and range queries are to be automatically
lower-cased or not. Default is true.
|
| setPhraseSlop | | public void setPhraseSlop(int phraseSlop)(Code) | | Sets the default slop for phrases. If zero, then exact phrase matches
are required. Default value is zero.
|
| setUseOldRangeQuery | | public void setUseOldRangeQuery(boolean useOldRangeQuery)(Code) | | By default QueryParser uses new ConstantScoreRangeQuery in preference to RangeQuery
for range queries. This implementation is generally preferable because it
a) Runs faster b) Does not have the scarcity of range terms unduly influence score
c) avoids any "TooManyBooleanClauses" exception.
However, if your application really needs to use the old-fashioned RangeQuery and the above
points are not required then set this option to true
Default is false.
|
|
|