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 test cases.
Field Summary | |
---|---|
static int | DEFAULT_OPERATOR_AND |
static int | DEFAULT_OPERATOR_OR |
Token | jj_nt |
boolean | lookingAhead |
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, i.e. preceded by a \ . |
ParseException | generateParseException() |
Analyzer | getAnalyzer() |
protected Query | getBooleanQuery(Vector clauses)
Factory method for generating query, given a set of clauses.
|
String | getField() |
protected Query | getFieldQuery(String field, Analyzer analyzer, String queryText)
Note that parameter analyzer is ignored. |
protected Query | getFieldQuery(String field, String queryText) |
protected Query | getFieldQuery(String field, Analyzer analyzer, String queryText, int slop)
Base implementation delegates to {@link #getFieldQuery(String, Analyzer, String)}.
|
protected Query | getFieldQuery(String field, String queryText, int slop)
Base implementation delegates to {@link #getFieldQuery(String,String)}.
|
float | getFuzzyMinSim()
Get the default minimal similarity for fuzzy queries. |
protected Query | getFuzzyQuery(String field, String termStr)
Factory method for generating a query (similar to
({@link #getWildcardQuery}). |
protected Query | getFuzzyQuery(String field, String termStr, float minSimilarity)
Factory method for generating a query (similar to
({@link #getWildcardQuery}). |
Locale | getLocale()
Returns current locale, allowing access by subclasses. |
boolean | getLowercaseWildcardTerms() |
Token | getNextToken() |
int | getOperator()
Gets implicit operator setting, which will be either DEFAULT_OPERATOR_AND
or DEFAULT_OPERATOR_OR. |
int | getPhraseSlop()
Gets the default slop for phrases. |
protected Query | getPrefixQuery(String field, String termStr)
Factory method for generating a query (similar to
({@link #getWildcardQuery}). |
protected Query | getRangeQuery(String field, Analyzer analyzer, String part1, String part2, boolean inclusive)
Note that parameter analyzer is ignored. |
protected Query | getRangeQuery(String field, String part1, String part2, boolean inclusive) |
Token | getToken(int index) |
protected Query | getWildcardQuery(String field, String termStr)
Factory method for generating a query. |
static void | main(String[] args) |
int | Modifiers() |
static Query | parse(String query, String field, Analyzer analyzer) Parses a query string, returning a {@link org.apache.lucene.search.Query}. |
Query | parse(String query) Parses a query string, returning a
Query. |
Query | Query(String field) |
void | ReInit(CharStream stream) |
void | ReInit(QueryParserTokenManager tm) |
void | setFuzzyMinSim(float fuzzyMinSim)
Set the default minimum similarity for fuzzy queries. |
void | setLocale(Locale locale)
Set locale used by date range parsing. |
void | setLowercaseWildcardTerms(boolean lowercaseWildcardTerms) |
void | setOperator(int operator)
Sets the boolean operator of the QueryParser.
|
void | setPhraseSlop(int phraseSlop)
Sets the default slop for phrases. |
Query | Term(String field) |
Parameters: f the default field for query terms. a used to find terms in the query text.
\
.Returns: Returns the analyzer.
Parameters: clauses Vector that contains {@link BooleanClause} instances to join.
Returns: Resulting {@link 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
Throws: ParseException throw in overridden method to disallow
Throws: ParseException throw in overridden method to disallow
Parameters: field Name of the field query will use. termStr Term token to use for building term for the query
Returns: Resulting {@link Query} built for the term
Throws: ParseException throw in overridden method to disallow
Parameters: field Name of the field query will use. termStr Term token to use for building term for the query minSimilarity the minimum similarity required for a fuzzy match
Returns: Resulting {@link Query} built for the term
Throws: ParseException throw in overridden method to disallow
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 {@link Query} built for the term
Throws: ParseException throw in overridden method to disallow
Throws: ParseException throw in overridden method to disallow
Throws: ParseException throw in overridden method to disallow
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 {@link Query} built for the term
Throws: ParseException throw in overridden method to disallow
Parameters: query the query string to be parsed. field the default field for query terms. analyzer used to find terms in the query text.
Throws: ParseException if the parsing fails
Parameters: query the query string to be parsed.
Throws: ParseException if the parsing fails
DEFAULT_OPERATOR_OR
) terms without any modifiers
are considered optional: for example capital of Hungary
is equal to
capital OR of OR Hungary
.DEFAULT_OPERATOR_AND
terms are considered to be in conjuction: the
above mentioned query is parsed as capital AND of AND Hungary