Interface CommonQueryParserConfiguration
- All Known Implementing Classes:
ComplexPhraseQueryParser,ExtendableQueryParser,MultiFieldQueryParser,PrecedenceQueryParser,QueryParser,QueryParserBase,StandardQueryParser
public interface CommonQueryParserConfiguration
Configuration options common across queryparser implementations.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanfloatGet the minimal similarity for fuzzy queries.intGet the prefix length for fuzzy queries.Returns current locale, allowing access by subclasses.intGets the default slop for phrases.voidsetAllowLeadingWildcard(boolean allowLeadingWildcard) Set totrueto allow leading wildcard characters.voidsetDateResolution(DateTools.Resolution dateResolution) Sets the defaultDateTools.Resolutionused for certain field when noDateTools.Resolutionis defined for this field.voidsetEnablePositionIncrements(boolean enabled) Set totrueto enable position increments in result query.voidsetFuzzyMinSim(float fuzzyMinSim) Set the minimum similarity for fuzzy queries.voidsetFuzzyPrefixLength(int fuzzyPrefixLength) Set the prefix length for fuzzy queries.voidSet locale used by date range parsing.voidBy default QueryParser usesMultiTermQuery.CONSTANT_SCORE_BLENDED_REWRITEwhen creating aPrefixQuery,WildcardQueryorTermRangeQuery.voidsetPhraseSlop(int defaultPhraseSlop) Sets the default slop for phrases.voidsetTimeZone(TimeZone timeZone)
-
Method Details
-
setAllowLeadingWildcard
void setAllowLeadingWildcard(boolean allowLeadingWildcard) Set totrueto 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.
-
setEnablePositionIncrements
void setEnablePositionIncrements(boolean enabled) Set totrueto 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: false.
-
getEnablePositionIncrements
boolean getEnablePositionIncrements()- See Also:
-
setMultiTermRewriteMethod
By default QueryParser usesMultiTermQuery.CONSTANT_SCORE_BLENDED_REWRITEwhen creating aPrefixQuery,WildcardQueryorTermRangeQuery. This implementation is generally preferable because it a) Runs faster b) Does not have the scarcity of terms unduly influence score c) avoids anyIndexSearcher.TooManyClausesexception. However, if your application really needs to use the old-fashionedBooleanQueryexpansion rewriting and the above points are not relevant then use this to change the rewrite method. As another alternative, if you prefer all terms to be rewritten as a filter up-front, you can useMultiTermQuery.CONSTANT_SCORE_REWRITE. For more information on the different rewrite methods available, seeMultiTermQuerydocumentation. -
getMultiTermRewriteMethod
MultiTermQuery.RewriteMethod getMultiTermRewriteMethod()- See Also:
-
setFuzzyPrefixLength
void setFuzzyPrefixLength(int fuzzyPrefixLength) Set the prefix length for fuzzy queries. Default is 0.- Parameters:
fuzzyPrefixLength- The fuzzyPrefixLength to set.
-
setLocale
Set locale used by date range parsing. -
getLocale
Locale getLocale()Returns current locale, allowing access by subclasses. -
setTimeZone
-
getTimeZone
TimeZone getTimeZone() -
setPhraseSlop
void setPhraseSlop(int defaultPhraseSlop) Sets the default slop for phrases. If zero, then exact phrase matches are required. Default value is zero. -
getAnalyzer
Analyzer getAnalyzer() -
getAllowLeadingWildcard
boolean getAllowLeadingWildcard()- See Also:
-
getFuzzyMinSim
float getFuzzyMinSim()Get the minimal similarity for fuzzy queries. -
getFuzzyPrefixLength
int getFuzzyPrefixLength()Get the prefix length for fuzzy queries.- Returns:
- Returns the fuzzyPrefixLength.
-
getPhraseSlop
int getPhraseSlop()Gets the default slop for phrases. -
setFuzzyMinSim
void setFuzzyMinSim(float fuzzyMinSim) Set the minimum similarity for fuzzy queries. Default is defined onFuzzyQuery.defaultMaxEdits. -
setDateResolution
Sets the defaultDateTools.Resolutionused for certain field when noDateTools.Resolutionis defined for this field.- Parameters:
dateResolution- the defaultDateTools.Resolution
-