All Known Implementing Classes:

AccessControlQuery, BooleanAndQuery, BooleanNotQuery, BooleanOrQuery, BoostQuery, CompositeJoinQuery, FacetQuery, FieldExpressionQuery, FilterQuery, GeoDistanceQuery, GraphQuery, JoinQuery, PhraseQuery, Query, QueryPlugin, QueryString, SavedFilter, ShapeQuery, SubQuery
```
public interface QueryParameters
```
Contains all standard Query parameters.
Query parameters can be applied to Query objects for annotation purposes. Query parameters applied to a Query may be informative, or may enable/disable functionality on the query object.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class QueryParameters.Parameter
Linked list of parameters.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ACL`	Paramter name for the acl field for an `AccessControlQuery`.
`static java.lang.String`	`ACRONYMS`	Parameter name for the acronym expansion mode (on, off, auto [default=`QueryRequest.getSynonymsMode()`])
`static java.lang.String`	`ACRONYMS_EXPANDED`	Parameter name indicating if acronyms expansion was applied (boolean)
`static java.lang.String`	`ACRONYMS_ORIGINAL`	Parameter name for original value prior to acronym expansion (String)
`static java.lang.String`	`ALIAS`	Parameter name that identifies a sub query tree with an alias (string).
`static java.lang.String`	`ALLOW`	Paramter name for the allow field for an `AccessControlQuery`.
`static java.lang.String`	`ANONYMOUS`	Parameter name for specifying the anonymous acl for an `AccessControlQuery`.
`static java.lang.String`	`BOOST`	Parameter name for boost parameter (int)
`static java.lang.String`	`BOOST_FREQUENCY`	Deprecated. this parameter is now ignored
`static java.lang.String`	`BOOST_POSITION`	Deprecated. this parameter is now ignored
`static java.lang.String`	`BOOST_PROXIMITY`	Deprecated. this parameter is now ignored
`static java.lang.String`	`COMPLETENESS_BOOST`	Parameter name for completeness boost parameter (int).
`static int`	`DEFAULT_BOOST`	Default value for `BOOST` parameter
`static int`	`DEFAULT_DEPTH`	Default value for `DEPTH`.
`static boolean`	`DEFAULT_FIELD_NORMS`	Default value for `FIELD_NORMS`.
`static int`	`DEFAULT_FUZZY_MAX_TERMS`	Default value for `FUZZY_MAX_TERMS`
`static int`	`DEFAULT_MINIMUM`	Default value for `MINIMUM`.
`static boolean`	`DEFAULT_QUOTED`	Default value for `QUOTED`.
`static boolean`	`DEFAULT_RECURSIVE`	Default value for `RECURSIVE`.
`static int`	`DEFAULT_ROLLUP_LIMIT`	Default value for `ROLLUP`.
`static int`	`DEFAULT_SCORE_DEPTH`	Default value for `SCORE_DEPTH`
`static boolean`	`DEFAULT_SCORE_EXPLAIN`	Default value for `SCORE_EXPLAIN`.
`static java.lang.String`	`DEFAULT_SEARCH_FIELD`	Parameter name for the default search field for query parsing.
`static int`	`DEFAULT_SIMILARITY`	Default value for `SIMILARITY`.
`static int`	`DEFAULT_SPAN`	Default value for `SPAN`.
`static java.lang.String`	`DENY`	Paramter name for the deny field for an `AccessControlQuery`.
`static java.lang.String`	`DEPTH`	Parameter name for specifying max depth for graph query.
`static java.lang.String`	`DISABLE_COORD`	Parameter name for disabling coordination of query (boolean)
`static java.lang.String`	`DISTANCE`	Parameter name for the distance between terms (int) (NOTE: only used at parse time, never set on an Query instance)
`static java.lang.String`	`FACET`	Parameter name for indication of when a Join Clause should have child documents included in facets.
`static java.lang.String`	`FIELD_NORMS`	Deprecated. this parameter is now ignored and may be repurposed in a future release
`static java.lang.String`	`FUZZY_MAX_TERMS`	Parameter name for maximum number of terms to expand a fuzzy query to.
`static java.lang.String`	`INDEX`	Parameter used to identify a numeric index.
`static java.lang.String`	`LANGUAGE`	Parameter name for language of query terms (String)
`static java.lang.String`	`LOWER`	Parameter name for specifying the type for the lower bounds of a range query.
`static java.lang.String`	`METHOD`	Parameter name for specifying the implementation method to use when evaluating an operator.
`static java.lang.String`	`MINIMUM`	Parameter name for the minimum number of required OR terms (int)
`static java.lang.String`	`ON`	Parameter name for the join field (NOTE: only used at parse time, never set on any Query instance)
`static java.lang.String`	`ORDER`	Parameter name for specifying a sort order for a query operator.
`static java.lang.String`	`QUERY`	Parameter name that contains the query string that this query object was parsed from (string)
`static java.lang.String`	`QUERY_LANGUAGE`	Parameter name for the query language
`static java.lang.String`	`QUOTED`	Parameter that indicates if the original query text was quoted.
`static java.lang.String`	`RECURSIVE`	Parameter indicating if access control query should be applied recursively.
`static java.lang.String`	`RELEVANCY_MODEL`	Parameter name for specifying the relevancy model to apply to an INNER or OUTER clause.
`static java.lang.String`	`ROLLUP`	Parameter name for indication of when a Join Clause should have documents rollup up.
`static java.lang.String`	`SCORE_DEPTH`	Parameter name for specifying the depth for scoring.
`static java.lang.String`	`SCORE_EXPLAIN`	Parameter name for specifying that score should be fully explained for a query.
`static java.lang.String`	`SCORE_FUNCTIONS`	Parameter name for specifying the score functions to apply to an INNER or OUTER clause.
`static java.lang.String`	`SCORE_MODE`	Parameter name for specifying the mode for scoring the query.
`static java.lang.String`	`SIMILARITY`	Parameter name for similarity parameter (int)
`static java.lang.String`	`SIMILARITY_PREFIX`	Parameter name for similarity prefix parameter (int)
`static java.lang.String`	`SOUNDS_LIKE`	Parameter name for specifying whether a term should be phonetically encoded.
`static java.lang.String`	`SPAN`	Parameter name for specifying the span for a scope context.
`static java.lang.String`	`SPELLCHECK_CORRECTED`	Parameter name indicating if spellcheck suggestion was applied (boolean)
`static java.lang.String`	`SPELLCHECK_EXPANDED`	Parameter name indicating if spellcheck expansion was applied (boolean)
`static java.lang.String`	`SPELLCHECK_MODE`	Parameter name for the spellcheck mode (com.attivio.sdk.search.QueryRequest.SpellCheckMode)
`static java.lang.String`	`SPELLCHECK_ORIGINAL`	Parameter name for original value prior to spellcheck suggestion being applied (String)
`static java.lang.String`	`SPELLCHECK_SUGGESTIONS`	Parameter name for spellcheck suggestions (String[])
`static java.lang.String`	`STOPWORDS`	Parameter name for the stopwords mode (on, off, auto [default=auto])
`static java.lang.String`	`SYNONYMS`	Parameter name for the synonym expansion mode (on, off, auto [default=`QueryRequest.getSynonymsMode()`])
`static java.lang.String`	`SYNONYMS_EXPANDED`	Parameter name indicating if synonyms expansion was applied (boolean)
`static java.lang.String`	`SYNONYMS_ORIGINAL`	Parameter name for original value prior to synonyms expansion (String)
`static java.lang.String`	`TOKENIZE`	Name of parameter indicating if term should be tokenized
`static java.lang.String`	`UNSECURED_ZONES`	Parameter indicating comma sep list of zones that are not secured.
`static java.lang.String`	`UPPER`	Parameter name for specifying the type for the upper bounds of a range query.
`static java.lang.String`	`WARNING`	Parameter name for warning message applied to query object (String)
`static java.lang.String`	`WILDCARD`	Parameter name for wildcard parameter (boolean)
`static java.lang.String`	`XON`	(EXPERIMENTAL) Paramter name for the join constraint (NOTE: only used at parse time, never set on any Query instance)

- Field Detail
  - ALIAS
```
static final java.lang.String ALIAS
```
    Parameter name that identifies a sub query tree with an alias (string).
    
    See Also:
    
    Constant Field Values
  - QUERY
```
static final java.lang.String QUERY
```
    Parameter name that contains the query string that this query object was parsed from (string)
    
    See Also:
    
    Constant Field Values
  - BOOST
```
static final java.lang.String BOOST
```
    Parameter name for boost parameter (int)
    
    See Also:
    
    Constant Field Values
  - COMPLETENESS_BOOST
```
static final java.lang.String COMPLETENESS_BOOST
```
    Parameter name for completeness boost parameter (int).
    
    See Also:
    
    Constant Field Values
  - RECURSIVE
```
static final java.lang.String RECURSIVE
```
    Parameter indicating if access control query should be applied recursively.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RECURSIVE
```
static final boolean DEFAULT_RECURSIVE
```
    Default value for RECURSIVE.
    
    See Also:
    
    Constant Field Values
  - UNSECURED_ZONES
```
static final java.lang.String UNSECURED_ZONES
```
    Parameter indicating comma sep list of zones that are not secured.
    
    See Also:
    
    Constant Field Values
  - ACL
```
static final java.lang.String ACL
```
    Paramter name for the acl field for an AccessControlQuery.
    
    See Also:
    
    Constant Field Values
  - ALLOW
```
static final java.lang.String ALLOW
```
    Paramter name for the allow field for an AccessControlQuery.
    
    See Also:
    
    Constant Field Values
  - DENY
```
static final java.lang.String DENY
```
    Paramter name for the deny field for an AccessControlQuery.
    
    See Also:
    
    Constant Field Values
  - ANONYMOUS
```
static final java.lang.String ANONYMOUS
```
    Parameter name for specifying the anonymous acl for an AccessControlQuery.
    
    See Also:
    
    Constant Field Values
  - INDEX
```
static final java.lang.String INDEX
```
    Parameter used to identify a numeric index.
    
    See Also:
    
    Constant Field Values
  - BOOST_PROXIMITY
```
@Deprecated
static final java.lang.String BOOST_PROXIMITY
```
    Deprecated.
    this parameter is now ignored
    
    Parameter name for proximity boosting parameter (int)
    
    See Also:
    
    Constant Field Values
  - BOOST_FREQUENCY
```
@Deprecated
static final java.lang.String BOOST_FREQUENCY
```
    Deprecated.
    this parameter is now ignored
    
    Parameter name for frequency boosting parameter (int)
    
    See Also:
    
    Constant Field Values
  - BOOST_POSITION
```
@Deprecated
static final java.lang.String BOOST_POSITION
```
    Deprecated.
    this parameter is now ignored
    
    Parameter name for position boosting parameter (int)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BOOST
```
static final int DEFAULT_BOOST
```
    Default value for BOOST parameter
    
    See Also:
    
    Constant Field Values
  - WILDCARD
```
static final java.lang.String WILDCARD
```
    Parameter name for wildcard parameter (boolean)
    
    See Also:
    
    Constant Field Values
  - FIELD_NORMS
```
@Deprecated
static final java.lang.String FIELD_NORMS
```
    Deprecated.
    this parameter is now ignored and may be repurposed in a future release
    
    Parameter name for enabling/disabling use of indexed norms for term and phrase queries
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FIELD_NORMS
```
static final boolean DEFAULT_FIELD_NORMS
```
    Default value for FIELD_NORMS.
    
    See Also:
    
    Constant Field Values
  - LANGUAGE
```
static final java.lang.String LANGUAGE
```
    Parameter name for language of query terms (String)
    
    See Also:
    
    Constant Field Values
  - SIMILARITY
```
static final java.lang.String SIMILARITY
```
    Parameter name for similarity parameter (int)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SIMILARITY
```
static final int DEFAULT_SIMILARITY
```
    Default value for SIMILARITY.
    
    See Also:
    
    Constant Field Values
  - DISABLE_COORD
```
static final java.lang.String DISABLE_COORD
```
    Parameter name for disabling coordination of query (boolean)
    
    See Also:
    
    Constant Field Values
  - SIMILARITY_PREFIX
```
static final java.lang.String SIMILARITY_PREFIX
```
    Parameter name for similarity prefix parameter (int)
    
    See Also:
    
    Constant Field Values
  - FUZZY_MAX_TERMS
```
static final java.lang.String FUZZY_MAX_TERMS
```
    Parameter name for maximum number of terms to expand a fuzzy query to.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FUZZY_MAX_TERMS
```
static final int DEFAULT_FUZZY_MAX_TERMS
```
    Default value for FUZZY_MAX_TERMS
    
    See Also:
    
    Constant Field Values
  - MINIMUM
```
static final java.lang.String MINIMUM
```
    Parameter name for the minimum number of required OR terms (int)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MINIMUM
```
static final int DEFAULT_MINIMUM
```
    Default value for MINIMUM.
    
    See Also:
    
    Constant Field Values
  - DISTANCE
```
static final java.lang.String DISTANCE
```
    Parameter name for the distance between terms (int) (NOTE: only used at parse time, never set on an Query instance)
    
    See Also:
    
    Constant Field Values
  - QUERY_LANGUAGE
```
static final java.lang.String QUERY_LANGUAGE
```
    Parameter name for the query language
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SEARCH_FIELD
```
static final java.lang.String DEFAULT_SEARCH_FIELD
```
    Parameter name for the default search field for query parsing.
    
    See Also:
    
    Constant Field Values
  - ON
```
static final java.lang.String ON
```
    Parameter name for the join field (NOTE: only used at parse time, never set on any Query instance)
    
    See Also:
    
    Constant Field Values
  - XON
```
static final java.lang.String XON
```
    (EXPERIMENTAL) Paramter name for the join constraint (NOTE: only used at parse time, never set on any Query instance)
    
    See Also:
    
    Constant Field Values
  - SYNONYMS
```
static final java.lang.String SYNONYMS
```
    Parameter name for the synonym expansion mode (on, off, auto [default=QueryRequest.getSynonymsMode()])
    
    See Also:
    
    Constant Field Values
  - SYNONYMS_ORIGINAL
```
static final java.lang.String SYNONYMS_ORIGINAL
```
    Parameter name for original value prior to synonyms expansion (String)
    
    See Also:
    
    Constant Field Values
  - SYNONYMS_EXPANDED
```
static final java.lang.String SYNONYMS_EXPANDED
```
    Parameter name indicating if synonyms expansion was applied (boolean)
    
    See Also:
    
    Constant Field Values
  - ACRONYMS
```
static final java.lang.String ACRONYMS
```
    Parameter name for the acronym expansion mode (on, off, auto [default=QueryRequest.getSynonymsMode()])
    
    See Also:
    
    Constant Field Values
  - ACRONYMS_ORIGINAL
```
static final java.lang.String ACRONYMS_ORIGINAL
```
    Parameter name for original value prior to acronym expansion (String)
    
    See Also:
    
    Constant Field Values
  - ACRONYMS_EXPANDED
```
static final java.lang.String ACRONYMS_EXPANDED
```
    Parameter name indicating if acronyms expansion was applied (boolean)
    
    See Also:
    
    Constant Field Values
  - STOPWORDS
```
static final java.lang.String STOPWORDS
```
    Parameter name for the stopwords mode (on, off, auto [default=auto])
    
    See Also:
    
    Constant Field Values
  - SPELLCHECK_MODE
```
static final java.lang.String SPELLCHECK_MODE
```
    Parameter name for the spellcheck mode (com.attivio.sdk.search.QueryRequest.SpellCheckMode)
    
    See Also:
    
    Constant Field Values
  - SPELLCHECK_SUGGESTIONS
```
static final java.lang.String SPELLCHECK_SUGGESTIONS
```
    Parameter name for spellcheck suggestions (String[])
    
    See Also:
    
    Constant Field Values
  - SPELLCHECK_CORRECTED
```
static final java.lang.String SPELLCHECK_CORRECTED
```
    Parameter name indicating if spellcheck suggestion was applied (boolean)
    
    See Also:
    
    Constant Field Values
  - SPELLCHECK_EXPANDED
```
static final java.lang.String SPELLCHECK_EXPANDED
```
    Parameter name indicating if spellcheck expansion was applied (boolean)
    
    See Also:
    
    Constant Field Values
  - SPELLCHECK_ORIGINAL
```
static final java.lang.String SPELLCHECK_ORIGINAL
```
    Parameter name for original value prior to spellcheck suggestion being applied (String)
    
    See Also:
    
    Constant Field Values
  - WARNING
```
static final java.lang.String WARNING
```
    Parameter name for warning message applied to query object (String)
    
    See Also:
    
    Constant Field Values
  - TOKENIZE
```
static final java.lang.String TOKENIZE
```
    Name of parameter indicating if term should be tokenized
    
    See Also:
    
    Constant Field Values
  - DEPTH
```
static final java.lang.String DEPTH
```
    Parameter name for specifying max depth for graph query. (0 = unlimited)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DEPTH
```
static final int DEFAULT_DEPTH
```
    Default value for DEPTH.
    
    See Also:
    
    Constant Field Values
  - ROLLUP
```
static final java.lang.String ROLLUP
```
    Parameter name for indication of when a Join Clause should have documents rollup up. (boolean)
    
    See Also:
    
    Constant Field Values
  - FACET
```
static final java.lang.String FACET
```
    Parameter name for indication of when a Join Clause should have child documents included in facets. (boolean)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ROLLUP_LIMIT
```
static final int DEFAULT_ROLLUP_LIMIT
```
    Default value for ROLLUP.
    
    See Also:
    
    Constant Field Values
  - LOWER
```
static final java.lang.String LOWER
```
    Parameter name for specifying the type for the lower bounds of a range query.
    
    See Also:
    
    Constant Field Values
  - UPPER
```
static final java.lang.String UPPER
```
    Parameter name for specifying the type for the upper bounds of a range query.
    
    See Also:
    
    Constant Field Values
  - SCORE_DEPTH
```
static final java.lang.String SCORE_DEPTH
```
    Parameter name for specifying the depth for scoring.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SCORE_DEPTH
```
static final int DEFAULT_SCORE_DEPTH
```
    Default value for SCORE_DEPTH
    
    See Also:
    
    Constant Field Values
  - SCORE_MODE
```
static final java.lang.String SCORE_MODE
```
    Parameter name for specifying the mode for scoring the query.
    
    See Also:
    
    Constant Field Values
  - SCORE_EXPLAIN
```
static final java.lang.String SCORE_EXPLAIN
```
    Parameter name for specifying that score should be fully explained for a query.
    NOTE: currently this is only supported on a JoinQuery. When set to false, the score explanation will only include the explanation for the search query. No clauses or additional join query notation will be included in the explanation for that JoinQuery.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SCORE_EXPLAIN
```
static final boolean DEFAULT_SCORE_EXPLAIN
```
    Default value for SCORE_EXPLAIN.
    
    See Also:
    
    Constant Field Values
  - METHOD
```
static final java.lang.String METHOD
```
    Parameter name for specifying the implementation method to use when evaluating an operator.
    
    See Also:
    
    Constant Field Values
  - SCORE_FUNCTIONS
```
static final java.lang.String SCORE_FUNCTIONS
```
    Parameter name for specifying the score functions to apply to an INNER or OUTER clause.
    
    See Also:
    
    Constant Field Values
  - RELEVANCY_MODEL
```
static final java.lang.String RELEVANCY_MODEL
```
    Parameter name for specifying the relevancy model to apply to an INNER or OUTER clause.
    
    See Also:
    
    Constant Field Values
  - SPAN
```
static final java.lang.String SPAN
```
    Parameter name for specifying the span for a scope context.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SPAN
```
static final int DEFAULT_SPAN
```
    Default value for SPAN.
    
    See Also:
    
    Constant Field Values
  - ORDER
```
static final java.lang.String ORDER
```
    Parameter name for specifying a sort order for a query operator.
    
    See Also:
    
    Constant Field Values
  - QUOTED
```
static final java.lang.String QUOTED
```
    Parameter that indicates if the original query text was quoted.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_QUOTED
```
static final boolean DEFAULT_QUOTED
```
    Default value for QUOTED.
    
    See Also:
    
    Constant Field Values
  - SOUNDS_LIKE
```
static final java.lang.String SOUNDS_LIKE
```
    Parameter name for specifying whether a term should be phonetically encoded.
    
    See Also:
    
    Constant Field Values

Interface QueryParameters

Nested Class Summary

Field Summary

Field Detail

ALIAS

QUERY

BOOST

COMPLETENESS_BOOST

RECURSIVE

DEFAULT_RECURSIVE

UNSECURED_ZONES

ACL

ALLOW

DENY

ANONYMOUS

INDEX

BOOST_PROXIMITY

BOOST_FREQUENCY

BOOST_POSITION

DEFAULT_BOOST

WILDCARD

FIELD_NORMS

DEFAULT_FIELD_NORMS

LANGUAGE

SIMILARITY

DEFAULT_SIMILARITY

DISABLE_COORD

SIMILARITY_PREFIX

FUZZY_MAX_TERMS

DEFAULT_FUZZY_MAX_TERMS

MINIMUM

DEFAULT_MINIMUM

DISTANCE

QUERY_LANGUAGE

DEFAULT_SEARCH_FIELD

ON

XON

SYNONYMS

SYNONYMS_ORIGINAL

SYNONYMS_EXPANDED

ACRONYMS

ACRONYMS_ORIGINAL

ACRONYMS_EXPANDED

STOPWORDS

SPELLCHECK_MODE

SPELLCHECK_SUGGESTIONS

SPELLCHECK_CORRECTED

SPELLCHECK_EXPANDED

SPELLCHECK_ORIGINAL

WARNING

TOKENIZE

DEPTH

DEFAULT_DEPTH

ROLLUP

FACET

DEFAULT_ROLLUP_LIMIT

LOWER

UPPER

SCORE_DEPTH

DEFAULT_SCORE_DEPTH

SCORE_MODE

SCORE_EXPLAIN

DEFAULT_SCORE_EXPLAIN

METHOD

SCORE_FUNCTIONS

RELEVANCY_MODEL

SPAN

DEFAULT_SPAN

ORDER

QUOTED

DEFAULT_QUOTED

SOUNDS_LIKE