|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.gouv.culture.sdx.search.lucene.queryparser.DefaultQueryParser
This class is generated by JavaCC. The only method that clients should need to call is parse(). 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 test cases.
Field Summary | |
Analyzer |
analyzer
|
static int |
DEFAULT_OPERATOR_AND
|
static int |
DEFAULT_OPERATOR_OR
|
Token |
jj_nt
|
boolean |
lookingAhead
|
Token |
token
|
DefaultQueryParserTokenManager |
token_source
|
Fields inherited from interface fr.gouv.culture.sdx.search.lucene.queryparser.QueryParser |
DEFAULT_OPERATOR, DEFAULT_PHRASE_SLOP, OPERATOR_AND, OPERATOR_OR |
Fields inherited from interface fr.gouv.culture.sdx.search.lucene.queryparser.DefaultQueryParserConstants |
_ESCAPED_CHAR, _NUM_CHAR, _TERM_CHAR, _TERM_START_CHAR, _WHITESPACE, AND, Boost, CARAT, COLON, DEFAULT, EOF, FUZZY, LPAREN, MINUS, NO_ANALYSIS, 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, SLOP, TERM, tokenImage, WILDTERM |
Constructor Summary | |
DefaultQueryParser()
Constructs a query parser. |
|
DefaultQueryParser(CharStream stream)
|
|
DefaultQueryParser(DefaultQueryParserTokenManager tm)
|
|
DefaultQueryParser(java.lang.String f,
Analyzer a)
Constructs a query parser. |
Method Summary | |
protected void |
addClause(java.util.Vector clauses,
int conj,
int mods,
org.apache.lucene.search.Query q)
|
org.apache.lucene.search.Query |
Clause(java.lang.String field)
|
int |
Conjunction()
|
void |
disable_tracing()
|
void |
enable_tracing()
|
ParseException |
generateParseException()
|
protected org.apache.lucene.search.Query |
getBooleanQuery(java.util.Vector clauses)
Factory method for generating query, given a set of clauses. |
protected org.apache.lucene.search.Query |
getFieldQuery(java.lang.String field,
Analyzer analyzer,
java.lang.String queryText)
|
protected org.apache.lucene.search.Query |
getFuzzyQuery(java.lang.String field,
java.lang.String termStr)
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 |
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 org.apache.lucene.search.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 org.apache.lucene.search.Query |
getRangeQuery(java.lang.String field,
Analyzer analyzer,
java.lang.String part1,
java.lang.String part2,
boolean inclusive)
|
Token |
getToken(int index)
|
protected org.apache.lucene.search.Query |
getUnanalyzedQuery(java.lang.String field,
java.lang.String queryText)
|
protected org.apache.lucene.search.Query |
getWildcardQuery(java.lang.String field,
java.lang.String termStr)
Factory method for generating a query. |
static void |
main(java.lang.String[] args)
|
int |
Modifiers()
|
org.apache.lucene.search.Query |
parse(java.lang.String query)
Parses a query string, returning a Query. |
static org.apache.lucene.search.Query |
parse(java.lang.String query,
java.lang.String field,
Analyzer analyzer)
Parses a query string, returning a Query . |
org.apache.lucene.search.Query |
Query(java.lang.String field)
|
void |
ReInit(CharStream stream)
|
void |
ReInit(DefaultQueryParserTokenManager tm)
|
void |
setLocale(java.util.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. |
void |
setUp(Analyzer a,
int phraseSlop,
int operator)
Sets the fields of the query parser |
void |
setUp(java.lang.String f,
Analyzer a)
Sets the fields of the query parser |
void |
setUp(java.lang.String f,
Analyzer a,
int phraseSlop,
int operator)
Sets the fields of the query parser |
org.apache.lucene.search.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
public static final int DEFAULT_OPERATOR_AND
public Analyzer analyzer
public DefaultQueryParserTokenManager token_source
public Token token
public Token jj_nt
public boolean lookingAhead
Constructor Detail |
public DefaultQueryParser()
public DefaultQueryParser(java.lang.String f, Analyzer a)
f
- the default field for query terms.a
- used to find terms in the query text.public DefaultQueryParser(CharStream stream)
public DefaultQueryParser(DefaultQueryParserTokenManager tm)
Method Detail |
public static org.apache.lucene.search.Query parse(java.lang.String query, java.lang.String field, Analyzer analyzer) throws ParseException
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 void setUp(java.lang.String f, Analyzer a)
setUp
in interface QueryParser
f
- the default field for query terms.a
- used to find terms in the query text.public void setUp(Analyzer a, int phraseSlop, int operator)
setUp
in interface QueryParser
a
- used to find terms in the query text.phraseSlop
- the slopoperator
- the operatorpublic void setUp(java.lang.String f, Analyzer a, int phraseSlop, int operator)
setUp
in interface QueryParser
f
- the default field for query terms.a
- used to find terms in the query text.phraseSlop
- the slopoperator
- the operatorpublic org.apache.lucene.search.Query parse(java.lang.String query) throws ParseException
parse
in interface QueryParser
query
- the query string to be parsed.
ParseException
- if the parsing failspublic void setPhraseSlop(int phraseSlop)
setPhraseSlop
in interface QueryParser
public int getPhraseSlop()
getPhraseSlop
in interface QueryParser
public void setOperator(int operator)
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
setOperator
in interface QueryParser
public int getOperator()
getOperator
in interface QueryParser
public void setLowercaseWildcardTerms(boolean lowercaseWildcardTerms)
public boolean getLowercaseWildcardTerms()
public void setLocale(java.util.Locale locale)
public java.util.Locale getLocale()
protected void addClause(java.util.Vector clauses, int conj, int mods, org.apache.lucene.search.Query q)
protected org.apache.lucene.search.Query getFieldQuery(java.lang.String field, Analyzer analyzer, java.lang.String queryText) throws ParseException
ParseException
- throw in overridden method to disallowprotected org.apache.lucene.search.Query getUnanalyzedQuery(java.lang.String field, java.lang.String queryText)
protected org.apache.lucene.search.Query getRangeQuery(java.lang.String field, Analyzer analyzer, java.lang.String part1, java.lang.String part2, boolean inclusive) throws ParseException
ParseException
- throw in overridden method to disallowprotected org.apache.lucene.search.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 org.apache.lucene.search.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 org.apache.lucene.search.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 org.apache.lucene.search.Query getFuzzyQuery(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 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 void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception
public final int Conjunction() throws ParseException
ParseException
public final int Modifiers() throws ParseException
ParseException
public final org.apache.lucene.search.Query Query(java.lang.String field) throws ParseException
ParseException
public final org.apache.lucene.search.Query Clause(java.lang.String field) throws ParseException
ParseException
public final org.apache.lucene.search.Query Term(java.lang.String field) throws ParseException
ParseException
public void ReInit(CharStream stream)
public void ReInit(DefaultQueryParserTokenManager 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 |