QueryRequest (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.esb.AbstractPlatformMessage
- - com.attivio.sdk.search.QueryRequest

All Implemented Interfaces:

PlatformMessage, LocaleAware, Serializable, Cloneable
```
public class QueryRequest
extends AbstractPlatformMessage
implements LocaleAware, Cloneable, Serializable
```
Represents a search query and all associated meta data about the query such as sorting, faceting, linguistic options, etc.
When a QueryRequest is sent to AIE, a QueryResponse will be returned as the result. Use a SearchClient for sending QueryRequests to an AIE instance.
Paging

The setOffset(long) and setRows(long) methods can be used in order to page through results. Offset indicates the index into the overall result set for the first returned row. Rows indicates the number of rows that will be returned.
```
 QueryRequest request;

 // Request the first "page" of 10 results
 request = new QueryRequest("*:*");
 request.setOffset(0);
 request.setRows(10);
 // ... (Submit the search and handle response)

 // Request the second "page" of 10 results
 request = new QueryRequest("*:*");
 request.setOffset(10);
 request.setRows(10);
 // ... (Submit the search and handle response)
 
```
Query Resubmission

The setMaxResubmits(int) method can be used to control automatic query resubmission. A QueryRequest may be automatically resubmitted to the search engine in case of recoverable error, 0 result response, or other reasons. The configuration for AIE's query workflows will indicate what resubmission may occur. NOTE: resubmission is disabled by default.
```
 // Allow 1 resubmission
 QueryRequest request = new QueryRequest("*:*");
 request.setMaxResubmits(1);
 // ... (submit the search and handle response)
 
```
Field Expressions

The addField(String) and addField(FieldExpression) methods can be used to request specified fields to returned for the matching documents. By default, all stored fields will be returned. NOTE: if you add a field expression and still want all fields returned in addition to the FieldExpression, you should add the "*" field as well (see below example). FieldExpressions allow returning custom fields derived from stored fields (or generated based on query executed).
```
 QueryRequest request;

 // Request just the "text" field
 request = new QueryRequest("*:*");
 request.addField("text");
 // ... (submit the search and handle response)

 // Request the "Geo Distance" Field expression (include all stored fields as well)
 request = new QueryRequest("*:*");
 request.addField("*"); // Request all stored fields
 request.addField(new GeoDistance("position", centerLatitude, centerLongitude));
 // ... (submit the search and handle response)
 
```
Boost Queries

The addBoostQuery(Query) method allows adding a query to use for boosting purposes. The documents that match this query will get an additional boost however this boost query will not affect the documents that match this QueryRequest.
```
 // Match all documents, boosting documents with "foo" in the title higher
 QueryRequest request = new QueryRequest("*:*");
 request.addBoostQuery(new QueryString("title:foo"));
 // ... (submit the search and handle response)
 
```
Score Functions

The addScoreFunction(FieldExpression) method allows adding function based boosts to documents matching the QueryRequest.
```
 // Give a static boost to documents based on the indexed value for the "staticboost" field
 QueryRequest request = new QueryRequest("*:*");
 request.addScoreFunction("staticboost");
 // ... (submit the search and handle response)
 
```
Sorting

The addSort(Sort) method allows specifying the sort criteria for the QueryRequest. If no sort criteria is added, then the QueryRequest will be sorted by score descending. Multiple levels of sorting can be added to perform tie-breaking in the event that multiple documents have the same value for a sort.
```
 // Sort by "size" ascending
 QueryRequest request = new QueryRequest("*:*");
 request.addSort(new Sort("size", Sort.SortOrder.DESCENDING));
 // ... (submit the search and handle response)
 
```
Faceting

The addFacet(FacetRequest[]) and addFacetField(String[]) methods allow requesting facets to be returned along with the results. There are different types of facets that can be requested for a query. The simplest will return counts for all discrete values for a facet field (FacetRequest). RangeFacetRequest can be used to return buckets for specified ranges of values. FilterBasedFacetRequest can be used to get a bucket count for any arbitrary Query over the result set.
```
 QueryRequest request = new QueryRequest("*:*");
 // request a facet for the author field
 request.addFacetField("author");
 // request a "range" facet with 10 buckets for values between 0 and 1000
 request.addFacet(new RangeFacetRequest("size", 0, 1000, 10));
 // ... (submit the search and handle response)
 
```
Filtering

The addFilter(Query) method allows adding filters to the QueryRequest to restrict the matching documents to those that also match the filter. NOTE: applied filters do not modify the score of the document.
```
 // Filter result set to the "documents" table
 QueryRequest request = new QueryRequest("*:*");
 request.addFilter(new PhraseQuery("table", "documents"));
 // ... (submit the search and handle response)
 
```
WARNING: QueryRequests should not be reused. Reusing a QueryRequest for multiple searches can have adverse effects especially if run inside a single JVM.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryRequest.AcronymsMode` Modes for Acronym Expansion.
`static class`	`QueryRequest.FacetFinderMode` Modes for FacetFinder.
`static class`	`QueryRequest.SpellCheckMode` Modes for spell checking.
`static class`	`QueryRequest.StopwordsMode` Modes for Stopword removal
`static class`	`QueryRequest.SynonymsMode` Modes for Synonym Expansion.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_ACRONYM_BOOST` Default value for `getAcronymBoost()`.
`static QueryRequest.AcronymsMode`	`DEFAULT_ACRONYM_MODE` Default value for `getAcronymsMode()`.
`static boolean`	`DEFAULT_CACHEABLE` Default value for `isCacheable()`.
`static boolean`	`DEFAULT_DEBUG` Default value for `isDebug()`.
`static int`	`DEFAULT_FACET_FINDER_COUNT` Default value for `getFacetFinderCount()`.
`static QueryRequest.FacetFinderMode`	`DEFAULT_FACET_FINDER_MODE` Default value for `getFacetFinderMode()`.
`static int`	`DEFAULT_FACET_SAMPLE_SIZE` Default value for `getFacetSampleSize()`.
`static boolean`	`DEFAULT_HIGHLIGHT` Default value for `isHighlight()`.
`static HighlightMode`	`DEFAULT_HIGHLIGHT_MODE` Default value for `getHighlightMode()`.
`static String`	`DEFAULT_HIGHLIGHT_SCOPE` Default value for `getHighlightScope()`.
`static boolean`	`DEFAULT_INCLUDE_METADATA_IN_RESPONSE` Default value for `isDebug()`.
`static JoinFacetMode`	`DEFAULT_JOIN_FACET_MODE` Default value for `getJoinFacetMode()`.
`static JoinRollupMode`	`DEFAULT_JOIN_ROLLUP_MODE` Default value for `getJoinRollupMode()`.
`static Locale`	`DEFAULT_LOCALE` Default value for `getLocale()`.
`static int`	`DEFAULT_MAX_RESUBMITS` Default value for `getMaxResubmits()`.
`static long`	`DEFAULT_OFFSET` Default value for `getOffset()`.
`static boolean`	`DEFAULT_PARTIAL_RESULTS` Default value for `isPartialResults()`
`static int`	`DEFAULT_RESUBMITS` Initial value for `getResubmits()`.
`static long`	`DEFAULT_ROWS` Default value for `getRows()`.
`static int`	`DEFAULT_SEARCH_DEPTH` Default value for `getSearchDepth()`.
`static long`	`DEFAULT_SEED` Default value for `getSeed()`.
`static int`	`DEFAULT_SPELLCHECK_EXPAND_SIZE` Default value for `getSpellCheckExpandSize()`.
`static QueryRequest.SpellCheckMode`	`DEFAULT_SPELLCHECK_MODE` Default value for `getSpellCheckMode()`.
`static QueryRequest.StopwordsMode`	`DEFAULT_STOPWORDS_MODE` Default value for `getStopwordsMode()`.
`static int`	`DEFAULT_SYNONYM_BOOST` Default value for `getSynonymBoost()`.
`static QueryRequest.SynonymsMode`	`DEFAULT_SYNONYM_MODE` Default value for `getSynonymsMode()`.
`static String`	`SPELLCHECK_MODE_DEFAULT` Default spellcheck mode.

Fields inherited from interface com.attivio.sdk.esb.PlatformMessage
DEFAULT_MAX_LOG_LENGTH, MESSAGE_DROPPED, MESSAGE_SEND_TIME_PROP, PROP_MAX_LOG_LENGTH

Constructor Summary

Constructors
Constructor and Description
`QueryRequest()` The default constructor.
`QueryRequest(Query query)` Constructor with a `Query`.
`QueryRequest(String query)` Constructor with a string query.
`QueryRequest(String query, String language)` Constructor with a query string and query language.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addBoostQuery(Query boost)` Add a boost query.
`void`	`addFacet(FacetRequest... f)` Adds all `FacetRequest`s to this QueryRequest.
`void`	`addFacetField(String... fieldNames)` Adds a `FacetRequest` for all specified fields.
`void`	`addFacetFilter(FacetFilter bucket)` Adds a filter to this QueryRequest that will "drill down" on `bucket`.
`void`	`addField(FieldExpression field)` Add a FieldExpression to return for this QueryRequest.
`void`	`addField(String field)` Add a field to return in the response documents.
`void`	`addFilter(Query f)` Add a filter `Query` to this QueryRequest.
`void`	`addFilter(String exp)` Add a filter query to this QueryRequest.
`void`	`addFilter(String exp, String langSpec)` Add a filter query to this QueryRequest.
`void`	`addScoreFunction(FieldExpression... value)` Add a scoring function to this QueryRequest.
`void`	`addScoreFunction(FieldExpression value)` Add a scoring function to this QueryRequest.
`void`	`addScoreFunction(String... value)` Add a scoring function to this QueryRequest.
`void`	`addScoreFunction(String value)` Add a scoring function to this QueryRequest.
`void`	`addSort(FieldExpression field, Sort.SortOrder order)`
`void`	`addSort(Sort value)` Add a `Sort` specifier to this QueryRequest.
`void`	`addSort(String field, Sort.SortOrder order)`
`QueryRequest`	`clone()` Clones the object and resets message ID to -1.
`static QueryRequest`	`create(CgiRequest cgi)` Converts CGI HTTP POST/GET request to a `QueryRequest`.
`boolean`	`equals(Object other)`
`int`	`getAcronymBoost()` Get the boost to apply to expanded acronyms.
`String`	`getAcronymDictionaryName()` Get the name of the dictionary to use for acronym expansion.
`QueryRequest.AcronymsMode`	`getAcronymsMode()` Get the mode for expanding acronyms.
`List<Query>`	`getBoostQueries()` Get all boost queries applied to this QueryRequest.
`Date`	`getCenterTime()`
`List<FacetFilter>`	`getFacetFilters()` Get the `FacetFilter`s that will be used to filter the result set.
`int`	`getFacetFinderCount()` Get the maximum number of facets FacetFinder will add to this QueryRequest.
`QueryRequest.FacetFinderMode`	`getFacetFinderMode()` Get the mode for FacetFinder.
`List<FacetRequest>`	`getFacets()` Get the facets requested for this QueryRequest.
`int`	`getFacetSampleSize()` Get the sample size for sample based facets.
`FieldCollapse`	`getFieldCollapse()` Get the field collapsing specification for this QueryRequest.
`FieldExpression[]`	`getFields()` Get the fields requested for this query (or `null` for SELECT *).
`List<Query>`	`getFilters()` Get all filters for this query.
`Point`	`getGeoLocation()` Get the default center point for geo distance calculations.
`String`	`getGeoLocationField()` Get the default field to use for geo distance calculations.
`FieldExpression[]`	`getGroupBy()` Get the Group By specification.
`FieldExpression`	`getGroupByFilter()` Experimental: Get the filter to apply to groups.
`HighlightMode`	`getHighlightMode()` Get the `HighlightMode` for annotating scopes in highlighted text.
`String`	`getHighlightScope()` Get the name of the scope used to annotate matching phrases in highlighted text.
`JoinFacetMode`	`getJoinFacetMode()` Gets the facet mode for joined documents.
`JoinRollupMode`	`getJoinRollupMode()` Gets the rollup mode for joined documents.
`Locale`	`getLocale()` Get the Locale for this query.
`int`	`getMaxResubmits()` Gets the maximum number of resubmits allowed for this QueryRequest.
`long`	`getOffset()` Get the offset into the result set for the first returned document.
`AttivioPrincipal`	`getPrincipal()`
`Query`	`getQuery()` Get the search query for this QueryRequest.
`String`	`getQueryLanguage()` Get the query language for `getQueryString()`.
`String`	`getQueryString()` Get the original query string for the search query for this QueryRequest.
`List<RelevancyFeature>`	`getRelevancyFeatures()` Get the features to use for relevancy.
`RelevancyModel`	`getRelevancyModel()` Gets the relevancy model to use for this query.
`String`	`getRelevancyModelName()` Deprecated.
`String[]`	`getRelevancyModelNames()` Get the names of the requested relevancy models.
`int`	`getResubmits()` Get the number of times this QueryRequest has been resubmitted.
`FieldExpression`	`getRowFilter()` Experimental: Get the filter to apply to rows.
`long`	`getRows()` Get the requested number of documents to return for this request.
`String`	`getSchemaName()` Get the name of the schema to use for processing this QueryRequest.
`List<FieldExpression>`	`getScoreFunctions()` Gets the scoring functions to use for this QueryRequest.
`int`	`getSearchDepth()` Get the number of rows deep the search should go.
`String`	`getSearchProfile()` Get the name of the search profile to apply to the query request.
`long`	`getSeed()` Get the seed used for any random functions over this query request.
`List<Sort>`	`getSort()` Get the sorting specification for this QueryRequest.
`String`	`getSpellCheckDictionaryName()` Get the name of the dictionary to use for spellcheck.
`int`	`getSpellCheckExpandSize()` Gets the number of expanded suggestions that will be added for misspelled terms.
`QueryRequest.SpellCheckMode`	`getSpellCheckMode()` Get the mode for spell checking.
`String`	`getStopwordDictionaryName()` Get the name of the dictionary to use for stopword removal.
`QueryRequest.StopwordsMode`	`getStopwordsMode()` Get the mode for stopword removal.
`int`	`getSynonymBoost()` Get the boost to apply to expanded synonyms.
`String`	`getSynonymDictionaryName()` Get the name of the dictionary to use for synonym expansion.
`QueryRequest.SynonymsMode`	`getSynonymsMode()` Get the mode for synonym expansion.
`TimeZone`	`getTimeZone()` Get the TimeZone for this query.
`Set<String>`	`getZones()` Get the names of the zones to apply this query to.
`boolean`	`hasFacets()` `true` if this QueryRequest is requesting any Facets.
`int`	`hashCode()`
`void`	`incrementResubmits()` Increment the number of times this QueryRequest has been resubmitted.
`boolean`	`isCacheable()` Get if the results for this QueryRequest are cacheable.
`boolean`	`isDebug()` Get if debugging information is desired for this request.
`boolean`	`isHighlight()` `true` if highlighting should be performed for configured fields.
`boolean`	`isIncludeMetadataInResponse()` True if the response should be removed of all non data elements such as message history and the query request.
`boolean`	`isPartialResults()` Gets if partial result is allowed for this request.
`boolean`	`removeFacet(FacetRequest facet)` Remove the specified FacetRequest.
`boolean`	`removeFacet(String facetRequestName)` Remove the specified FacetRequest by name.
`void`	`setAcronymBoost(int acronymBoost)` Set the boost to apply to expanded acronyms.
`void`	`setAcronymDictionaryName(String value)` Set the name of the dictionary to use for acronym expansion.
`void`	`setAcronymsMode(QueryRequest.AcronymsMode acronymsMode)` Set the mode for expanding acronyms.
`void`	`setBoostQueries(List<Query> value)` Set the boost queries.
`void`	`setCacheable(boolean value)` Set if the results for this QueryRequest are cacheable.
`void`	`setCenterTime(Date value)`
`void`	`setDebug(boolean value)` Set if debugging information is desired for this request.
`void`	`setFacetFilters(List<FacetFilter> facetFilters)` Set the `FacetFilter`s to "drill down" on.
`void`	`setFacetFinderCount(int facetFinderCount)` Set the maximum number of facets FacetFinder will add to this QueryRequest.
`void`	`setFacetFinderMode(QueryRequest.FacetFinderMode facetFinderMode)` Set the mode for FacetFinder.
`void`	`setFacets(Collection<FacetRequest> facets)` Set the `FacetRequest`s for this query
`void`	`setFacets(FacetRequest... facets)` Set the `FacetRequest`s for this query.
`void`	`setFacets(String... facets)` Set the fields to request facets for.
`void`	`setFacetSampleSize(int value)` Set the sample size for sample based facets.
`void`	`setFieldCollapse(FieldCollapse value)` Set the field collapsing specification for this QueryRequest.
`void`	`setFields(Collection<FieldExpression> value)` Set the fields to return for this QueryRequest.
`void`	`setFields(FieldExpression... newFields)` Set the fields to return for this QueryRequest.
`void`	`setFields(String... newFields)` Set the names of the fields that should be returned in the response.
`void`	`setFilters(List<Query> filters)` Set the filter `Query`s to apply to this QueryRequest.
`void`	`setGroupBy(FieldExpression... columns)` Set the Group By specification.
`void`	`setGroupBy(List<FieldExpression> columns)` Set the Group By specification.
`void`	`setGroupBy(String... columns)` Set the Group By specification.
`void`	`setGroupByFilter(FieldExpression value)` Experimental: Set the filter to apply to groups.
`void`	`setGroupByFilter(String value)` Experimental: Set the filter to apply to groups.
`void`	`setHighlight(boolean value)` Set if highlighting should be performed for configured fields.
`void`	`setHighlightMode(HighlightMode value)` Set the `HighlightMode` for annotating scopes in highlighted text.
`void`	`setHighlightScope(String value)` Set the name of the scope used to annotate matching phrases in highlighted text.
`void`	`setIncludeMetadataInResponse(boolean includeMetadataInResponse)`
`void`	`setJoinFacetMode(JoinFacetMode value)` Sets the facet mode for joined documents.
`void`	`setJoinRollupMode(JoinRollupMode value)` Sets the rollup mode for joined documents.
`void`	`setLocale(Locale l)` Set the Locale for this query.
`void`	`setMaxResubmits(int value)` Sets the maximum number of resubmits allowed for this QueryRequest.
`void`	`setOffset(long value)` Set the offset into the result set for the first returned document.
`void`	`setPartialResults(boolean value)` Gets if partial result is allowed for this request.
`void`	`setPrincipal(AttivioPrincipal principal)`
`void`	`setProperties(Map<String,String[]> parameters)`
`void`	`setProperty(String name, Object value)` Sets an arbitrary property for the message.
`void`	`setQuery(Query query)` Set the search query for this QueryRequest.
`void`	`setQuery(String query)` Set the search query for this QueryRequest.
`void`	`setQuery(String queryString, String language)` Set the search query for this QueryRequest.
`void`	`setQueryString(String query)` Set the search query for this QueryRequest.
`void`	`setRelevancyFeatures(List<RelevancyFeature> value)` Set the features to use for relevancy.
`void`	`setRelevancyFeatures(RelevancyFeature... value)` Set the features to use for relevancy.
`void`	`setRelevancyModel(RelevancyModel model)` Sets the relevancy model to use for this query.
`void`	`setRelevancyModelName(String name)` Deprecated. Use `setRelevancyModelNames(String...)` instead.
`void`	`setRelevancyModelNames(List<String> value)` Set the names of the requested relevancy models.
`void`	`setRelevancyModelNames(String... value)` Set the names of the requested relevancy models.
`void`	`setResubmits(int rs)` Set the number of times this QueryRequest has been resubmitted.
`void`	`setRowFilter(FieldExpression value)` Experimental: Set the filter to apply to rows.
`void`	`setRowFilter(String value)` Experimental: Set the filter to apply to rows.
`void`	`setRows(long value)` Set the requested number of documents to return in the `QueryResponse` for this request.
`void`	`setSchemaName(String schemaName)` Set the name of the schema to use for processing this QueryRequest.
`void`	`setScoreFunctions(List<FieldExpression> value)` Sets the scoring functions to use for this QueryRequest.
`void`	`setSearchDepth(int value)` Set the number of rows deep the search should go.
`void`	`setSearchProfile(String name)` Set the name of the search profile to apply to the query request.
`void`	`setSeed(long value)` Set the seed used for any random functions over this query request.
`void`	`setSort(List<Sort> value)` Set the sorting specification for this QueryRequest.
`void`	`setSort(Sort... value)`
`void`	`setSpellCheckDictionaryName(String value)` Set the name of the dictionary to use for spellcheck.
`void`	`setSpellCheckExpandSize(int value)` Sets the number of expanded suggestions that will be added for misspelled terms.
`void`	`setSpellCheckMode(QueryRequest.SpellCheckMode spellCheckMode)` Set the mode for spell checking.
`void`	`setStopwordDictionaryName(String value)` Set the name of the dictionary to use for stopword removal.
`void`	`setStopwordsMode(QueryRequest.StopwordsMode stopwordsMode)` Set the mode for stopword removal.
`void`	`setSynonymBoost(int synonymBoost)` Set the boost to apply to expanded synonyms.
`void`	`setSynonymDictionaryName(String value)` Set the name of the dictionary to use for synonym expansion.
`void`	`setSynonymsMode(QueryRequest.SynonymsMode synonymsMode)` Set the mode for synonym expansion.
`void`	`setTimeZone(TimeZone value)` Set the TimeZone for this query.
`void`	`setZones(Set<String> value)` Set the names of the zones to apply this query to.
`void`	`setZones(String... value)` Set the names of the zones to apply this query to.
`CgiRequest`	`toCgiRequest()` Creates a CgiRequest from a QueryRequest.
`String`	`toCgiString()` Returns a parseable CGI string representation of the request
`protected StringBuilder`	`toString(StringBuilder buffer)` Append the string form of this request to `buffer`.

Methods inherited from class com.attivio.sdk.esb.AbstractPlatformMessage
addMessageHistory, addMessageHistory, getClientId, getEstimatedSize, getMessageHistory, getMessageId, getMetadata, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getWorkflowQueue, getWorkflowQueue, hasProperty, isRedelivered, removeProperty, removeWorkflowQueue, setClientId, setMessageId, setRedelivered, setWorkflowQueue, setWorkflowQueue, toMessageString, toString, toString, toString, toString, toString, toString, toString, toString, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- DEFAULT_ROWS
```
public static final long DEFAULT_ROWS
```
  Default value for getRows().
  
  See Also:
  
  Constant Field Values
- DEFAULT_OFFSET
```
public static final long DEFAULT_OFFSET
```
  Default value for getOffset().
  
  See Also:
  
  Constant Field Values
- DEFAULT_DEBUG
```
public static final boolean DEFAULT_DEBUG
```
  Default value for isDebug().
  
  See Also:
  
  Constant Field Values
- DEFAULT_INCLUDE_METADATA_IN_RESPONSE
```
public static final boolean DEFAULT_INCLUDE_METADATA_IN_RESPONSE
```
  Default value for isDebug().
  
  See Also:
  
  Constant Field Values
- DEFAULT_SEARCH_DEPTH
```
public static final int DEFAULT_SEARCH_DEPTH
```
  Default value for getSearchDepth().
  
  See Also:
  
  Constant Field Values
- DEFAULT_STOPWORDS_MODE
```
public static final QueryRequest.StopwordsMode DEFAULT_STOPWORDS_MODE
```
  Default value for getStopwordsMode().
- DEFAULT_SYNONYM_MODE
```
public static final QueryRequest.SynonymsMode DEFAULT_SYNONYM_MODE
```
  Default value for getSynonymsMode().
- DEFAULT_SYNONYM_BOOST
```
public static final int DEFAULT_SYNONYM_BOOST
```
  Default value for getSynonymBoost().
  
  See Also:
  
  Constant Field Values
- DEFAULT_ACRONYM_MODE
```
public static final QueryRequest.AcronymsMode DEFAULT_ACRONYM_MODE
```
  Default value for getAcronymsMode().
- DEFAULT_ACRONYM_BOOST
```
public static final int DEFAULT_ACRONYM_BOOST
```
  Default value for getAcronymBoost().
  
  See Also:
  
  Constant Field Values
- DEFAULT_FACET_SAMPLE_SIZE
```
public static final int DEFAULT_FACET_SAMPLE_SIZE
```
  Default value for getFacetSampleSize().
  
  See Also:
  
  Constant Field Values
- DEFAULT_LOCALE
```
public static final Locale DEFAULT_LOCALE
```
  Default value for getLocale().
- DEFAULT_HIGHLIGHT
```
public static final boolean DEFAULT_HIGHLIGHT
```
  Default value for isHighlight().
  
  See Also:
  
  Constant Field Values
- DEFAULT_HIGHLIGHT_MODE
```
public static final HighlightMode DEFAULT_HIGHLIGHT_MODE
```
  Default value for getHighlightMode().
- DEFAULT_HIGHLIGHT_SCOPE
```
public static final String DEFAULT_HIGHLIGHT_SCOPE
```
  Default value for getHighlightScope().
  
  See Also:
  
  Constant Field Values
- DEFAULT_CACHEABLE
```
public static final boolean DEFAULT_CACHEABLE
```
  Default value for isCacheable().
  
  See Also:
  
  Constant Field Values
- DEFAULT_SPELLCHECK_MODE
```
public static final QueryRequest.SpellCheckMode DEFAULT_SPELLCHECK_MODE
```
  Default value for getSpellCheckMode().
- DEFAULT_SPELLCHECK_EXPAND_SIZE
```
public static final int DEFAULT_SPELLCHECK_EXPAND_SIZE
```
  Default value for getSpellCheckExpandSize().
  
  See Also:
  
  Constant Field Values
- DEFAULT_MAX_RESUBMITS
```
public static final int DEFAULT_MAX_RESUBMITS
```
  Default value for getMaxResubmits().
  
  See Also:
  
  Constant Field Values
- DEFAULT_RESUBMITS
```
public static final int DEFAULT_RESUBMITS
```
  Initial value for getResubmits().
  
  See Also:
  
  Constant Field Values
- DEFAULT_PARTIAL_RESULTS
```
public static final boolean DEFAULT_PARTIAL_RESULTS
```
  Default value for isPartialResults()
  
  See Also:
  
  Constant Field Values
- DEFAULT_SEED
```
public static final long DEFAULT_SEED
```
  Default value for getSeed().
  
  See Also:
  
  Constant Field Values
- DEFAULT_FACET_FINDER_MODE
```
public static final QueryRequest.FacetFinderMode DEFAULT_FACET_FINDER_MODE
```
  Default value for getFacetFinderMode().
- DEFAULT_FACET_FINDER_COUNT
```
public static final int DEFAULT_FACET_FINDER_COUNT
```
  Default value for getFacetFinderCount().
  
  See Also:
  
  Constant Field Values
- DEFAULT_JOIN_ROLLUP_MODE
```
public static final JoinRollupMode DEFAULT_JOIN_ROLLUP_MODE
```
  Default value for getJoinRollupMode().
- DEFAULT_JOIN_FACET_MODE
```
public static final JoinFacetMode DEFAULT_JOIN_FACET_MODE
```
  Default value for getJoinFacetMode().
- SPELLCHECK_MODE_DEFAULT
```
public static final String SPELLCHECK_MODE_DEFAULT
```
  Default spellcheck mode.

Constructor Detail
- QueryRequest
```
public QueryRequest()
```
  The default constructor. No query is set.
- QueryRequest
```
public QueryRequest(Query query)
```
  Constructor with a Query.
- QueryRequest
```
public QueryRequest(String query)
```
  Constructor with a string query.
  
  See Also:
  
  QueryString
- QueryRequest
```
public QueryRequest(String query,
                    String language)
```
  Constructor with a query string and query language.
  
  See Also:
  
  QueryString

Method Detail

isDebug
```
public boolean isDebug()
```
Get if debugging information is desired for this request.

setDebug
```
public void setDebug(boolean value)
```
Set if debugging information is desired for this request.

getRows
```
public long getRows()
```
Get the requested number of documents to return for this request.

setRows
```
public void setRows(long value)
```
Set the requested number of documents to return in the QueryResponse for this request.
Only values < Integer.MAX_VALUE are supported.

getOffset
```
public long getOffset()
```
Get the offset into the result set for the first returned document.

setOffset
```
public void setOffset(long value)
```
Set the offset into the result set for the first returned document.
Currently only values < Integer.MAX_VALUE are supported.

isIncludeMetadataInResponse
```
public boolean isIncludeMetadataInResponse()
```
True if the response should be removed of all non data elements such as message history and the query request.

setIncludeMetadataInResponse

public void setIncludeMetadataInResponse(boolean includeMetadataInResponse)

getSearchProfile
```
public String getSearchProfile()
```
Get the name of the search profile to apply to the query request.

setSearchProfile
```
public void setSearchProfile(String name)
```
Set the name of the search profile to apply to the query request.

getQuery
```
public Query getQuery()
```
Get the search query for this QueryRequest.

setQuery
```
public void setQuery(Query query)
```
Set the search query for this QueryRequest.

setQuery
```
public void setQuery(String query)
```
Set the search query for this QueryRequest.

See Also:

QueryString

setQueryString
```
public void setQueryString(String query)
```
Set the search query for this QueryRequest.

See Also:

QueryString

setQuery

public void setQuery(String queryString,
                     String language)

Set the search query for this QueryRequest.

See Also:: QueryString

getQueryString
```
public String getQueryString()
```
Get the original query string for the search query for this QueryRequest.

See Also:

Query.getQueryString()

getQueryLanguage
```
public String getQueryLanguage()
```
Get the query language for getQueryString().

See Also:

Query.getQueryLanguage()

getSearchDepth
```
public int getSearchDepth()
```
Get the number of rows deep the search should go. When using Field Collapsing, increasing this setting increases the accuracy of Field Collapsing across multiple partitions by giving the collapsing algorithm more rows to collapse. There are no other scenarios where this parameter has any effect.

By default, the search depth will be getOffset() + getRows().
NOTE: this does not affect the number of documents returned.

setSearchDepth
```
public void setSearchDepth(int value)
```
Set the number of rows deep the search should go. When using Field Collapsing, increasing this setting increases the accuracy of Field Collapsing across multiple partitions by giving the collapsing algorithm more rows to collapse. There are no other scenarios where this parameter has any effect.

By default, the search depth will be getOffset() + getRows().
NOTE: this does not affect the number of documents returned.

addBoostQuery
```
public void addBoostQuery(Query boost)
```
Add a boost query.
NOTE: Boost queries are only used for ranking, not matching records.

setBoostQueries

public void setBoostQueries(List<Query> value)

Set the boost queries.

getBoostQueries
```
public List<Query> getBoostQueries()
```
Get all boost queries applied to this QueryRequest.

getFilters
```
public List<Query> getFilters()
```
Get all filters for this query.

setFilters
```
public void setFilters(List<Query> filters)
```
Set the filter Querys to apply to this QueryRequest.

addFilter
```
public void addFilter(Query f)
```
Add a filter Query to this QueryRequest.

addFilter
```
public void addFilter(String exp)
```
Add a filter query to this QueryRequest.

addFilter
```
public void addFilter(String exp,
                      String langSpec)
```
Add a filter query to this QueryRequest.

Parameters:

exp - the query to filter on

langSpec - the query language for exp

getFacetFilters
```
public List<FacetFilter> getFacetFilters()
```
Get the FacetFilters that will be used to filter the result set.

setFacetFilters

public void setFacetFilters(List<FacetFilter> facetFilters)

Set the FacetFilters to "drill down" on.

addFacetFilter
```
public void addFacetFilter(FacetFilter bucket)
```
Adds a filter to this QueryRequest that will "drill down" on bucket.

getZones
```
public Set<String> getZones()
```
Get the names of the zones to apply this query to.

setZones
```
public void setZones(Set<String> value)
```
Set the names of the zones to apply this query to.

setZones
```
public void setZones(String... value)
```
Set the names of the zones to apply this query to.

isCacheable
```
public boolean isCacheable()
```
Get if the results for this QueryRequest are cacheable.

setCacheable
```
public void setCacheable(boolean value)
```
Set if the results for this QueryRequest are cacheable.

getSeed
```
public long getSeed()
```
Get the seed used for any random functions over this query request.
This seed will be used when a "random" sort is applied to this QueryRequest.

setSeed
```
public void setSeed(long value)
```
Set the seed used for any random functions over this query request.
This seed will be used when a "random" sort is applied to this QueryRequest.

getJoinRollupMode
```
public JoinRollupMode getJoinRollupMode()
```
Gets the rollup mode for joined documents.
This setting is only relevant if the search query is a JOIN query.

setJoinRollupMode
```
public void setJoinRollupMode(JoinRollupMode value)
```
Sets the rollup mode for joined documents.
This setting is only relevant if the search query is a JOIN query.

getJoinFacetMode
```
public JoinFacetMode getJoinFacetMode()
```
Gets the facet mode for joined documents.
This setting is only relevant if the search query contains JOIN queries.

setJoinFacetMode
```
public void setJoinFacetMode(JoinFacetMode value)
```
Sets the facet mode for joined documents.
This setting is only relevant if the search query contains JOIN queries.

getRelevancyModel
```
public RelevancyModel getRelevancyModel()
```
Gets the relevancy model to use for this query.

setRelevancyModel
```
public void setRelevancyModel(RelevancyModel model)
```
Sets the relevancy model to use for this query.

getRelevancyModelNames
```
public String[] getRelevancyModelNames()
```
Get the names of the requested relevancy models.
The first relevancy model that exists will be applied during query processing.

setRelevancyModelNames
```
public void setRelevancyModelNames(List<String> value)
```
Set the names of the requested relevancy models.
The first relevancy model that exists will be applied during query processing.

setRelevancyModelNames
```
public void setRelevancyModelNames(String... value)
```
Set the names of the requested relevancy models.
The first relevancy model that exists will be applied during query processing.

getRelevancyModelName
```
@Deprecated
public String getRelevancyModelName()
```
Deprecated.

Gets the name of the relevancy model to use for this query.

setRelevancyModelName
```
@Deprecated
public void setRelevancyModelName(String name)
```
Deprecated. Use setRelevancyModelNames(String...) instead.

Sets the name of the relevancy model to use for this query.
With default configurations, this can be set to "noop" in order to apply an empty relevancy model.

isPartialResults
```
public boolean isPartialResults()
```
Gets if partial result is allowed for this request.

setPartialResults
```
public void setPartialResults(boolean value)
```
Gets if partial result is allowed for this request.

getRelevancyFeatures
```
public List<RelevancyFeature> getRelevancyFeatures()
```
Get the features to use for relevancy.

setRelevancyFeatures

public void setRelevancyFeatures(List<RelevancyFeature> value)

Set the features to use for relevancy.

setRelevancyFeatures

public void setRelevancyFeatures(RelevancyFeature... value)

Set the features to use for relevancy.

getScoreFunctions
```
public List<FieldExpression> getScoreFunctions()
```
Gets the scoring functions to use for this QueryRequest.

setScoreFunctions
```
public void setScoreFunctions(List<FieldExpression> value)
```
Sets the scoring functions to use for this QueryRequest.

addScoreFunction
```
public void addScoreFunction(String value)
```
Add a scoring function to this QueryRequest.

addScoreFunction
```
public void addScoreFunction(String... value)
```
Add a scoring function to this QueryRequest.

addScoreFunction
```
public void addScoreFunction(FieldExpression value)
```
Add a scoring function to this QueryRequest.

addScoreFunction
```
public void addScoreFunction(FieldExpression... value)
```
Add a scoring function to this QueryRequest.

getMaxResubmits
```
public int getMaxResubmits()
```
Gets the maximum number of resubmits allowed for this QueryRequest.

setMaxResubmits
```
public void setMaxResubmits(int value)
```
Sets the maximum number of resubmits allowed for this QueryRequest.

getResubmits
```
public int getResubmits()
```
Get the number of times this QueryRequest has been resubmitted.

setResubmits
```
public void setResubmits(int rs)
```
Set the number of times this QueryRequest has been resubmitted.
NOTE: this method should only be used by QueryResponse Transformers that will perform resubmit logic.

incrementResubmits
```
public void incrementResubmits()
```
Increment the number of times this QueryRequest has been resubmitted.
NOTE: this method should only be used by QueryResponse Transformers that will perform resubmit logic.

getSort
```
public List<Sort> getSort()
```
Get the sorting specification for this QueryRequest.
If null or "empty", then sorting will be done by score descending.

setSort
```
public void setSort(Sort... value)
```

setSort
```
public void setSort(List<Sort> value)
```
Set the sorting specification for this QueryRequest.
If null or "empty", then sorting will be done by score descending.

addSort
```
public void addSort(Sort value)
```
Add a Sort specifier to this QueryRequest.

addSort

public void addSort(String field,
                    Sort.SortOrder order)

addSort

public void addSort(FieldExpression field,
                    Sort.SortOrder order)

getFacetSampleSize
```
public int getFacetSampleSize()
```
Get the sample size for sample based facets.

setFacetSampleSize
```
public void setFacetSampleSize(int value)
```
Set the sample size for sample based facets.

hasFacets
```
public boolean hasFacets()
```
true if this QueryRequest is requesting any Facets.

getFacets
```
public List<FacetRequest> getFacets()
```
Get the facets requested for this QueryRequest.

setFacets
```
public void setFacets(String... facets)
```
Set the fields to request facets for.
NOTE: overwrites any FacetRequests already set.

setFacets
```
public void setFacets(FacetRequest... facets)
```
Set the FacetRequests for this query.
NOTE: overwrites any FacetRequests already set

setFacets
```
public void setFacets(Collection<FacetRequest> facets)
```
Set the FacetRequests for this query
NOTE: overwrites any FacetRequests already set.

addFacet
```
public void addFacet(FacetRequest... f)
```
Adds all FacetRequests to this QueryRequest.

addFacetField
```
public void addFacetField(String... fieldNames)
```
Adds a FacetRequest for all specified fields.

removeFacet

public boolean removeFacet(FacetRequest facet)

Remove the specified FacetRequest.

removeFacet

public boolean removeFacet(String facetRequestName)

Remove the specified FacetRequest by name.

isHighlight
```
public boolean isHighlight()
```
true if highlighting should be performed for configured fields.

setHighlight
```
public void setHighlight(boolean value)
```
Set if highlighting should be performed for configured fields.

getHighlightMode
```
public HighlightMode getHighlightMode()
```
Get the HighlightMode for annotating scopes in highlighted text.

setHighlightMode
```
public void setHighlightMode(HighlightMode value)
```
Set the HighlightMode for annotating scopes in highlighted text.

getHighlightScope
```
public String getHighlightScope()
```
Get the name of the scope used to annotate matching phrases in highlighted text.

setHighlightScope
```
public void setHighlightScope(String value)
```
Set the name of the scope used to annotate matching phrases in highlighted text.

getFields
```
public FieldExpression[] getFields()
```
Get the fields requested for this query (or null for SELECT *).

setFields

public void setFields(Collection<FieldExpression> value)

Set the fields to return for this QueryRequest.

setFields
```
public void setFields(FieldExpression... newFields)
```
Set the fields to return for this QueryRequest.

setFields
```
public void setFields(String... newFields)
```
Set the names of the fields that should be returned in the response. (or null for SELECT *).
NOTE: if isHighlight() returns true, then any field in fields that is configured in the schema for highlighting will be returned highlighted according to schema configuration. Use addField(FieldExpression) to add FieldExpressions configured as desired.

addField
```
public void addField(String field)
```
Add a field to return in the response documents.

addField
```
public void addField(FieldExpression field)
```
Add a FieldExpression to return for this QueryRequest.

getFieldCollapse
```
public FieldCollapse getFieldCollapse()
```
Get the field collapsing specification for this QueryRequest.

setFieldCollapse
```
public void setFieldCollapse(FieldCollapse value)
```
Set the field collapsing specification for this QueryRequest.

getGroupByFilter
```
public FieldExpression getGroupByFilter()
```
Experimental: Get the filter to apply to groups.
This allows applying a HAVING filter to the result set. This filter requires that a groupby has been applied to the query.

setGroupByFilter
```
public void setGroupByFilter(FieldExpression value)
```
Experimental: Set the filter to apply to groups.

setGroupByFilter
```
public void setGroupByFilter(String value)
```
Experimental: Set the filter to apply to groups.

getRowFilter
```
public FieldExpression getRowFilter()
```
Experimental: Get the filter to apply to rows.
This allows applying a field expression based WHERE filter to the result set.

setRowFilter
```
public void setRowFilter(FieldExpression value)
```
Experimental: Set the filter to apply to rows.

setRowFilter
```
public void setRowFilter(String value)
```
Experimental: Set the filter to apply to rows.

getGroupBy
```
public FieldExpression[] getGroupBy()
```
Get the Group By specification.

setGroupBy

public void setGroupBy(String... columns)

Set the Group By specification.

setGroupBy

public void setGroupBy(FieldExpression... columns)

Set the Group By specification.

setGroupBy

public void setGroupBy(List<FieldExpression> columns)

Set the Group By specification.

getSpellCheckMode

public QueryRequest.SpellCheckMode getSpellCheckMode()

Get the mode for spell checking.

setSpellCheckMode

public void setSpellCheckMode(QueryRequest.SpellCheckMode spellCheckMode)

Set the mode for spell checking.

getSpellCheckDictionaryName
```
public String getSpellCheckDictionaryName()
```
Get the name of the dictionary to use for spellcheck.

setSpellCheckDictionaryName
```
public void setSpellCheckDictionaryName(String value)
```
Set the name of the dictionary to use for spellcheck.

getSpellCheckExpandSize
```
public int getSpellCheckExpandSize()
```
Gets the number of expanded suggestions that will be added for misspelled terms.
NOTE: this setting will only be used if the AUTO_EXPAND spell check mode is used.

setSpellCheckExpandSize
```
public void setSpellCheckExpandSize(int value)
```
Sets the number of expanded suggestions that will be added for misspelled terms.
NOTE: this setting will only be used if the AUTO_EXPAND spell check mode is used.

getAcronymsMode

public QueryRequest.AcronymsMode getAcronymsMode()

Get the mode for expanding acronyms.

setAcronymsMode

public void setAcronymsMode(QueryRequest.AcronymsMode acronymsMode)

Set the mode for expanding acronyms.

getAcronymDictionaryName
```
public String getAcronymDictionaryName()
```
Get the name of the dictionary to use for acronym expansion.

setAcronymDictionaryName
```
public void setAcronymDictionaryName(String value)
```
Set the name of the dictionary to use for acronym expansion.

getAcronymBoost
```
public int getAcronymBoost()
```
Get the boost to apply to expanded acronyms.

setAcronymBoost
```
public void setAcronymBoost(int acronymBoost)
```
Set the boost to apply to expanded acronyms.
This can be used to reduce or nullify the boost contributed by acronyms in order to utilize acronym expansion for increasing recall.

getSynonymsMode

public QueryRequest.SynonymsMode getSynonymsMode()

Get the mode for synonym expansion.

setSynonymsMode

public void setSynonymsMode(QueryRequest.SynonymsMode synonymsMode)

Set the mode for synonym expansion.

getSynonymDictionaryName
```
public String getSynonymDictionaryName()
```
Get the name of the dictionary to use for synonym expansion.

setSynonymDictionaryName
```
public void setSynonymDictionaryName(String value)
```
Set the name of the dictionary to use for synonym expansion.

getSynonymBoost
```
public int getSynonymBoost()
```
Get the boost to apply to expanded synonyms.

setSynonymBoost
```
public void setSynonymBoost(int synonymBoost)
```
Set the boost to apply to expanded synonyms.
This can be used to reduce or nullify the boost contributed by synonyms in order to utilize synonym expansion for increasing recall.

getStopwordsMode

public QueryRequest.StopwordsMode getStopwordsMode()

Get the mode for stopword removal.

setStopwordsMode

public void setStopwordsMode(QueryRequest.StopwordsMode stopwordsMode)

Set the mode for stopword removal.

getStopwordDictionaryName
```
public String getStopwordDictionaryName()
```
Get the name of the dictionary to use for stopword removal.

setStopwordDictionaryName
```
public void setStopwordDictionaryName(String value)
```
Set the name of the dictionary to use for stopword removal.

getFacetFinderMode

public QueryRequest.FacetFinderMode getFacetFinderMode()

Get the mode for FacetFinder.

setFacetFinderMode

public void setFacetFinderMode(QueryRequest.FacetFinderMode facetFinderMode)

Set the mode for FacetFinder.

getFacetFinderCount
```
public int getFacetFinderCount()
```
Get the maximum number of facets FacetFinder will add to this QueryRequest.

setFacetFinderCount
```
public void setFacetFinderCount(int facetFinderCount)
```
Set the maximum number of facets FacetFinder will add to this QueryRequest.

getLocale
```
public Locale getLocale()
```
Get the Locale for this query.

Specified by:

getLocale in interface LocaleAware

setLocale
```
public void setLocale(Locale l)
```
Set the Locale for this query.
In general a correct value for the Locale is required in order to perform proper query side linguistics.

Specified by:

setLocale in interface LocaleAware

getCenterTime
```
public Date getCenterTime()
```
Since:

5.5.0.3 Get the center time used for evaluating date expressions.
This center time will be used as the "current time" for all evaluated field expressions (such as CurrentTime)

setCenterTime
```
public void setCenterTime(Date value)
```
Since:

5.5.0.3 Set the center time used for evaluating date expressions.
This center time will be used as the "current time" for all evaluated field expressions (such as CurrentTime)

getTimeZone
```
public TimeZone getTimeZone()
```
Get the TimeZone for this query.

setTimeZone

public void setTimeZone(TimeZone value)

Set the TimeZone for this query.

getSchemaName
```
public String getSchemaName()
```
Get the name of the schema to use for processing this QueryRequest.

setSchemaName
```
public void setSchemaName(String schemaName)
```
Set the name of the schema to use for processing this QueryRequest.

toString
```
protected StringBuilder toString(StringBuilder buffer)
```
Append the string form of this request to buffer.

Overrides:

toString in class AbstractPlatformMessage

toCgiRequest
```
public CgiRequest toCgiRequest()
```
Creates a CgiRequest from a QueryRequest. This is the inverse operation of the QueryRequest create method. Not all queries and filters are guaranteed to have equivalent parseable string representations; this method cannot guarantee an equivalent CGI Request for such cases.

toCgiString
```
public String toCgiString()
```
Returns a parseable CGI string representation of the request

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class AbstractPlatformMessage

equals
```
public boolean equals(Object other)
```
Overrides:

equals in class AbstractPlatformMessage

clone
```
public QueryRequest clone()
```
Clones the object and resets message ID to -1. Clones a message. The message ID is not cloned.

Specified by:

clone in interface PlatformMessage

Overrides:

clone in class AbstractPlatformMessage

Returns:

the cloned index message

getGeoLocationField
```
public String getGeoLocationField()
```
Get the default field to use for geo distance calculations.

getGeoLocation
```
public Point getGeoLocation()
```
Get the default center point for geo distance calculations.

setProperties

public void setProperties(Map<String,String[]> parameters)
                   throws AttivioException

Throws:: AttivioException

setProperty
```
public void setProperty(String name,
                        Object value)
```
Description copied from class: AbstractPlatformMessage

Sets an arbitrary property for the message. Some transformations of messages may result in the value being converted to a String.

Specified by:

setProperty in interface PlatformMessage

Overrides:

setProperty in class AbstractPlatformMessage

Parameters:

name - the key

value - the value

create

public static QueryRequest create(CgiRequest cgi)
                           throws AttivioException

Converts CGI HTTP POST/GET request to a QueryRequest.

Parameter	Type⁽¹⁾	Default	Multi⁽²⁾	Description	Example
clientid	String	optional	no	Client ID.	clientid=1234
workflows	String	required	no	Comma separated list of workflows to send the query through.	workflows=defaultQuery,searcher,defaultResponse
q	String	required	no	Query String	q=cat
q.type	String	`advanced`	no	Query Language used. [ `simple` \| `advanced` ]	q.type=simple
filter	String	optional	yes	Filter `Query` to apply.	filter=position:POLYGON((5.0, 9.0), (5.0, 11.0), (6.0, 11.0), (6.0, 9.0))
q.filter	String	optional	yes	Query Filter.	q.filter=color:black
q.filter.type	String	`simple`	no	Deprecated. Query Language used by filter. [ `simple` \| `advanced` ]	q.filter.type=advanced
q.boost	String	optional	yes	Query Boost Expression	q.boost=foo
q.boost.type	String	`advanced`	no	Query Language used by query boosts. [ `simple` \| `advanced` ]	q.boost.type=advanced
q.maxResubmits	unsigned	0	no	Maximum number of times query can be resubmitted.	q.maxResubmits=5
hits	unsigned	10L	no	Number of records to return.	hits=100
offset	unsigned	0L	no	Retrieve number of records starting from offset.	offset=20
searchDepth	unsigned	0	no	Number of rows deep to search.	searchDepth=100
searchProfile	String	optional	no	Name of the search profile to use.	searchProfile=mySearchProfile
debug	boolean	false	no	Enable debugging information. true or false	debug=true
includeMetadataInResponse	boolean	false	no	Include non essential/data (from the index) information in the response. true or false	debug=true
partialResults	boolean	false	no	Enable/Disable partial results from distributed indexes	partialResults=false
abc.enabled	boolean	false	no	Whether or not the query should be annotated as an Attivio Business Center query.	abc.enabled=true
cacheable	boolean	true	no	Is the result cacheable?	cacheable=false
seed	long	0L	no	Seed to use for random number generation (random sorting, etc)	seed=38293843928
locale	String	en	no	2 letter iso code for locale.	locale=en
timezone	String	UTC	no	Time Zone for date interpretation.	timezone=EST
schema	String	optional	no	Name of the schema to use for query processing	schema=default
relevancymodelname	String	optional	no	Comma separated list of relevancy model names to use for ranking documents by relevancy. The first relevancy model specified that exists will be used.	relevancyModelName=myTestModel
highlight	boolean	false	no	highlight results based on schema configuration	highlight=true
fields	String	optional	yes	Comma separated list of field expressions to return with response documents.	fields=*,geodistance(position, 72.3, 71.5, degrees, miles) AS distance
sort	String	optional	no	Comma separated list of fields to sort by [ ASC \| DESC ]	sort=title:asc,body:desc
score.function	String	optional	yes	Score function to boost matching documents with	score.function=product(sum(5.5, boostfield), boostfactorfield)
collapse	String	optional	no	Field collapsing specification.	Example: collapse=cat(mode=2D, rows=10)
facet	String	optional	yes	Comma separated list of discrete facet definitions.	Example: facet=title(mincutoff=3,sortby=count),category(maxnumbuckets=100)
facet.filter	String	optional	no	Facet bucket to use for filtering results.	Example: facet.filter=department:"Sales Engineering"
rangeFacet	String	optional	yes	Comma separated list of range facet definitions.	rangeFacet=size(range=int("label-1", 0, 5),range=int("label-2", 5, 10))
rangeFacet.filter	String	optional	no	Range Facet bucket to use for filtering results.	Example: rangeFacet.filter=size:[0 TO 50]
schemaFacet	String	optional	yes	Schema facet definition	schemaFacet=schema(schemaFields=true)
facet.ff	enum	`OFF`	no	Facet finder mode. [ `OFF` \| `RESULTS` ]	facet.ff=RESULTS
facet.ffcount	unsigned	3	no	Limit the number of facets returned by Facet Finder service	facet.ffcount=4
join.rollup	enum	`AGGREGATE`	no	Join children aggregation mode. [ `AGGREGATE` \| `TREE`]	join.rollup=TREE
join.facet	enum	`DISTINCT`	no	Join children facet aggregation mode. [ `DISTINCT` \| `FULL`]	join.facet=FULL
l.stopwords.mode	enum	`OFF`	no	Enable stop word removal. [ `OFF` \| `REMOVE` \| `BLOCK` ]	l.stopwords.mode=off
l.acronym.dictionary	String	optional	no	Name of the acronym dictionary to use.	l.acronym.dictionary=myAcronymDictionary
l.acronyms.mode	enum	`OFF`	no	Enable acronym expansion. [ `OFF` \| `ON` \| `AUTO` ]	l.acronyms.mode=off
l.acronyms.boost	int	100	no	Set boost for expanded acronyms.	l.acronyms.boost=25
l.synonym.dictionary	String	optional	no	Name of the synonym dictionary to use.	l.synonym.dictionary=mySynonymDictionary
l.synonyms.mode	enum	`OFF`	no	Enable synonyms. [ `OFF` \| `ON` \| `AUTO` ]	l.synoynms.mode=off
l.synonymBoost	int	100	no	set synonym boost or down weight.	l.synoynmBoost=25
l.spell.mode	enum	`OFF`	no	Spelling Correction Mode. [ `OFF` \| `SUGGEST` \| `AUTOCORRECT` \| `AUTOEXPAND` ]	l.spell.mode=SUGGEST
l.spellexpandsize	unsigned	2	no	Sets the number of expanded suggestions that will be added for misspelled terms.	l.spellexpandsize=2
geo.field	String	optional	no	The default field to use for geo search.	geo.field=position
geo.latitude	double	optional	no	The default latitude of center point for geo search.	geo.latitude=0
geo.longitude	double	optional	no	The default longitude of center point for geo search.	geo.longitude=0
geo.distanceUnits	enum	`KILOMETERS`	no	The units distances are specified. [ `KILOMETERS` \| `METERS` \| `MILES` \| `YARDS` \| `NAUTICAL_MILES` ]	geo.distanceUnits=MILES
*any unknown parameter*	String	optional	optional	All unknown cgi parameters are set as message properties via `setProperty(String, Object)`. These properties can then be used by custom transformers or accessed in cgi query logs for reporting purposes.	myProp=myValue

(1) The Type column indicates the data type expected for values of the query parameter. If values are specified that are not of this type, the default value will be used instead, unless the parameter is optional, in which case the parameter will be ignored.

(2) The Multi column indicates whether or not the HTTP query parameter can be specified multiple times. For example, since the q.filter parameter is Multi=yes, you can specify it mulitiple times like so q.filter=filter1&q.filter=filter2.



Parameters:
cgi - - CGI request object
Throws:
AttivioException







setPrincipal
public void setPrincipal(AttivioPrincipal principal)







getPrincipal
public AttivioPrincipal getPrincipal()

Returns:
attivio principal on request, or null if none exists

Class QueryRequest

Paging

Query Resubmission

Field Expressions

Boost Queries

Score Functions

Sorting

Faceting

Filtering

Nested Class Summary

Field Summary

Fields inherited from interface com.attivio.sdk.esb.PlatformMessage

Constructor Summary

Method Summary

Methods inherited from class com.attivio.sdk.esb.AbstractPlatformMessage

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ROWS

DEFAULT_OFFSET

DEFAULT_DEBUG

DEFAULT_INCLUDE_METADATA_IN_RESPONSE

DEFAULT_SEARCH_DEPTH

DEFAULT_STOPWORDS_MODE

DEFAULT_SYNONYM_MODE

DEFAULT_SYNONYM_BOOST

DEFAULT_ACRONYM_MODE

DEFAULT_ACRONYM_BOOST

DEFAULT_FACET_SAMPLE_SIZE

DEFAULT_LOCALE

DEFAULT_HIGHLIGHT

DEFAULT_HIGHLIGHT_MODE

DEFAULT_HIGHLIGHT_SCOPE

DEFAULT_CACHEABLE

DEFAULT_SPELLCHECK_MODE

DEFAULT_SPELLCHECK_EXPAND_SIZE

DEFAULT_MAX_RESUBMITS

DEFAULT_RESUBMITS

DEFAULT_PARTIAL_RESULTS

DEFAULT_SEED

DEFAULT_FACET_FINDER_MODE

DEFAULT_FACET_FINDER_COUNT

DEFAULT_JOIN_ROLLUP_MODE

DEFAULT_JOIN_FACET_MODE

SPELLCHECK_MODE_DEFAULT

Constructor Detail

QueryRequest

QueryRequest

QueryRequest

QueryRequest

Method Detail

isDebug

setDebug

getRows

setRows

getOffset

setOffset

isIncludeMetadataInResponse

setIncludeMetadataInResponse

getSearchProfile

setSearchProfile

getQuery

setQuery

setQuery

setQueryString

setQuery

getQueryString

getQueryLanguage

getSearchDepth

setSearchDepth

addBoostQuery

setBoostQueries

getBoostQueries

getFilters

setFilters

addFilter

addFilter

addFilter

getFacetFilters

setFacetFilters

addFacetFilter