AbstractQuery (GroupBy - API - Java

java.lang.Object
- com.groupbyinc.api.AbstractQuery<R,Q>

Direct Known Subclasses:: BaseQuery

public abstract class AbstractQuery<R extends AbstractRequest<R>,Q extends AbstractQuery<R,Q>>
extends java.lang.Object

Author:: Will Warren

Field Summary

Fields
Modifier and Type Field and Description

protected RestrictNavigation restrictNavigation

static java.lang.String TILDE_REGEX

Fields
Modifier and Type	Field and Description
`protected RestrictNavigation`	`restrictNavigation`
`static java.lang.String`	`TILDE_REGEX`

Constructor Summary

Constructors
Constructor and Description

AbstractQuery()
Default constructor

Constructors
Constructor and Description
`AbstractQuery()` `Default constructor`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Q`	`addCustomUrlParam(CustomUrlParam customUrlParam)` `Sets any additional parameters that can be used to trigger rules.`
`Q`	`addCustomUrlParam(java.lang.String key, java.lang.String value)` `Sets any additional parameters that can be used to trigger rules.`
`Q`	`addCustomUrlParamsByString(java.lang.String values)` `Helper method that takes a ~ separated string of additional parameters that can be used to trigger rules.`
`Q`	`addFields(java.lang.String... name)` `Specify which fields should be returned on each record that comes back from the engine.`
`Q`	`addOrField(java.lang.String... name)` `Specify which fields should be queried with 'OR' instead of the default 'AND'.`
`Q`	`addRangeRefinement(java.lang.String navigationName, java.lang.String low, java.lang.String high)` `Add a range refinement.`
`Q`	`addRangeRefinement(java.lang.String navigationName, java.lang.String low, java.lang.String high, boolean exclude)` `Add a range refinement.`
`Q`	`addRefinementsByString(java.lang.String refinementString)` `A helper method to parse and set refinements.`
`Q`	`addValueRefinement(java.lang.String navigationName, java.lang.String value)` `Add a value refinement.`
`Q`	`addValueRefinement(java.lang.String navigationName, java.lang.String value, boolean exclude)` `Add a value refinement.`
`protected static Sort`	`convertSort(Sort sort)`
`protected abstract R`	`generateRequest()`
`java.lang.String`	`getArea()`
`java.lang.String`	`getBiasingProfile()`
`java.lang.String`	`getBridgeJson(java.lang.String clientKey)` `Used internally by the bridge object to generate the JSON that is sent to the search service.`
`protected java.lang.String`	`getBridgeJsonRefinementSearch(java.lang.String clientKey)`
`java.lang.String`	`getBridgeRefinementsJson(java.lang.String clientKey, java.lang.String navigationName)` `Used internally by the bridge object to generate the JSON that is sent to the search service.`
`java.lang.String`	`getCollection()`
`java.util.List<CustomUrlParam>`	`getCustomUrlParams()`
`java.lang.String`	`getCustomUrlParamsString()`
`java.util.List<java.lang.String>`	`getFields()`
`java.lang.String`	`getLanguage()`
`java.util.Map<java.lang.String,Navigation>`	`getNavigations()`
`java.util.List<java.lang.String>`	`getOrFields()`
`long`	`getPageSize()`
`java.lang.String`	`getQuery()`
`java.lang.String`	`getRefinementString()`
`long`	`getSkip()`
`java.lang.String`	`getSubCollection()` Deprecated. since 2.0, use getCollection instead.
`boolean`	`isAutocorrectionDisabled()`
`boolean`	`isPruneRefinements()`
`boolean`	`isReturnBinary()`
`protected abstract RefinementsRequest<R>`	`populateRefinementRequest()`
`Q`	`setArea(java.lang.String area)` `The area you wish to fire against, production, staging, etc...`
`Q`	`setBiasingProfile(java.lang.String biasingProfile)` `Override the biasing profile used for this query - takes precedence over any biasing profile set in the command center.`
`Q`	`setCollection(java.lang.String collection)` `The collection to use.`
`Q`	`setDisableAutocorrection(boolean disableAutocorrection)` `Specifies whether the auto-correction behavior should be disabled.`
`Q`	`setLanguage(java.lang.String language)` `Sets the language filter on the query and restricts the results to a certain language.`
`Q`	`setPageSize(int pageSize)` `Page size.`
`Q`	`setPruneRefinements(boolean pruneRefinements)` `Specifies whether refinements should be pruned from the available navigation.`
`Q`	`setQuery(java.lang.String query)` `Set a search string.`
`Q`	`setRestrictNavigation(RestrictNavigation restrictNavigation)` `Warning This will count as two queries against your search index.`
`Q`	`setRestrictNavigation(java.lang.String name, int count)` `Warning This will count as two queries against your search index.`
`Q`	`setReturnBinary(boolean returnBinary)` `Tells the search service to return binary data.`
`Q`	`setSkip(int skip)` `Tell the search service to offset to the Nth record.`
`Q`	`setSubCollection(java.lang.String subCollection)` Deprecated. since 2.0, use setCollection instead.
`protected java.lang.String[]`	`splitRefinements(java.lang.String refinementString)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TILDE_REGEX
```
public static final java.lang.String TILDE_REGEX
```
    See Also:
    
    Constant Field Values
  - restrictNavigation
```
protected RestrictNavigation restrictNavigation
```
- Constructor Detail
  - AbstractQuery
```
public AbstractQuery()
```
    Default constructor
- Method Detail
  - generateRequest
```
protected abstract R generateRequest()
```
  - populateRefinementRequest
```
protected abstract RefinementsRequest<R> populateRefinementRequest()
```
  - convertSort
```
protected static Sort convertSort(Sort sort)
```
  - getBridgeJson
```
public java.lang.String getBridgeJson(java.lang.String clientKey)
```
    Used internally by the bridge object to generate the JSON that is sent to the search service.
    
    Parameters:
    
    clientKey - The client key used to authenticate this request.
    
    Returns:
    
    A JSON representation of this query object.
  - getBridgeRefinementsJson
```
public java.lang.String getBridgeRefinementsJson(java.lang.String clientKey,
                                                 java.lang.String navigationName)
```
    Used internally by the bridge object to generate the JSON that is sent to the search service.
    
    Parameters:
    
    clientKey - The client key used to authenticate this request.
    
    Returns:
    
    A JSON representation of this query object.
  - getQuery
```
public java.lang.String getQuery()
```
    Returns:
    
    The current search string.
  - setQuery
```
public Q setQuery(java.lang.String query)
```
    Set a search string. If query is blank all records are considered. JSON Reference: { "query": "gloves" }
    
    Parameters:
    
    query - The search term to fire against the engine
    
    Returns:
  - getSubCollection
```
public java.lang.String getSubCollection()
```
    Deprecated. since 2.0, use getCollection instead.
    
    Returns:
    
    The data collection
  - setSubCollection
```
public Q setSubCollection(java.lang.String subCollection)
```
    Deprecated. since 2.0, use setCollection instead.
    
    Parameters:
    
    subCollection - The string representation of a collection query.
    
    Returns:
  - getCollection
```
public java.lang.String getCollection()
```
    Returns:
    
    The data collection
  - setCollection
```
public Q setCollection(java.lang.String collection)
```
    The collection to use. If you have uploaded additional data into collections apart from the default collection using the stream tool, you can access them by specifying them here. You can also search across multiple collections. It is important to note that relevancy is affected across collections and it is recommended that collections be modeled so that cross-collection searching is not required. As an example, to search across FAQs and Manuals you would use "FAQs|Manuals". JSON Reference: { "collection": "FAQs" } { "collection": "FAQs|Manuals" }
    
    Parameters:
    
    collection - The string representation of a collection query.
    
    Returns:
  - getArea
```
public java.lang.String getArea()
```
    Returns:
    
    The area name
  - setArea
```
public Q setArea(java.lang.String area)
```
    The area you wish to fire against, production, staging, etc... If blank, the default production area will be used. JSON Reference: { "area": "Development" }
    
    Parameters:
    
    area - The area name.
    
    Returns:
  - getRefinementString
```
public java.lang.String getRefinementString()
```
    Returns:
    
    A string representation of all of the currently set refinements
  - getCustomUrlParamsString
```
public java.lang.String getCustomUrlParamsString()
```
    Returns:
    
    A string representation of all of the currently set custom url parameters
  - getCustomUrlParams
```
public java.util.List<CustomUrlParam> getCustomUrlParams()
```
    Returns:
    
    A list of custom url params
  - getBridgeJsonRefinementSearch
```
protected java.lang.String getBridgeJsonRefinementSearch(java.lang.String clientKey)
```
    Parameters:
    
    clientKey - Your client key
    
    Returns:
  - splitRefinements
```
protected java.lang.String[] splitRefinements(java.lang.String refinementString)
```
  - addRefinementsByString
```
public Q addRefinementsByString(java.lang.String refinementString)
```
    A helper method to parse and set refinements. If you pass in refinements of the format Brand=Bose~price:20..80 The query object will correctly parse out the refinements.
    
    Parameters:
    
    refinementString - A tilde separated list of refinements
    
    Returns:
  - addCustomUrlParam
```
public Q addCustomUrlParam(CustomUrlParam customUrlParam)
```
    Sets any additional parameters that can be used to trigger rules. Takes a CustomUrlParam object.
    
    Parameters:
    
    customUrlParam - The parameter to add
    
    Returns:
  - addCustomUrlParam
```
public Q addCustomUrlParam(java.lang.String key,
                           java.lang.String value)
```
    Sets any additional parameters that can be used to trigger rules. Takes a name and a value. JSON Reference: Custom URL parameters separated by ~ in the form: { "customUrlParams": [ { "key": "region", "value": "east" } ] }
    
    Parameters:
    
    key - The parameter key
    
    value - The parameter value
    
    Returns:
  - addCustomUrlParamsByString
```
public Q addCustomUrlParamsByString(java.lang.String values)
```
    Helper method that takes a ~ separated string of additional parameters that can be used to trigger rules. Takes ~ separated name/value list
    
    Parameters:
    
    values - The list of name/values
    
    Returns:
  - getFields
```
public java.util.List<java.lang.String> getFields()
```
    Returns:
    
    A list of fields that will be returned by the engine.
  - addFields
```
public Q addFields(java.lang.String... name)
```
    Specify which fields should be returned on each record that comes back from the engine. You may specify more than one field, if you specify * all fields will be returned. If this parameter is blank the search service will return no attributes with the records. JSON Reference: { "fields": [ "width", "brand", "height" ] }
    
    Parameters:
    
    name - The case-sensitive name of the attribute to return
    
    Returns:
  - getOrFields
```
public java.util.List<java.lang.String> getOrFields()
```
    Returns:
    
    A list of the fields that the search service will treat as OR-able.
  - addOrField
```
public Q addOrField(java.lang.String... name)
```
    Specify which fields should be queried with 'OR' instead of the default 'AND'. This behavior is typically defined in command center on a per navigation basis. However, you can set which fields should be treated as an OR field at the query level if desired. As with normal refinement selections, once you have refined, the list of refinements for that selected navigation will no longer be returned. JSON Reference: { "orFields": [ "field1", "field2" ] }
    
    Parameters:
    
    name - The field that should be treated as OR by the search service before being executed.
    
    Returns:
  - addRangeRefinement
```
public Q addRangeRefinement(java.lang.String navigationName,
                            java.lang.String low,
                            java.lang.String high)
```
    Add a range refinement. Takes a refinement name, a lower and upper bounds.
    
    Parameters:
    
    navigationName - The name of the refinement
    
    low - The low value
    
    high - The high value
    
    Returns:
  - addRangeRefinement
```
public Q addRangeRefinement(java.lang.String navigationName,
                            java.lang.String low,
                            java.lang.String high,
                            boolean exclude)
```
    Add a range refinement. Takes a refinement name, a lower and upper bounds, and whether or not to exclude this refinement.
    
    Parameters:
    
    navigationName - The name of the refinement
    
    low - The low value
    
    high - The high value
    
    exclude - True if the results should exclude this range refinement, false otherwise
    
    Returns:
  - addValueRefinement
```
public Q addValueRefinement(java.lang.String navigationName,
                            java.lang.String value)
```
    Add a value refinement. Takes a refinement name and a value.
    
    Parameters:
    
    navigationName - The name of the navigation
    
    value - The refinement value
    
    Returns:
  - addValueRefinement
```
public Q addValueRefinement(java.lang.String navigationName,
                            java.lang.String value,
                            boolean exclude)
```
    Add a value refinement. Takes a refinement name, a value, and whether or not to exclude this refinement.
    
    Parameters:
    
    navigationName - The name of the navigation
    
    value - The refinement value
    
    exclude - True if the results should exclude this value refinement, false otherwise
    
    Returns:
  - getSkip
```
public long getSkip()
```
    Returns:
    
    The number of documents to skip
  - setSkip
```
public Q setSkip(int skip)
```
    Tell the search service to offset to the Nth record. JSON Reference: { "skip": 400 }
    
    Parameters:
    
    skip - The number of documents to skip
    
    Returns:
  - getPageSize
```
public long getPageSize()
```
    Returns:
    
    The current page size
  - setPageSize
```
public Q setPageSize(int pageSize)
```
    Page size. Default is 10. JSON Reference: { "pageSize": 8 }
    
    Parameters:
    
    pageSize - The number of records to return with the query.
    
    Returns:
  - getNavigations
```
public java.util.Map<java.lang.String,Navigation> getNavigations()
```
    Returns:
    
    A map of the currently set refinements
  - isReturnBinary
```
public boolean isReturnBinary()
```
    Returns:
    
    Is return JSON set to true.
  - setReturnBinary
```
public Q setReturnBinary(boolean returnBinary)
```
    Tells the search service to return binary data. This is enabled by default in the APIs for more efficient transport. To disable this in an API, set this to `false`. JSON Reference: If passed true, informs the search service to return binary data rather than JSON. { "returnBinary": true }
    
    Parameters:
    
    returnBinary - Whether to tell the search service to return binary data rather than JSON.
    
    Returns:
  - getBiasingProfile
```
public java.lang.String getBiasingProfile()
```
    Returns:
    
    The current biasing profile name.
  - setBiasingProfile
```
public Q setBiasingProfile(java.lang.String biasingProfile)
```
    Override the biasing profile used for this query - takes precedence over any biasing profile set in the command center. JSON Reference: { "biasingProfile": "PopularityBias" }
    
    Parameters:
    
    biasingProfile -
    
    Returns:
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns:
    
    The current language filter on the query.
  - setLanguage
```
public Q setLanguage(java.lang.String language)
```
    Sets the language filter on the query and restricts the results to a certain language. If you do not specify a language, english ("lang_en") will be considered the default. An unrecognized language will result in an error. Currently supported languages are: lang_en JSON Reference: { "language": "lang_en" }
    
    Parameters:
    
    language - The value for language restrict
    
    Returns:
  - isPruneRefinements
```
public boolean isPruneRefinements()
```
    Returns:
    
    Are refinements with zero counts being removed.
  - setPruneRefinements
```
public Q setPruneRefinements(boolean pruneRefinements)
```
    Specifies whether refinements should be pruned from the available navigation. A refinement is pruned if the number of results for that refinement is zero. If all refinements from a navigation are pruned, that navigation is also pruned. Defaults to true JSON Reference: { pruneRefinements: false }
    
    Parameters:
    
    pruneRefinements -
    
    Returns:
  - isAutocorrectionDisabled
```
public boolean isAutocorrectionDisabled()
```
    Returns:
    
    Is the auto-correction behavior disabled
  - setDisableAutocorrection
```
public Q setDisableAutocorrection(boolean disableAutocorrection)
```
    Specifies whether the auto-correction behavior should be disabled. By default, when no results are returned for the given query (and there is a did-you-mean available), the first did-you-mean is automatically queried instead. Defaults to false JSON Reference: { "disableAutocorrection": false }
    
    Parameters:
    
    disableAutocorrection -
    
    Returns:
  - setRestrictNavigation
```
public Q setRestrictNavigation(RestrictNavigation restrictNavigation)
```
    Warning This will count as two queries against your search index. Typically, this feature is used when you have a large number of navigation items that will overwhelm the end user. It works by using one of the existing navigation items to decide what the query is about and fires a second query to restrict the navigation to the most relevant set of navigation items for this search term. For example, if you pass in a search of `paper` and a restrict navigation of `category:2` The bridge will find the category navigation refinements in the first query and fire a second query for the top 2 most populous categories. Therefore, a search for something generic like "paper" will bring back top category matches like copy paper (1,030), paper pads (567). The bridge will fire off the second query with the search term, plus an OR refinement with the most likely categories. The navigation items in the first query are entirely replaced with the navigation items in the second query, except for the navigation that was used for the restriction so that users still have the ability to navigate by all category types. JSON Reference: { "restrictNavigation": { "name": "category", "count": 2 } }
    
    Parameters:
    
    restrictNavigation - Restriction criteria
    
    Returns:
    
    this query
  - setRestrictNavigation
```
public Q setRestrictNavigation(java.lang.String name,
                               int count)
```
    Warning This will count as two queries against your search index. Typically, this feature is used when you have a large number of navigation items that will overwhelm the end user. It works by using one of the existing navigation items to decide what the query is about and fires a second query to restrict the navigation to the most relevant set of navigation items for this search term. For example, if you pass in a search of `paper` and a restrict navigation of `category:2` The bridge will find the category navigation refinements in the first query and fire a second query for the top 2 most populous categories. Therefore, a search for something generic like "paper" will bring back top category matches like copy paper (1,030), paper pads (567). The bridge will fire off the second query with the search term, plus an OR refinement with the most likely categories. The navigation items in the first query are entirely replaced with the navigation items in the second query, except for the navigation that was used for the restriction so that users still have the ability to navigate by all category types.
    
    Parameters:
    
    name - the name of the field should be used in the navigation restriction in the second query.
    
    count - the number of fields matches
    
    Returns:
    
    this query

Class AbstractQuery<R extends AbstractRequest<R>,Q extends AbstractQuery<R,Q>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TILDE_REGEX

restrictNavigation

Constructor Detail

AbstractQuery

Method Detail

generateRequest

populateRefinementRequest

convertSort

getBridgeJson

getBridgeRefinementsJson

getQuery

setQuery

getSubCollection

setSubCollection

getCollection

setCollection

getArea

setArea

getRefinementString

getCustomUrlParamsString

getCustomUrlParams

getBridgeJsonRefinementSearch

splitRefinements

addRefinementsByString

addCustomUrlParam

addCustomUrlParam

addCustomUrlParamsByString

getFields

addFields

getOrFields

addOrField

addRangeRefinement

addRangeRefinement

addValueRefinement

addValueRefinement

getSkip

setSkip

getPageSize

setPageSize

getNavigations

isReturnBinary

setReturnBinary

getBiasingProfile

setBiasingProfile

getLanguage

setLanguage

isPruneRefinements

setPruneRefinements

isAutocorrectionDisabled

setDisableAutocorrection

setRestrictNavigation

setRestrictNavigation