org.apache.lucene.queryparser.classic
public abstract class QueryParserBase extends QueryBuilder implements CommonQueryParserConfiguration
Modifier and Type | Class and Description |
---|---|
static class |
QueryParserBase.MethodRemovedUseAnother
Do not catch this exception in your code, it means you are using methods that you should no longer use.
|
Modifier and Type | Field and Description |
---|---|
static QueryParser.Operator |
AND_OPERATOR
Alternative form of QueryParser.Operator.AND
|
static QueryParser.Operator |
OR_OPERATOR
Alternative form of QueryParser.Operator.OR
|
Modifier | Constructor and Description |
---|---|
protected |
QueryParserBase() |
Modifier and Type | Method and Description |
---|---|
protected void |
addClause(List<BooleanClause> clauses,
int conj,
int mods,
Query q) |
protected BytesRef |
analyzeMultitermTerm(String field,
String part,
Analyzer analyzerIn) |
static String |
escape(String s)
Returns a String where those characters that QueryParser
expects to be escaped are escaped by a preceding
\ . |
boolean |
getAllowLeadingWildcard() |
boolean |
getAnalyzeRangeTerms() |
boolean |
getAutoGeneratePhraseQueries() |
protected Query |
getBooleanQuery(List<BooleanClause> clauses)
Factory method for generating query, given a set of clauses.
|
protected Query |
getBooleanQuery(List<BooleanClause> 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,
boolean quoted) |
protected Query |
getFieldQuery(String field,
String queryText,
int slop)
Base implementation delegates to
getFieldQuery(String,String,boolean) . |
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
getWildcardQuery(java.lang.String, java.lang.String) ). |
Locale |
getLocale()
Returns current locale, allowing access by subclasses.
|
boolean |
getLowercaseExpandedTerms() |
MultiTermQuery.RewriteMethod |
getMultiTermRewriteMethod() |
int |
getPhraseSlop()
Gets the default slop for phrases.
|
protected Query |
getPrefixQuery(String field,
String termStr)
Factory method for generating a query (similar to
getWildcardQuery(java.lang.String, java.lang.String) ). |
protected Query |
getRangeQuery(String field,
String part1,
String part2,
boolean startInclusive,
boolean endInclusive) |
protected Query |
getRegexpQuery(String field,
String termStr)
Factory method for generating a query.
|
TimeZone |
getTimeZone() |
protected Query |
getWildcardQuery(String field,
String termStr)
Factory method for generating a query.
|
void |
init(Version matchVersion,
String f,
Analyzer a)
Initializes a query parser.
|
protected BooleanClause |
newBooleanClause(Query q,
BooleanClause.Occur occur)
Builds a new BooleanClause instance
|
protected Query |
newFieldQuery(Analyzer analyzer,
String field,
String queryText,
boolean quoted) |
protected Query |
newFuzzyQuery(Term term,
float minimumSimilarity,
int prefixLength)
Builds a new FuzzyQuery instance
|
protected Query |
newMatchAllDocsQuery()
Builds a new MatchAllDocsQuery instance
|
protected Query |
newPrefixQuery(Term prefix)
Builds a new PrefixQuery instance
|
protected Query |
newRangeQuery(String field,
String part1,
String part2,
boolean startInclusive,
boolean endInclusive)
Builds a new
TermRangeQuery instance |
protected Query |
newRegexpQuery(Term regexp)
Builds a new RegexpQuery instance
|
protected Query |
newWildcardQuery(Term t)
Builds a new WildcardQuery instance
|
Query |
parse(String query)
Parses a query string, returning a
Query . |
abstract void |
ReInit(CharStream stream) |
void |
setAllowLeadingWildcard(boolean allowLeadingWildcard)
Set to
true to allow leading wildcard characters. |
void |
setAnalyzeRangeTerms(boolean analyzeRangeTerms)
Set whether or not to analyze range terms when constructing
TermRangeQuery s. |
void |
setAutoGeneratePhraseQueries(boolean value)
Set to true if phrase queries will be automatically generated
when the analyzer returns more than one term from whitespace
delimited text.
|
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, lowercasing, and other
locale-sensitive operations.
|
void |
setLowercaseExpandedTerms(boolean lowercaseExpandedTerms)
Whether terms of wildcard, prefix, fuzzy and range queries are to be automatically
lower-cased or not.
|
void |
setMultiTermRewriteMethod(MultiTermQuery.RewriteMethod method)
By default QueryParser uses
MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT
when creating a PrefixQuery , WildcardQuery or TermRangeQuery . |
void |
setPhraseSlop(int phraseSlop)
Sets the default slop for phrases.
|
void |
setTimeZone(TimeZone timeZone) |
abstract Query |
TopLevelQuery(String field) |
createBooleanQuery, createBooleanQuery, createFieldQuery, createMinShouldMatchQuery, createPhraseQuery, createPhraseQuery, getAnalyzer, getEnablePositionIncrements, newBooleanQuery, newMultiPhraseQuery, newPhraseQuery, newTermQuery, setAnalyzer, setEnablePositionIncrements
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAnalyzer, getEnablePositionIncrements, setEnablePositionIncrements
public static final QueryParser.Operator AND_OPERATOR
public static final QueryParser.Operator OR_OPERATOR
public void init(Version matchVersion, String f, Analyzer a)
matchVersion
- Lucene version to match. See here.f
- the default field for query terms.a
- used to find terms in the query text.public abstract void ReInit(CharStream stream)
public abstract Query TopLevelQuery(String field) throws ParseException
ParseException
public Query parse(String query) throws ParseException
Query
.query
- the query string to be parsed.ParseException
- if the parsing failspublic String getField()
public final boolean getAutoGeneratePhraseQueries()
public final void setAutoGeneratePhraseQueries(boolean value)
Set to false if phrase queries should only be generated when surrounded by double quotes.
public float getFuzzyMinSim()
getFuzzyMinSim
in interface CommonQueryParserConfiguration
public void setFuzzyMinSim(float fuzzyMinSim)
setFuzzyMinSim
in interface CommonQueryParserConfiguration
public int getFuzzyPrefixLength()
getFuzzyPrefixLength
in interface CommonQueryParserConfiguration
public void setFuzzyPrefixLength(int fuzzyPrefixLength)
setFuzzyPrefixLength
in interface CommonQueryParserConfiguration
fuzzyPrefixLength
- The fuzzyPrefixLength to set.public void setPhraseSlop(int phraseSlop)
setPhraseSlop
in interface CommonQueryParserConfiguration
public int getPhraseSlop()
getPhraseSlop
in interface CommonQueryParserConfiguration
public void setAllowLeadingWildcard(boolean allowLeadingWildcard)
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.
setAllowLeadingWildcard
in interface CommonQueryParserConfiguration
public boolean getAllowLeadingWildcard()
getAllowLeadingWildcard
in interface CommonQueryParserConfiguration
setAllowLeadingWildcard(boolean)
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 conjunction: the
above mentioned query is parsed as capital AND of AND Hungary
public QueryParser.Operator getDefaultOperator()
public void setLowercaseExpandedTerms(boolean lowercaseExpandedTerms)
true
.setLowercaseExpandedTerms
in interface CommonQueryParserConfiguration
public boolean getLowercaseExpandedTerms()
getLowercaseExpandedTerms
in interface CommonQueryParserConfiguration
setLowercaseExpandedTerms(boolean)
public void setMultiTermRewriteMethod(MultiTermQuery.RewriteMethod method)
MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT
when creating a PrefixQuery
, WildcardQuery
or TermRangeQuery
. This implementation is generally preferable because it
a) Runs faster b) Does not have the scarcity of terms unduly influence score
c) avoids any BooleanQuery.TooManyClauses
exception.
However, if your application really needs to use the
old-fashioned BooleanQuery
expansion rewriting and the above
points are not relevant then use this to change
the rewrite method.setMultiTermRewriteMethod
in interface CommonQueryParserConfiguration
public MultiTermQuery.RewriteMethod getMultiTermRewriteMethod()
getMultiTermRewriteMethod
in interface CommonQueryParserConfiguration
setMultiTermRewriteMethod(org.apache.lucene.search.MultiTermQuery.RewriteMethod)
public void setLocale(Locale locale)
setLocale
in interface CommonQueryParserConfiguration
public Locale getLocale()
getLocale
in interface CommonQueryParserConfiguration
public void setTimeZone(TimeZone timeZone)
setTimeZone
in interface CommonQueryParserConfiguration
public TimeZone getTimeZone()
getTimeZone
in interface CommonQueryParserConfiguration
public void setDateResolution(DateTools.Resolution dateResolution)
setDateResolution(String, org.apache.lucene.document.DateTools.Resolution)
.setDateResolution
in interface CommonQueryParserConfiguration
dateResolution
- the default date resolution to setpublic void setDateResolution(String fieldName, DateTools.Resolution dateResolution)
fieldName
- field for which the date resolution is to be setdateResolution
- date resolution to setpublic DateTools.Resolution getDateResolution(String fieldName)
public void setAnalyzeRangeTerms(boolean analyzeRangeTerms)
TermRangeQuery
s.
For example, setting this to true can enable analyzing terms into
collation keys for locale-sensitive TermRangeQuery
.analyzeRangeTerms
- whether or not terms should be analyzed for RangeQueryspublic boolean getAnalyzeRangeTerms()
TermRangeQuery
s.protected void addClause(List<BooleanClause> clauses, int conj, int mods, Query q)
protected Query getFieldQuery(String field, String queryText, boolean quoted) throws ParseException
ParseException
- throw in overridden method to disallowprotected Query newFieldQuery(Analyzer analyzer, String field, String queryText, boolean quoted) throws ParseException
ParseException
- throw in overridden method to disallowprotected Query getFieldQuery(String field, String queryText, int slop) throws ParseException
getFieldQuery(String,String,boolean)
.
This method may be overridden, for example, to return
a SpanNearQuery instead of a PhraseQuery.ParseException
- throw in overridden method to disallowprotected Query getRangeQuery(String field, String part1, String part2, boolean startInclusive, boolean endInclusive) throws ParseException
ParseException
protected BooleanClause newBooleanClause(Query q, BooleanClause.Occur occur)
q
- sub queryoccur
- how this clause should occur when matching documentsprotected Query newPrefixQuery(Term prefix)
prefix
- Prefix termprotected Query newRegexpQuery(Term regexp)
regexp
- Regexp termprotected Query newFuzzyQuery(Term term, float minimumSimilarity, int prefixLength)
term
- TermminimumSimilarity
- minimum similarityprefixLength
- prefix lengthprotected BytesRef analyzeMultitermTerm(String field, String part, Analyzer analyzerIn)
protected Query newRangeQuery(String field, String part1, String part2, boolean startInclusive, boolean endInclusive)
TermRangeQuery
instancefield
- Fieldpart1
- minpart2
- maxstartInclusive
- true if the start of the range is inclusiveendInclusive
- true if the end of the range is inclusiveTermRangeQuery
instanceprotected Query newMatchAllDocsQuery()
protected Query newWildcardQuery(Term t)
t
- wildcard termprotected Query getBooleanQuery(List<BooleanClause> clauses) throws ParseException
clauses
- List that contains BooleanClause
instances
to join.Query
object.ParseException
- throw in overridden method to disallowprotected Query getBooleanQuery(List<BooleanClause> clauses, boolean disableCoord) throws ParseException
clauses
- List 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(String field, 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 termQuery
built for the termParseException
- throw in overridden method to disallowprotected Query getRegexpQuery(String field, String termStr) throws ParseException
Depending on settings, pattern term may be lower-cased automatically. It will not go through the default Analyzer, however, since normal Analyzers are unlikely to work properly with regular expression templates.
Can be overridden by extending classes, to provide custom handling for regular expression queries, which may be necessary due to missing analyzer calls.
field
- Name of the field query will use.termStr
- Term token that contains a regular expressionQuery
built for the termParseException
- throw in overridden method to disallowprotected Query getPrefixQuery(String field, 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 termParseException
- throw in overridden method to disallowprotected Query getFuzzyQuery(String field, 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 queryQuery
built for the termParseException
- throw in overridden method to disallowCopyright © 2000-2014 Apache Software Foundation. All Rights Reserved.