NamedWriteable
, Writeable
, ToXContent
, ToXContentObject
, QueryBuilder
, Rewriteable<QueryBuilder>
public class MatchQueryBuilder extends AbstractQueryBuilder<MatchQueryBuilder>
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Writeable.Reader<V>, Writeable.Writer<V>
Modifier and Type | Field | Description |
---|---|---|
static ParseField |
ANALYZER_FIELD |
|
static ParseField |
CUTOFF_FREQUENCY_FIELD |
|
static Operator |
DEFAULT_OPERATOR |
The default mode terms are combined in a match query
|
static ParseField |
FUZZY_REWRITE_FIELD |
|
static ParseField |
FUZZY_TRANSPOSITIONS_FIELD |
|
static ParseField |
GENERATE_SYNONYMS_PHRASE_QUERY |
|
static ParseField |
LENIENT_FIELD |
|
static ParseField |
MAX_EXPANSIONS_FIELD |
|
static ParseField |
MINIMUM_SHOULD_MATCH_FIELD |
|
static java.lang.String |
NAME |
The name for the match query
|
static ParseField |
OPERATOR_FIELD |
|
static ParseField |
PREFIX_LENGTH_FIELD |
|
static ParseField |
QUERY_FIELD |
|
static ParseField |
ZERO_TERMS_QUERY_FIELD |
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
MAX_REWRITE_ROUNDS
EMPTY_PARAMS
Constructor | Description |
---|---|
MatchQueryBuilder(java.lang.String fieldName,
java.lang.Object value) |
Constructs a new match query.
|
MatchQueryBuilder(StreamInput in) |
Read from a stream.
|
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
analyzer() |
Get the analyzer to use, if previously set, otherwise null
|
MatchQueryBuilder |
analyzer(java.lang.String analyzer) |
Explicitly set the analyzer to use.
|
boolean |
autoGenerateSynonymsPhraseQuery() |
Whether phrase queries should be automatically generated for multi terms synonyms.
|
MatchQueryBuilder |
autoGenerateSynonymsPhraseQuery(boolean enable) |
|
java.lang.Float |
cutoffFrequency() |
Gets the optional cutoff value, can be null if not set previously
|
MatchQueryBuilder |
cutoffFrequency(float cutoff) |
Set a cutoff value in [0..1] (or absolute number >=1) representing the
maximum threshold of a terms document frequency to be considered a low
frequency term.
|
protected boolean |
doEquals(MatchQueryBuilder other) |
Indicates whether some other
QueryBuilder object of the same type is "equal to" this one. |
protected int |
doHashCode() |
|
protected org.apache.lucene.search.Query |
doToQuery(QueryShardContext context) |
|
protected void |
doWriteTo(StreamOutput out) |
|
void |
doXContent(XContentBuilder builder,
ToXContent.Params params) |
|
java.lang.String |
fieldName() |
Returns the field name used in this query.
|
static MatchQueryBuilder |
fromXContent(XContentParser parser) |
|
Fuzziness |
fuzziness() |
Gets the fuzziness used when evaluated to a fuzzy query type.
|
MatchQueryBuilder |
fuzziness(java.lang.Object fuzziness) |
Sets the fuzziness used when evaluated to a fuzzy query type.
|
java.lang.String |
fuzzyRewrite() |
Get the fuzzy_rewrite parameter
|
MatchQueryBuilder |
fuzzyRewrite(java.lang.String fuzzyRewrite) |
Sets the fuzzy_rewrite parameter controlling how the fuzzy query will get rewritten
|
boolean |
fuzzyTranspositions() |
Gets the fuzzy query transposition setting.
|
MatchQueryBuilder |
fuzzyTranspositions(boolean fuzzyTranspositions) |
Sets whether transpositions are supported in fuzzy queries.
|
java.lang.String |
getWriteableName() |
Returns the name of the writeable object
|
boolean |
lenient() |
Gets leniency setting that controls if format based failures will be ignored.
|
MatchQueryBuilder |
lenient(boolean lenient) |
Sets whether format based failures will be ignored.
|
int |
maxExpansions() |
Get the (optional) number of term expansions when using fuzzy or prefix type query.
|
MatchQueryBuilder |
maxExpansions(int maxExpansions) |
When using fuzzy or prefix type query, the number of term expansions to use.
|
java.lang.String |
minimumShouldMatch() |
Gets the minimumShouldMatch value
|
MatchQueryBuilder |
minimumShouldMatch(java.lang.String minimumShouldMatch) |
Sets optional minimumShouldMatch value to apply to the query
|
Operator |
operator() |
Returns the operator to use in a boolean query.
|
MatchQueryBuilder |
operator(Operator operator) |
Sets the operator to use when using a boolean query.
|
int |
prefixLength() |
Gets the length of a length of common (non-fuzzy) prefix for fuzzy match queries
|
MatchQueryBuilder |
prefixLength(int prefixLength) |
Sets the length of a length of common (non-fuzzy) prefix for fuzzy match queries
|
MatchQueryBuilder |
setLenient(boolean lenient) |
Deprecated.
use #lenient() instead
|
java.lang.Object |
value() |
Returns the value used in this query.
|
MatchQuery.ZeroTermsQuery |
zeroTermsQuery() |
Returns the setting for handling zero terms queries.
|
MatchQueryBuilder |
zeroTermsQuery(MatchQuery.ZeroTermsQuery zeroTermsQuery) |
Sets query to use in case no query terms are available, e.g.
|
addValidationError, boost, boost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQuery, toString, toXContent, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isFragment
public static final ParseField ZERO_TERMS_QUERY_FIELD
public static final ParseField CUTOFF_FREQUENCY_FIELD
public static final ParseField LENIENT_FIELD
public static final ParseField FUZZY_TRANSPOSITIONS_FIELD
public static final ParseField FUZZY_REWRITE_FIELD
public static final ParseField MINIMUM_SHOULD_MATCH_FIELD
public static final ParseField OPERATOR_FIELD
public static final ParseField MAX_EXPANSIONS_FIELD
public static final ParseField PREFIX_LENGTH_FIELD
public static final ParseField ANALYZER_FIELD
public static final ParseField QUERY_FIELD
public static final ParseField GENERATE_SYNONYMS_PHRASE_QUERY
public static final java.lang.String NAME
public static final Operator DEFAULT_OPERATOR
public MatchQueryBuilder(java.lang.String fieldName, java.lang.Object value)
public MatchQueryBuilder(StreamInput in) throws java.io.IOException
java.io.IOException
protected void doWriteTo(StreamOutput out) throws java.io.IOException
doWriteTo
in class AbstractQueryBuilder<MatchQueryBuilder>
java.io.IOException
public java.lang.String fieldName()
public java.lang.Object value()
public MatchQueryBuilder operator(Operator operator)
public Operator operator()
public MatchQueryBuilder analyzer(java.lang.String analyzer)
public java.lang.String analyzer()
public MatchQueryBuilder fuzziness(java.lang.Object fuzziness)
public Fuzziness fuzziness()
public MatchQueryBuilder prefixLength(int prefixLength)
prefixLength
- non-negative length of prefixjava.lang.IllegalArgumentException
- in case the prefix is negativepublic int prefixLength()
public MatchQueryBuilder maxExpansions(int maxExpansions)
public int maxExpansions()
public MatchQueryBuilder cutoffFrequency(float cutoff)
public java.lang.Float cutoffFrequency()
public MatchQueryBuilder minimumShouldMatch(java.lang.String minimumShouldMatch)
public java.lang.String minimumShouldMatch()
public MatchQueryBuilder fuzzyRewrite(java.lang.String fuzzyRewrite)
public java.lang.String fuzzyRewrite()
fuzzyRewrite(String)
public MatchQueryBuilder fuzzyTranspositions(boolean fuzzyTranspositions)
The default metric used by fuzzy queries to determine a match is the Damerau-Levenshtein
distance formula which supports transpositions. Setting transposition to false will
switch to classic Levenshtein distance.
If not set, Damerau-Levenshtein distance metric will be used.
public boolean fuzzyTranspositions()
@Deprecated public MatchQueryBuilder setLenient(boolean lenient)
public MatchQueryBuilder lenient(boolean lenient)
public boolean lenient()
public MatchQueryBuilder zeroTermsQuery(MatchQuery.ZeroTermsQuery zeroTermsQuery)
MatchQuery.ZeroTermsQuery.NONE
, but can be set to
MatchQuery.ZeroTermsQuery.ALL
instead.public MatchQuery.ZeroTermsQuery zeroTermsQuery()
public MatchQueryBuilder autoGenerateSynonymsPhraseQuery(boolean enable)
public boolean autoGenerateSynonymsPhraseQuery()
public void doXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
doXContent
in class AbstractQueryBuilder<MatchQueryBuilder>
java.io.IOException
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException
doToQuery
in class AbstractQueryBuilder<MatchQueryBuilder>
java.io.IOException
protected boolean doEquals(MatchQueryBuilder other)
AbstractQueryBuilder
QueryBuilder
object of the same type is "equal to" this one.doEquals
in class AbstractQueryBuilder<MatchQueryBuilder>
protected int doHashCode()
doHashCode
in class AbstractQueryBuilder<MatchQueryBuilder>
public java.lang.String getWriteableName()
NamedWriteable
public static MatchQueryBuilder fromXContent(XContentParser parser) throws java.io.IOException
java.io.IOException