Package de.cxp.ocs.config

Enum Class QueryBuildingSetting

java.lang.Object

java.lang.Enum<QueryBuildingSetting>

de.cxp.ocs.config.QueryBuildingSetting

All Implemented Interfaces:

Serializable, Comparable<QueryBuildingSetting>, Constable

public enum QueryBuildingSetting
extends Enum<QueryBuildingSetting>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
acceptNoResult	If set to true, no other query will be used after this one, even if it returned 0 results.
allowParallelSpellcheck	Setting that can be set to "true" or "false".
analyzer	Analyzer to be used to analyze the input query.
fallbackQuery	Used for preFetchQuery to specify, which es-query-builder should be used to search for "unknown" terms.
fuzziness	see https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness
isQueryWithShingles	boolean setting to enable the creation and searching for combined terms (shingles)
isTermFiltersQuoted	Setting for a boolean value to enable quoting for term-filters introduced by a query-parser.
minShouldMatch	see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html
multimatch_type	one of CROSS_FIELDS (default), BEST_FIELDS, MOST_FIELDS, PHRASE, PHRASE_PREFIX see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#multi-match-types
operator	one of OR, AND
phraseSlop	Slop value that should be used for the quoted part of the query.
quoteAnalyzer	Analyzer to be used to analyze the input query that is put into quotes as alternative match.
tieBreaker	float value between 0 (inclusive) and 1 (inclusive)

Method Summary

Modifier and Type	Method	Description
static QueryBuildingSetting	valueOf(String name)	Returns the enum constant of this class with the specified name.
static QueryBuildingSetting[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

analyzer

public static final QueryBuildingSetting analyzer

Analyzer to be used to analyze the input query.

quoteAnalyzer

public static final QueryBuildingSetting quoteAnalyzer

Analyzer to be used to analyze the input query that is put into quotes as alternative match.

isTermFiltersQuoted

public static final QueryBuildingSetting isTermFiltersQuoted

Setting for a boolean value to enable quoting for term-filters introduced by a query-parser. This only makes sense if a different quoteAnalyzer is used. default: false

phraseSlop

public static final QueryBuildingSetting phraseSlop

Slop value that should be used for the quoted part of the query. see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html

minShouldMatch

public static final QueryBuildingSetting minShouldMatch

see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html

operator

public static final QueryBuildingSetting operator

one of OR, AND

tieBreaker

public static final QueryBuildingSetting tieBreaker

float value between 0 (inclusive) and 1 (inclusive)

multimatch_type

public static final QueryBuildingSetting multimatch_type

one of CROSS_FIELDS (default), BEST_FIELDS, MOST_FIELDS, PHRASE, PHRASE_PREFIX see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#multi-match-types

fuzziness

public static final QueryBuildingSetting fuzziness

see https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness

fallbackQuery

public static final QueryBuildingSetting fallbackQuery

Used for preFetchQuery to specify, which es-query-builder should be used to search for "unknown" terms. Set it to an existing name of another query-builder. Leave it undefined to ignore such terms (= 0-matches in case all queries are unknown).

allowParallelSpellcheck

public static final QueryBuildingSetting allowParallelSpellcheck

Setting that can be set to "true" or "false". If true, a spellcheck can be executed with the built query. If spell corrections could be fetched for the given user query and no results where found by the query itself, the query will be executed again with the spell corrections.

isQueryWithShingles

public static final QueryBuildingSetting isQueryWithShingles

boolean setting to enable the creation and searching for combined terms (shingles)

acceptNoResult

public static final QueryBuildingSetting acceptNoResult

If set to true, no other query will be used after this one, even if it returned 0 results.

Method Details

values

public static QueryBuildingSetting[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static QueryBuildingSetting valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null