QueryParameters (platform/sdk 5.5.1.0-SNAPSHOT API)

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.

Field Summary

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

Interface QueryParameters

Field Summary

Field Detail

ALIAS

QUERY

BOOST

COMPLETENESS_BOOST

RECURSIVE

DEFAULT_RECURSIVE

UNSECURED_ZONES

ACL

ALLOW

DENY

ANONYMOUS

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