|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.queryParser.QueryParser
public class QueryParser
This class is generated by JavaCC. The most important method is
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 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 accpeted input depends on the locale
. This
feature also assumes that your index uses the DateField
class to store dates.
If you use a different format (e.g. DateTools
) and you still want QueryParser
to turn local dates in range queries into valid queries you need to create your own
query parser that inherits QueryParser and overwrites
getRangeQuery(String, String, String, boolean)
.
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 |
static int |
DEFAULT_OPERATOR_AND
Deprecated. use AND_OPERATOR instead |
static int |
DEFAULT_OPERATOR_OR
Deprecated. use OR_OPERATOR instead |
Token |
jj_nt
|
boolean |
lookingAhead
|
static QueryParser.Operator |
OR_OPERATOR
Alternative form of QueryParser.Operator.OR |
Token |
token
|
QueryParserTokenManager |
token_source
|
Fields inherited from interface org.apache.lucene.queryParser.QueryParserConstants |
---|
_ESCAPED_CHAR, _NUM_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, TERM, tokenImage, WILDTERM |
Constructor Summary | |
---|---|
QueryParser(CharStream stream)
|
|
QueryParser(QueryParserTokenManager tm)
|
|
QueryParser(java.lang.String f,
Analyzer a)
Constructs a query parser. |
Method Summary | |
---|---|
protected void |
addClause(java.util.Vector clauses,
int conj,
int mods,
Query q)
|
Query |
Clause(java.lang.String field)
|
int |
Conjunction()
|
void |
disable_tracing()
|
void |
enable_tracing()
|
static java.lang.String |
escape(java.lang.String s)
Returns a String where those characters that QueryParser expects to be escaped are escaped by a preceding \ . |
ParseException |
generateParseException()
|
Analyzer |
getAnalyzer()
|
protected Query |
getBooleanQuery(java.util.Vector clauses)
Factory method for generating query, given a set of clauses. |
protected Query |
getBooleanQuery(java.util.Vector clauses,
boolean disableCoord)
Factory method for generating query, given a set of clauses. |
QueryParser.Operator |
getDefaultOperator()
Gets implicit operator setting, which will be either AND_OPERATOR or OR_OPERATOR. |
java.lang.String |
getField()
|
protected Query |
getFieldQuery(java.lang.String field,
Analyzer analyzer,
java.lang.String queryText)
Deprecated. use getFieldQuery(String, String) |
protected Query |
getFieldQuery(java.lang.String field,
Analyzer analyzer,
java.lang.String queryText,
int slop)
Deprecated. use getFieldQuery(String, String, int) |
protected Query |
getFieldQuery(java.lang.String field,
java.lang.String queryText)
|
protected Query |
getFieldQuery(java.lang.String field,
java.lang.String queryText,
int slop)
Base implementation delegates to getFieldQuery(String,String) . |
float |
getFuzzyMinSim()
Get the minimal similarity for fuzzy queries. |
int |
getFuzzyPrefixLength()
Get the prefix length for fuzzy queries. |
protected Query |
getFuzzyQuery(java.lang.String field,
java.lang.String termStr)
Deprecated. use getFuzzyQuery(String, String, float) |
protected Query |
getFuzzyQuery(java.lang.String field,
java.lang.String termStr,
float minSimilarity)
Factory method for generating a query (similar to getWildcardQuery(java.lang.String, java.lang.String) ). |
java.util.Locale |
getLocale()
Returns current locale, allowing access by subclasses. |
boolean |
getLowercaseExpandedTerms()
|
boolean |
getLowercaseWildcardTerms()
Deprecated. use getLowercaseExpandedTerms() instead |
Token |
getNextToken()
|
int |
getOperator()
Deprecated. use getDefaultOperator() instead |
int |
getPhraseSlop()
Gets the default slop for phrases. |
protected Query |
getPrefixQuery(java.lang.String field,
java.lang.String termStr)
Factory method for generating a query (similar to getWildcardQuery(java.lang.String, java.lang.String) ). |
protected Query |
getRangeQuery(java.lang.String field,
Analyzer analyzer,
java.lang.String part1,
java.lang.String part2,
boolean inclusive)
Deprecated. use getRangeQuery(String, String, String, boolean) |
protected Query |
getRangeQuery(java.lang.String field,
java.lang.String part1,
java.lang.String part2,
boolean inclusive)
|
Token |
getToken(int index)
|
protected Query |
getWildcardQuery(java.lang.String field,
java.lang.String termStr)
Factory method for generating a query. |
static void |
main(java.lang.String[] args)
Command line tool to test QueryParser, using SimpleAnalyzer . |
int |
Modifiers()
|
Query |
parse(java.lang.String query)
Parses a query string, returning a Query . |
static Query |
parse(java.lang.String query,
java.lang.String field,
Analyzer analyzer)
Deprecated. Use an instance of QueryParser and the parse(String) method instead. |
Query |
Query(java.lang.String field)
|
void |
ReInit(CharStream stream)
|
void |
ReInit(QueryParserTokenManager tm)
|
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(java.util.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 |
setLowercaseWildcardTerms(boolean lowercaseExpandedTerms)
Deprecated. use setLowercaseExpandedTerms(boolean) instead |
void |
setOperator(int op)
Deprecated. use setDefaultOperator(QueryParser.Operator) instead |
void |
setPhraseSlop(int phraseSlop)
Sets the default slop for phrases. |
Query |
Term(java.lang.String field)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_OPERATOR_OR
OR_OPERATOR
insteadpublic static final int DEFAULT_OPERATOR_AND
AND_OPERATOR
insteadpublic 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 boolean lookingAhead
Constructor Detail |
---|
public QueryParser(java.lang.String f, Analyzer a)
f
- the default field for query terms.a
- used to find terms in the query text.public QueryParser(CharStream stream)
public QueryParser(QueryParserTokenManager tm)
Method Detail |
---|
public static Query parse(java.lang.String query, java.lang.String field, Analyzer analyzer) throws ParseException
parse(String)
method instead.
Query
.
query
- the query string to be parsed.field
- the default field for query terms.analyzer
- used to find terms in the query text.
ParseException
- if the parsing failspublic Query parse(java.lang.String query) throws ParseException
Query
.
query
- the query string to be parsed.
ParseException
- if the parsing failspublic Analyzer getAnalyzer()
public java.lang.String getField()
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 setOperator(int op)
setDefaultOperator(QueryParser.Operator)
instead
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
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 conjuction: the
above mentioned query is parsed as capital AND of AND Hungary
public int getOperator()
getDefaultOperator()
instead
public QueryParser.Operator getDefaultOperator()
public void setLowercaseWildcardTerms(boolean lowercaseExpandedTerms)
setLowercaseExpandedTerms(boolean)
instead
true
.
public void setLowercaseExpandedTerms(boolean lowercaseExpandedTerms)
true
.
public boolean getLowercaseWildcardTerms()
getLowercaseExpandedTerms()
instead
public boolean getLowercaseExpandedTerms()
setLowercaseExpandedTerms(boolean)
public void setLocale(java.util.Locale locale)
public java.util.Locale getLocale()
protected void addClause(java.util.Vector clauses, int conj, int mods, Query q)
protected Query getFieldQuery(java.lang.String field, Analyzer analyzer, java.lang.String queryText) throws ParseException
getFieldQuery(String, String)
ParseException
- throw in overridden method to disallowprotected Query getFieldQuery(java.lang.String field, java.lang.String queryText) throws ParseException
ParseException
- throw in overridden method to disallowprotected Query getFieldQuery(java.lang.String field, Analyzer analyzer, java.lang.String queryText, int slop) throws ParseException
getFieldQuery(String, String, int)
ParseException
- throw in overridden method to disallowprotected Query getFieldQuery(java.lang.String field, java.lang.String queryText, int slop) throws ParseException
getFieldQuery(String,String)
.
This method may be overridden, for example, to return
a SpanNearQuery instead of a PhraseQuery.
ParseException
- throw in overridden method to disallowprotected Query getRangeQuery(java.lang.String field, Analyzer analyzer, java.lang.String part1, java.lang.String part2, boolean inclusive) throws ParseException
getRangeQuery(String, String, String, boolean)
ParseException
- throw in overridden method to disallowprotected Query getRangeQuery(java.lang.String field, java.lang.String part1, java.lang.String part2, boolean inclusive) throws ParseException
ParseException
- throw in overridden method to disallowprotected Query getBooleanQuery(java.util.Vector clauses) throws ParseException
clauses
- Vector that contains BooleanClause
instances
to join.
Query
object.
ParseException
- throw in overridden method to disallowprotected Query getBooleanQuery(java.util.Vector clauses, boolean disableCoord) throws ParseException
clauses
- Vector 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(java.lang.String field, java.lang.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 term
Query
built for the term
ParseException
- throw in overridden method to disallowprotected Query getPrefixQuery(java.lang.String field, java.lang.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 term
ParseException
- throw in overridden method to disallowprotected Query getFuzzyQuery(java.lang.String field, java.lang.String termStr) throws ParseException
getFuzzyQuery(String, String, float)
ParseException
protected Query getFuzzyQuery(java.lang.String field, java.lang.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 query
Query
built for the term
ParseException
- throw in overridden method to disallowpublic static java.lang.String escape(java.lang.String s)
\
.
public static void main(java.lang.String[] args) throws java.lang.Exception
SimpleAnalyzer
.
Usage:java org.apache.lucene.queryParser.QueryParser <input>
java.lang.Exception
public final int Conjunction() throws ParseException
ParseException
public final int Modifiers() throws ParseException
ParseException
public final Query Query(java.lang.String field) throws ParseException
ParseException
public final Query Clause(java.lang.String field) throws ParseException
ParseException
public final Query Term(java.lang.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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |