|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.solr.parser.SolrQueryParserBase
public abstract class SolrQueryParserBase
This class is overridden by QueryParser in QueryParser.jj and acts to separate the majority of the Java code from the .jj grammar file.
Nested Class Summary | |
---|---|
static class |
SolrQueryParserBase.MagicFieldName
Identifies the list of all known "magic fields" that trigger special parsing behavior |
Field Summary | |
---|---|
protected Analyzer |
analyzer
|
static QueryParser.Operator |
AND_OPERATOR
Alternative form of QueryParser.Operator.AND |
protected String |
explicitField
|
static QueryParser.Operator |
OR_OPERATOR
Alternative form of QueryParser.Operator.OR |
protected QParser |
parser
|
protected IndexSchema |
schema
|
Constructor Summary | |
---|---|
protected |
SolrQueryParserBase()
|
Method Summary | |
---|---|
protected void |
addClause(List<BooleanClause> clauses,
int conj,
int mods,
Query q)
|
protected String |
analyzeIfMultitermTermText(String field,
String part,
FieldType fieldType)
|
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 |
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. |
String |
getDefaultField()
|
QueryParser.Operator |
getDefaultOperator()
Gets implicit operator setting, which will be either AND_OPERATOR or OR_OPERATOR. |
boolean |
getEnablePositionIncrements()
|
String |
getExplicitField()
For a fielded query, returns the actual field specified (i.e. |
String |
getField(String fieldName)
Handles the default field if null is passed |
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)
|
protected Query |
getLocalParams(String qfield,
String lparams)
|
MultiTermQuery.RewriteMethod |
getMultiTermRewriteMethod()
|
int |
getPhraseSlop()
Gets the default slop for phrases. |
protected Query |
getPrefixQuery(String field,
String termStr)
|
protected Query |
getRangeQuery(String field,
String part1,
String part2,
boolean startInclusive,
boolean endInclusive)
|
protected Query |
getRegexpQuery(String field,
String termStr)
|
protected ReversedWildcardFilterFactory |
getReversedWildcardFilterFactory(FieldType fieldType)
|
protected Query |
getWildcardQuery(String field,
String termStr)
|
void |
init(Version matchVersion,
String defaultField,
QParser parser)
|
protected BooleanClause |
newBooleanClause(Query q,
BooleanClause.Occur occur)
Builds a new BooleanClause instance |
protected BooleanQuery |
newBooleanQuery(boolean disableCoord)
Builds a new BooleanQuery 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 MultiPhraseQuery |
newMultiPhraseQuery()
Builds a new MultiPhraseQuery instance |
protected PhraseQuery |
newPhraseQuery()
Builds a new PhraseQuery instance |
protected Query |
newPrefixQuery(Term prefix)
Builds a new PrefixQuery instance |
protected Query |
newRegexpQuery(Term regexp)
Builds a new RegexpQuery instance |
protected Query |
newTermQuery(Term term)
Builds a new TermQuery 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 |
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 |
setDefaultOperator(QueryParser.Operator op)
Sets the boolean operator of the QueryParser. |
void |
setEnablePositionIncrements(boolean enable)
Set to true to enable position increments in result query. |
void |
setFuzzyMinSim(float fuzzyMinSim)
Set the minimum similarity for fuzzy queries. |
void |
setFuzzyPrefixLength(int fuzzyPrefixLength)
Set the prefix length for fuzzy queries. |
void |
setMultiTermRewriteMethod(MultiTermQuery.RewriteMethod method)
By default QueryParser uses MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT
when creating a PrefixQuery, WildcardQuery or RangeQuery. |
void |
setPhraseSlop(int phraseSlop)
Sets the default slop for phrases. |
abstract Query |
TopLevelQuery(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 QueryParser.Operator AND_OPERATOR
public static final QueryParser.Operator OR_OPERATOR
protected IndexSchema schema
protected QParser parser
protected Analyzer analyzer
protected String explicitField
Constructor Detail |
---|
protected SolrQueryParserBase()
Method Detail |
---|
public abstract void ReInit(CharStream stream)
public abstract Query TopLevelQuery(String field) throws ParseException, SyntaxError
ParseException
SyntaxError
public void init(Version matchVersion, String defaultField, QParser parser)
public Query parse(String query) throws SyntaxError
Query
.
query
- the query string to be parsed.
SyntaxError
public String getDefaultField()
public String getField(String fieldName)
public String getExplicitField()
public final boolean getAutoGeneratePhraseQueries()
setAutoGeneratePhraseQueries(boolean)
public final void setAutoGeneratePhraseQueries(boolean value)
Set to false if phrase queries should only be generated when surrounded by double quotes.
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 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.
public boolean getAllowLeadingWildcard()
setAllowLeadingWildcard(boolean)
public void setEnablePositionIncrements(boolean enable)
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: true.
public boolean getEnablePositionIncrements()
setEnablePositionIncrements(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 setMultiTermRewriteMethod(MultiTermQuery.RewriteMethod method)
MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT
when creating a PrefixQuery, WildcardQuery or RangeQuery. This implementation is generally preferable because it
a) Runs faster b) Does not have the scarcity of terms unduly influence score
c) avoids any "TooManyBooleanClauses" 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.
public MultiTermQuery.RewriteMethod getMultiTermRewriteMethod()
setMultiTermRewriteMethod(org.apache.lucene.search.MultiTermQuery.RewriteMethod)
protected void addClause(List<BooleanClause> clauses, int conj, int mods, Query q)
protected Query newFieldQuery(Analyzer analyzer, String field, String queryText, boolean quoted) throws SyntaxError
SyntaxError
protected Query getFieldQuery(String field, String queryText, int slop) throws SyntaxError
getFieldQuery(String,String,boolean)
.
This method may be overridden, for example, to return
a SpanNearQuery instead of a PhraseQuery.
SyntaxError
protected BooleanQuery newBooleanQuery(boolean disableCoord)
disableCoord
- disable coord
protected BooleanClause newBooleanClause(Query q, BooleanClause.Occur occur)
q
- sub queryoccur
- how this clause should occur when matching documents
protected Query newTermQuery(Term term)
term
- term
protected PhraseQuery newPhraseQuery()
protected MultiPhraseQuery newMultiPhraseQuery()
protected Query newPrefixQuery(Term prefix)
prefix
- Prefix term
protected Query newRegexpQuery(Term regexp)
regexp
- Regexp term
protected Query newFuzzyQuery(Term term, float minimumSimilarity, int prefixLength)
term
- TermminimumSimilarity
- minimum similarityprefixLength
- prefix length
protected Query newMatchAllDocsQuery()
protected Query newWildcardQuery(Term t)
t
- wildcard term
protected Query getBooleanQuery(List<BooleanClause> clauses) throws SyntaxError
clauses
- List that contains BooleanClause
instances
to join.
Query
object.
SyntaxError
protected Query getBooleanQuery(List<BooleanClause> clauses, boolean disableCoord) throws SyntaxError
clauses
- List that contains BooleanClause
instances
to join.disableCoord
- true if coord scoring should be disabled.
Query
object.
SyntaxError
public static String escape(String s)
\
.
protected ReversedWildcardFilterFactory getReversedWildcardFilterFactory(FieldType fieldType)
protected String analyzeIfMultitermTermText(String field, String part, FieldType fieldType)
protected Query getFieldQuery(String field, String queryText, boolean quoted) throws SyntaxError
SyntaxError
protected Query getRangeQuery(String field, String part1, String part2, boolean startInclusive, boolean endInclusive) throws SyntaxError
SyntaxError
protected Query getPrefixQuery(String field, String termStr) throws SyntaxError
SyntaxError
protected Query getWildcardQuery(String field, String termStr) throws SyntaxError
SyntaxError
protected Query getRegexpQuery(String field, String termStr) throws SyntaxError
SyntaxError
protected Query getFuzzyQuery(String field, String termStr, float minSimilarity) throws SyntaxError
SyntaxError
protected Query getLocalParams(String qfield, String lparams) throws SyntaxError
SyntaxError
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |