A B C D E F G H I M N P Q R S T U V Z

A

AbstractBridge - Class in com.groupbyinc.api

The Bridge is the class responsible for marshalling a query to and from the search service.

AbstractBridge(String, String) - Constructor for class com.groupbyinc.api.AbstractBridge

Constructor to create a bridge object that connects to the search api.

AbstractBridge(String, String, boolean, ConnectionConfiguration) - Constructor for class com.groupbyinc.api.AbstractBridge

Constructor to create a bridge object that connects to the search api.

AbstractBridge(String, String, ConnectionConfiguration) - Constructor for class com.groupbyinc.api.AbstractBridge

Constructor to create a bridge object that connects to the search api.

AbstractBridge(String, String, boolean) - Constructor for class com.groupbyinc.api.AbstractBridge

Constructor to create a bridge object that connects to the search api.

AbstractContentZone<T extends AbstractContentZone<T>> - Class in com.groupbyinc.api.model.zone

AbstractContentZone() - Constructor for class com.groupbyinc.api.model.zone.AbstractContentZone

addBias(String, String, Bias.Strength) - Method in class com.groupbyinc.api.Query

addCustomUrlParam(CustomUrlParam) - Method in class com.groupbyinc.api.Query

Sets any additional parameters that can be used to trigger rules.

addCustomUrlParam(String, String) - Method in class com.groupbyinc.api.Query

Sets any additional parameters that can be used to trigger rules.

addCustomUrlParamsByString(String) - Method in class com.groupbyinc.api.Query

Helper method that takes a ~ separated string of additional parameters that can be used to trigger rules.

addExcludedNavigations(String...) - Method in class com.groupbyinc.api.Query

Specify which navigations should not be returned.

addField(List<String>, String...) - Method in class com.groupbyinc.api.Query

addFields(String...) - Method in class com.groupbyinc.api.Query

Specify which fields should be returned on each record that comes back from the engine.

addIncludedNavigations(String...) - Method in class com.groupbyinc.api.Query

Specify which navigations should be returned.

addOrField(String...) - Method in class com.groupbyinc.api.Query

Specify which fields should be queried with 'OR' instead of the default 'AND'.

addQueryUrlParams(String) - Method in class com.groupbyinc.api.Query

addQueryUrlParams(String, String) - Method in class com.groupbyinc.api.Query

addRangeRefinement(String, String, String) - Method in class com.groupbyinc.api.Query

Add a range refinement.

addRangeRefinement(String, String, String, boolean) - Method in class com.groupbyinc.api.Query

Add a range refinement.

addRefinementMapping(char, String) - Method in class com.groupbyinc.util.UrlBeautifier

Set up a mapping for a refinement.

addRefinementsByString(String) - Method in class com.groupbyinc.api.Query

A helper method to parse and set refinements.

addReplacementRule(char, Character) - Method in class com.groupbyinc.util.UrlBeautifier

Adds a new replacement rule that will be applied to the search term and mapped refinements.

addReplacementRule(char, Character, String) - Method in class com.groupbyinc.util.UrlBeautifier

Adds a new replacement rule that will only be applied to the specified refinement.

addRule(PartialMatchRuleInterface) - Method in interface com.groupbyinc.api.interfaces.MatchStrategyInterface

addRule(PartialMatchRuleInterface) - Method in class com.groupbyinc.api.model.MatchStrategy

addRule(PartialMatchRuleInterface) - Method in class com.groupbyinc.api.request.MatchStrategy

addValueRefinement(String, String) - Method in class com.groupbyinc.api.Query

Add a value refinement.

addValueRefinement(String, String, boolean) - Method in class com.groupbyinc.api.Query

Add a value refinement.

addWarning(String) - Method in class com.groupbyinc.api.model.Results

addWarnings(Collection<String>) - Method in class com.groupbyinc.api.model.Results

apply(StringBuilder, int) - Method in class com.groupbyinc.util.UrlReplacement

apply(StringBuilder, int, String, List<UrlReplacement>) - Method in class com.groupbyinc.util.UrlReplacementRule

area - Variable in class com.groupbyinc.api.model.Results

B

BannerZone - Class in com.groupbyinc.api.model.zone

Zone represents an area on the page that merchandisers have control over.

BannerZone() - Constructor for class com.groupbyinc.api.model.zone.BannerZone

Bias - Class in com.groupbyinc.api.model

A bias specifies a field and value to match in a search.

Bias() - Constructor for class com.groupbyinc.api.model.Bias

Bias - Class in com.groupbyinc.api.request

Bias() - Constructor for class com.groupbyinc.api.request.Bias

Bias.Strength - Enum in com.groupbyinc.api.model

Bias.Strength - Enum in com.groupbyinc.api.request

Biasing - Class in com.groupbyinc.api.model

A biasing profile defined at query time.

Biasing() - Constructor for class com.groupbyinc.api.model.Biasing

Biasing - Class in com.groupbyinc.api.request

Biasing() - Constructor for class com.groupbyinc.api.request.Biasing

Bridge - Class in com.groupbyinc.api

Bridge(String, String, int) - Constructor for class com.groupbyinc.api.Bridge

Bridge(String, String, int, boolean) - Constructor for class com.groupbyinc.api.Bridge

Bridge(String, String) - Constructor for class com.groupbyinc.api.Bridge

buildQueryString(List<UrlReplacement>) - Static method in class com.groupbyinc.util.UrlReplacement

C

clearSavedFields() - Method in class com.groupbyinc.util.UrlBeautifier

Clean up all mappings.

clientKey - Variable in class com.groupbyinc.api.AbstractBridge

CloudBridge - Class in com.groupbyinc.api

CloudBridge(String, String) - Constructor for class com.groupbyinc.api.CloudBridge

Constructor to create a bridge object that connects to the search api.

CloudBridge(String, String, ConnectionConfiguration) - Constructor for class com.groupbyinc.api.CloudBridge

Constructor to create a bridge object that connects to the search api.

CLUSTER - Static variable in class com.groupbyinc.api.AbstractBridge

Cluster - Class in com.groupbyinc.api.model

A cluster represents a set of documents that are considered closely related based on a search term.

Cluster() - Constructor for class com.groupbyinc.api.model.Cluster

ClusterRecord - Class in com.groupbyinc.api.model

The Cluster record is a simpler record type than a main record.

ClusterRecord() - Constructor for class com.groupbyinc.api.model.ClusterRecord

COLON - Static variable in class com.groupbyinc.api.AbstractBridge

com.groupbyinc.api - package com.groupbyinc.api

com.groupbyinc.api.config - package com.groupbyinc.api.config

com.groupbyinc.api.interfaces - package com.groupbyinc.api.interfaces

com.groupbyinc.api.model - package com.groupbyinc.api.model

com.groupbyinc.api.model.refinement - package com.groupbyinc.api.model.refinement

com.groupbyinc.api.model.zone - package com.groupbyinc.api.model.zone

com.groupbyinc.api.parser - package com.groupbyinc.api.parser

com.groupbyinc.api.request - package com.groupbyinc.api.request

com.groupbyinc.api.request.refinement - package com.groupbyinc.api.request.refinement

com.groupbyinc.api.tags - package com.groupbyinc.api.tags

com.groupbyinc.injector - package com.groupbyinc.injector

com.groupbyinc.util - package com.groupbyinc.util

ConnectionConfiguration - Class in com.groupbyinc.api.config

ConnectionConfiguration

ConnectionConfiguration() - Constructor for class com.groupbyinc.api.config.ConnectionConfiguration

ConnectionConfiguration(int, int, int) - Constructor for class com.groupbyinc.api.config.ConnectionConfiguration

ConnectionConfiguration(int, int, int, int, int) - Constructor for class com.groupbyinc.api.config.ConnectionConfiguration

contains(Collection<?>, Object) - Static method in class com.groupbyinc.api.tags.Functions

ContentZone - Class in com.groupbyinc.api.model.zone

Zone represents an area on the page that merchandisers have control over.

ContentZone() - Constructor for class com.groupbyinc.api.model.zone.ContentZone

convertBiasing(Biasing) - Static method in class com.groupbyinc.api.Query

convertPartialMatchStrategy(MatchStrategy) - Static method in class com.groupbyinc.api.Query

convertSort(Sort) - Static method in class com.groupbyinc.api.Query

create() - Method in class com.groupbyinc.injector.StaticInjectorFactory

createDebugInfo(Map<String, Object>, Map<String, Object>, Map<String, Object>, Map<String, Object>) - Static method in class com.groupbyinc.api.model.DebugInfo

createQuery() - Method in class com.groupbyinc.util.UrlBeautifier

createUrlBeautifier(String) - Static method in class com.groupbyinc.util.UrlBeautifier

Create a UrlBeautifier and store it for the lifetime of this JVM under the name specified.

CustomUrlParam - Class in com.groupbyinc.api.model

Custom URL Parameters are used to trigger Rules based on any piece of information that IT can pass through the engine.

CustomUrlParam() - Constructor for class com.groupbyinc.api.model.CustomUrlParam

D

DebugInfo - Class in com.groupbyinc.api.model

Created by groupby on 08/04/15.

DebugInfo() - Constructor for class com.groupbyinc.api.model.DebugInfo

debugInfo - Variable in class com.groupbyinc.api.model.RefinementsResult

debugInfo - Variable in class com.groupbyinc.api.model.Results

decode(String) - Static method in class com.groupbyinc.util.UrlEncoder

DEFAULT_CONNECT_TIMEOUT - Static variable in class com.groupbyinc.api.config.ConnectionConfiguration

See connectTimeout

DEFAULT_CONNECTION_REQUEST_TIMEOUT - Static variable in class com.groupbyinc.api.config.ConnectionConfiguration

See connectionRequestTimeout

DEFAULT_MAX_CONNECTIONS - Static variable in class com.groupbyinc.api.config.ConnectionConfiguration

The maximum number of connections that will be opened by the connection pool

DEFAULT_MAX_CONNECTIONS_PER_ROUTE - Static variable in class com.groupbyinc.api.config.ConnectionConfiguration

The maximum number of connections per route that will be opened by the connection pool

DEFAULT_MAX_TRIES - Static variable in class com.groupbyinc.api.AbstractBridge

DEFAULT_RETRY_TIMEOUT - Static variable in class com.groupbyinc.api.AbstractBridge

DEFAULT_SOCKET_TIMEOUT - Static variable in class com.groupbyinc.api.config.ConnectionConfiguration

See socketTimeout

E

encode(String) - Static method in class com.groupbyinc.util.UrlEncoder

epochToIso(String) - Static method in class com.groupbyinc.api.tags.Functions

Deprecated.

epochToIsoDateTime(String) - Static method in class com.groupbyinc.api.tags.Functions

equals(Object) - Method in class com.groupbyinc.util.UrlReplacement

escapeJs(String) - Static method in class com.groupbyinc.api.tags.Functions

F

fireRequest(String, Map<String, String>, String, boolean) - Method in class com.groupbyinc.api.AbstractBridge

fromString(String) - Static method in class com.groupbyinc.util.UrlReplacement

fromUrl(String) - Method in class com.groupbyinc.util.UrlBeautifier

Convert a URI into a query object.

fromUrl(String, Query) - Method in class com.groupbyinc.util.UrlBeautifier

Convert a URI into a query object.

Functions - Class in com.groupbyinc.api.tags

G

generateURI(String, Map<String, String>, int) - Method in class com.groupbyinc.api.AbstractBridge

get() - Method in class com.groupbyinc.injector.GlobalInjector

get() - Method in interface com.groupbyinc.injector.StaticInjector

get() - Method in class com.groupbyinc.injector.ThreadLocalInjector

getAllMeta() - Method in class com.groupbyinc.api.model.Record

getAppend() - Method in class com.groupbyinc.util.UrlBeautifier

Return the current appended URL segment

getArea() - Method in class com.groupbyinc.api.model.Results

getArea() - Method in class com.groupbyinc.api.Query

getArea() - Method in class com.groupbyinc.api.request.Request

getAvailableNavigation() - Method in class com.groupbyinc.api.model.Results

getBannerUrl() - Method in class com.groupbyinc.api.model.zone.BannerZone

getBiases() - Method in class com.groupbyinc.api.model.Biasing

getBiases() - Method in class com.groupbyinc.api.request.Biasing

getBiasing() - Method in class com.groupbyinc.api.Query

getBiasing() - Method in class com.groupbyinc.api.request.Request

getBiasingProfile() - Method in class com.groupbyinc.api.model.Results

getBiasingProfile() - Method in class com.groupbyinc.api.Query

getBiasingProfile() - Method in class com.groupbyinc.api.request.Request

getBridgeJson(String) - Method in class com.groupbyinc.api.Query

Used internally by the bridge object to generate the JSON that is sent to the search service.

getBridgeJsonRefinementSearch(String) - Method in class com.groupbyinc.api.Query

getBridgeRefinementsJson(String, String) - Method in class com.groupbyinc.api.Query

Used internally by the bridge object to generate the JSON that is sent to the search service.

getBridgeRefinementsUrl() - Method in class com.groupbyinc.api.AbstractBridge

getBridgeUrl() - Method in class com.groupbyinc.api.AbstractBridge

getBringToTop() - Method in class com.groupbyinc.api.model.Biasing

getBringToTop() - Method in class com.groupbyinc.api.request.Biasing

getClientKey() - Method in class com.groupbyinc.api.request.Request

getClusterBridgeUrl() - Method in class com.groupbyinc.api.AbstractBridge

getCollection() - Method in class com.groupbyinc.api.model.Record

getCollection() - Method in class com.groupbyinc.api.Query

getCollection() - Method in class com.groupbyinc.api.request.Request

getConnectionRequestTimeout() - Method in class com.groupbyinc.api.config.ConnectionConfiguration

getConnectTimeout() - Method in class com.groupbyinc.api.config.ConnectionConfiguration

getContent() - Method in class com.groupbyinc.api.model.Bias

getContent() - Method in class com.groupbyinc.api.model.zone.AbstractContentZone

getContent() - Method in class com.groupbyinc.api.model.zone.ContentZone

getContent() - Method in class com.groupbyinc.api.request.Bias

getCorrectedQuery() - Method in class com.groupbyinc.api.model.Results

getCount() - Method in class com.groupbyinc.api.model.Refinement

getCount() - Method in class com.groupbyinc.api.model.RefinementMatch.Value

getCount() - Method in class com.groupbyinc.api.request.RestrictNavigation

getCustomUrlParams() - Method in class com.groupbyinc.api.Query

getCustomUrlParams() - Method in class com.groupbyinc.api.request.Request

getCustomUrlParamsString() - Method in class com.groupbyinc.api.Query

getDidYouMean() - Method in class com.groupbyinc.api.model.Results

getDisableAutocorrection() - Method in class com.groupbyinc.api.request.Request

getDisplayName() - Method in class com.groupbyinc.api.model.Navigation

getErrors() - Method in class com.groupbyinc.api.model.RefinementsResult

getErrors() - Method in class com.groupbyinc.api.model.Results

getExclude() - Method in class com.groupbyinc.api.model.Refinement

getExclude() - Method in class com.groupbyinc.api.request.SelectedRefinement

getExcludedNavigations() - Method in class com.groupbyinc.api.request.Request

getExcludeNavigations() - Method in class com.groupbyinc.api.Query

getField() - Method in class com.groupbyinc.api.model.Sort

getField() - Method in class com.groupbyinc.api.request.Sort

getFields() - Method in class com.groupbyinc.api.Query

getFields() - Method in class com.groupbyinc.api.request.Request

getFlag(String) - Static method in class com.groupbyinc.util.PropertyUtils

getHeaders() - Method in class com.groupbyinc.api.AbstractBridge

getHigh() - Method in class com.groupbyinc.api.model.refinement.RefinementRange

getHigh() - Method in class com.groupbyinc.api.request.refinement.SelectedRefinementRange

getId() - Method in class com.groupbyinc.api.model.Navigation

getId() - Method in class com.groupbyinc.api.model.Record

getId() - Method in class com.groupbyinc.api.model.Refinement

getId() - Method in class com.groupbyinc.api.model.Results

getId() - Method in class com.groupbyinc.api.model.Template

getId() - Method in class com.groupbyinc.api.model.Zone

getId() - Method in class com.groupbyinc.api.request.SelectedRefinement

getIncludedNavigations() - Method in class com.groupbyinc.api.request.Request

getIncludeNavigations() - Method in class com.groupbyinc.api.Query

getInfluence() - Method in class com.groupbyinc.api.model.Biasing

getInfluence() - Method in class com.groupbyinc.api.request.Biasing

getKey() - Method in class com.groupbyinc.api.model.CustomUrlParam

getKey() - Method in class com.groupbyinc.api.model.Metadata

getLanguage() - Method in class com.groupbyinc.api.Query

getLanguage() - Method in class com.groupbyinc.api.request.Request

getLow() - Method in class com.groupbyinc.api.model.refinement.RefinementRange

getLow() - Method in class com.groupbyinc.api.request.refinement.SelectedRefinementRange

getMatchStrategy() - Method in class com.groupbyinc.api.model.Results

getMatchStrategy() - Method in class com.groupbyinc.api.Query

getMatchStrategy() - Method in class com.groupbyinc.api.request.Request

getMatchStrategyName() - Method in class com.groupbyinc.api.Query

getMatchStrategyName() - Method in class com.groupbyinc.api.request.Request

getMaxConnections() - Method in class com.groupbyinc.api.config.ConnectionConfiguration

getMaxConnectionsPerRoute() - Method in class com.groupbyinc.api.config.ConnectionConfiguration

getMetadata() - Method in class com.groupbyinc.api.model.Navigation

A list of metadata key-value pairs for a specified navigation item.

getMetaValue(String) - Method in class com.groupbyinc.api.model.Record

getMustMatch() - Method in interface com.groupbyinc.api.interfaces.PartialMatchRuleInterface

getMustMatch() - Method in class com.groupbyinc.api.model.PartialMatchRule

getMustMatch() - Method in class com.groupbyinc.api.request.PartialMatchRule

getName() - Method in class com.groupbyinc.api.model.Bias

getName() - Method in class com.groupbyinc.api.model.MatchStrategy

getName() - Method in class com.groupbyinc.api.model.Navigation

getName() - Method in class com.groupbyinc.api.model.RefinementMatch

getName() - Method in class com.groupbyinc.api.model.Template

getName() - Method in class com.groupbyinc.api.model.Zone

getName() - Method in class com.groupbyinc.api.request.Bias

getName() - Method in class com.groupbyinc.api.request.RestrictNavigation

getNavigation() - Method in class com.groupbyinc.api.model.RefinementsResult

getNavigationName() - Method in class com.groupbyinc.api.request.RefinementsRequest

getNavigationName() - Method in class com.groupbyinc.api.request.SelectedRefinement

getNavigations() - Method in class com.groupbyinc.api.Query

getOrder() - Method in class com.groupbyinc.api.model.Sort

getOrder() - Method in class com.groupbyinc.api.request.Sort

getOrFields() - Method in class com.groupbyinc.api.Query

getOrFields() - Method in class com.groupbyinc.api.request.Request

getOriginalQuery() - Method in class com.groupbyinc.api.model.Results

getOriginalQuery() - Method in class com.groupbyinc.api.request.RefinementsRequest

getOriginalRequest() - Method in class com.groupbyinc.api.model.Results

getPageInfo() - Method in class com.groupbyinc.api.model.Results

getPageSize() - Method in class com.groupbyinc.api.Query

getPageSize() - Method in class com.groupbyinc.api.request.Request

getPercentage() - Method in interface com.groupbyinc.api.interfaces.PartialMatchRuleInterface

getPercentage() - Method in class com.groupbyinc.api.model.PartialMatchRule

getPercentage() - Method in class com.groupbyinc.api.request.PartialMatchRule

getPruneRefinements() - Method in class com.groupbyinc.api.request.Request

getQuery() - Method in class com.groupbyinc.api.model.Results

getQuery() - Method in class com.groupbyinc.api.model.zone.RecordZone

The query that was fired for this zone.

getQuery() - Method in class com.groupbyinc.api.Query

getQuery() - Method in class com.groupbyinc.api.request.Request

getQueryUrlParams() - Method in class com.groupbyinc.api.Query

getQueryUrlParams() - Method in class com.groupbyinc.api.request.Request

getRecordEnd() - Method in class com.groupbyinc.api.model.PageInfo

getRecords() - Method in class com.groupbyinc.api.model.Cluster

getRecords() - Method in class com.groupbyinc.api.model.Results

getRecords() - Method in class com.groupbyinc.api.model.zone.RecordZone

A maximum of ten records will be returned for each record zone.

getRecordStart() - Method in class com.groupbyinc.api.model.PageInfo

getRedirect() - Method in class com.groupbyinc.api.model.Results

Note, if a redirect is triggered the engine does not send back records.

getRefinementMatches() - Method in class com.groupbyinc.api.model.Record

getRefinementQuery() - Method in class com.groupbyinc.api.request.Request

getRefinements() - Method in class com.groupbyinc.api.model.Navigation

getRefinements() - Method in class com.groupbyinc.api.request.Request

getRefinementsQueryParameterName() - Method in class com.groupbyinc.util.UrlBeautifier

getRefinementString() - Method in class com.groupbyinc.api.Query

getRelatedQueries() - Method in class com.groupbyinc.api.model.Results

getRestrictNavigation() - Method in class com.groupbyinc.api.request.Request

getReturnBinary() - Method in class com.groupbyinc.api.request.Request

getRewrites() - Method in class com.groupbyinc.api.model.Results

getRichContent() - Method in class com.groupbyinc.api.model.zone.RichContentZone

getRuleName() - Method in class com.groupbyinc.api.model.Template

getRules() - Method in interface com.groupbyinc.api.interfaces.MatchStrategyInterface

getRules() - Method in class com.groupbyinc.api.model.MatchStrategy

getRules() - Method in class com.groupbyinc.api.request.MatchStrategy

getSelectedNavigation() - Method in class com.groupbyinc.api.model.Results

getSelectedNavigationJson() - Method in class com.groupbyinc.api.model.Results

getSessionId() - Method in class com.groupbyinc.api.Query

getSessionId() - Method in class com.groupbyinc.api.request.Request

getSiteParams() - Method in class com.groupbyinc.api.model.Results

getSkip() - Method in class com.groupbyinc.api.Query

getSkip() - Method in class com.groupbyinc.api.request.Request

getSnippet() - Method in class com.groupbyinc.api.model.ClusterRecord

getSnippet() - Method in class com.groupbyinc.api.model.Record

getSocketTimeout() - Method in class com.groupbyinc.api.config.ConnectionConfiguration

getSort() - Method in class com.groupbyinc.api.model.Navigation

Will return one of the following sort types: Count_Ascending, Count_Descending Value_Ascending, Value_Descending

getSort() - Method in class com.groupbyinc.api.Query

getSort() - Method in class com.groupbyinc.api.request.Request

getStrength() - Method in class com.groupbyinc.api.model.Bias

getStrength() - Method in class com.groupbyinc.api.request.Bias

getSubCollection() - Method in class com.groupbyinc.api.Query

Deprecated.

since 2.0, use getCollection instead.

getTemplate() - Method in class com.groupbyinc.api.model.Results

getTerm() - Method in class com.groupbyinc.api.model.Cluster

getTerms() - Method in interface com.groupbyinc.api.interfaces.PartialMatchRuleInterface

getTerms() - Method in class com.groupbyinc.api.model.PartialMatchRule

getTerms() - Method in class com.groupbyinc.api.request.PartialMatchRule

getTermsGreaterThan() - Method in interface com.groupbyinc.api.interfaces.PartialMatchRuleInterface

getTermsGreaterThan() - Method in class com.groupbyinc.api.model.PartialMatchRule

getTermsGreaterThan() - Method in class com.groupbyinc.api.request.PartialMatchRule

getTitle() - Method in class com.groupbyinc.api.model.ClusterRecord

getTitle() - Method in class com.groupbyinc.api.model.Record

The title of this record

getTotalRecordCount() - Method in class com.groupbyinc.api.model.Results

getType() - Method in class com.groupbyinc.api.model.Navigation

The navigation type: - Value - Range - Dynamic_Range

getType() - Method in class com.groupbyinc.api.model.Refinement

Types are either `Range` or `Value` They represent the objects RefinementRange and RefinementValue

getType() - Method in class com.groupbyinc.api.model.refinement.RefinementRange

getType() - Method in class com.groupbyinc.api.model.refinement.RefinementValue

getType() - Method in class com.groupbyinc.api.model.zone.BannerZone

getType() - Method in class com.groupbyinc.api.model.zone.ContentZone

getType() - Method in class com.groupbyinc.api.model.Zone

Zones support the following content types: Content, Record, Banner, Rich_Content

getType() - Method in class com.groupbyinc.api.model.zone.RecordZone

getType() - Method in class com.groupbyinc.api.model.zone.RichContentZone

getType() - Method in class com.groupbyinc.api.request.refinement.SelectedRefinementRange

getType() - Method in class com.groupbyinc.api.request.refinement.SelectedRefinementValue

getType() - Method in class com.groupbyinc.api.request.SelectedRefinement

Types are either `Range` or `Value` They represent the objects RefinementRange and RefinementValue

getUrl() - Method in class com.groupbyinc.api.model.ClusterRecord

getUrl() - Method in class com.groupbyinc.api.model.Record

This URL is generated by the data upload service and follows the format http://1.com/.html

getUrlBeautifiers() - Static method in class com.groupbyinc.util.UrlBeautifier

Get a map of UrlBeautifiers keyed by name.

getValue() - Method in class com.groupbyinc.api.model.CustomUrlParam

getValue() - Method in class com.groupbyinc.api.model.Metadata

getValue() - Method in class com.groupbyinc.api.model.refinement.RefinementValue

getValue() - Method in class com.groupbyinc.api.model.RefinementMatch.Value

getValue() - Method in class com.groupbyinc.api.request.refinement.SelectedRefinementValue

getValues() - Method in class com.groupbyinc.api.model.RefinementMatch

getVisitorId() - Method in class com.groupbyinc.api.Query

getVisitorId() - Method in class com.groupbyinc.api.request.Request

getWarnings() - Method in class com.groupbyinc.api.model.Results

getZones() - Method in class com.groupbyinc.api.model.Template

GlobalInjector<T> - Class in com.groupbyinc.injector

GlobalInjector() - Constructor for class com.groupbyinc.injector.GlobalInjector

H

handleErrorStatus(String, byte[], boolean) - Method in class com.groupbyinc.api.AbstractBridge

hashCode() - Method in class com.groupbyinc.util.UrlReplacement

HTTP - Static variable in class com.groupbyinc.api.AbstractBridge

HTTPS - Static variable in class com.groupbyinc.api.AbstractBridge

I

id - Variable in class com.groupbyinc.api.model.Results

INJECTOR - Static variable in class com.groupbyinc.util.UrlBeautifier

INSERT_INDICATOR - Static variable in class com.groupbyinc.util.UrlReplacementRule

isAugmentBiases() - Method in class com.groupbyinc.api.model.Biasing

isAugmentBiases() - Method in class com.groupbyinc.api.request.Biasing

isAutocorrectionDisabled() - Method in class com.groupbyinc.api.Query

isIgnored() - Method in class com.groupbyinc.api.model.Navigation

True if this navigation has been ignored.

isMoreRefinements() - Method in class com.groupbyinc.api.model.Navigation

True if this navigation has more refinement values than the ones returned.

isOr() - Method in class com.groupbyinc.api.model.Navigation

If you are using the this object within a JSP you will not be able to reference it directly as `navigation.or` is a reserved field in JSTL.

isPruneRefinements() - Method in class com.groupbyinc.api.Query

isRange() - Method in class com.groupbyinc.api.model.Navigation

isRange() - Method in class com.groupbyinc.api.model.Refinement

isRange() - Method in class com.groupbyinc.api.request.SelectedRefinement

isRefinementSelected(Results, String, String) - Static method in class com.groupbyinc.api.tags.Functions

isReturnBinary() - Method in class com.groupbyinc.api.Query

isWildcardSearchEnabled() - Method in class com.groupbyinc.api.Query

isWildcardSearchEnabled() - Method in class com.groupbyinc.api.request.Request

M

map(InputStream, boolean) - Method in class com.groupbyinc.api.AbstractBridge

mapRefinements(InputStream, boolean) - Method in class com.groupbyinc.api.AbstractBridge

MatchStrategy - Class in com.groupbyinc.api.model

MatchStrategy() - Constructor for class com.groupbyinc.api.model.MatchStrategy

MatchStrategy - Class in com.groupbyinc.api.request

MatchStrategy() - Constructor for class com.groupbyinc.api.request.MatchStrategy

MatchStrategyInterface - Interface in com.groupbyinc.api.interfaces

MatchStrategy

md5(String) - Static method in class com.groupbyinc.api.tags.Functions

Metadata - Class in com.groupbyinc.api.model

Metadata is associated with Navigation objects and Areas and allows the merchandiser, from the command center to add additional information about a navigation or area.

Metadata() - Constructor for class com.groupbyinc.api.model.Metadata

N

Navigation - Class in com.groupbyinc.api.model

The Navigation object represents dynamic navigation sent back from the search engine.

Navigation() - Constructor for class com.groupbyinc.api.model.Navigation

navigation - Variable in class com.groupbyinc.api.model.RefinementsResult

Navigation.Sort - Enum in com.groupbyinc.api.model

Navigation.Type - Enum in com.groupbyinc.api.model

P

PageInfo - Class in com.groupbyinc.api.model

Holds information about this page of data.

PageInfo() - Constructor for class com.groupbyinc.api.model.PageInfo

PARAM_REPLACEMENT - Static variable in class com.groupbyinc.util.UrlBeautifier

parseQueryString(String) - Static method in class com.groupbyinc.util.UrlReplacement

ParserException - Exception in com.groupbyinc.api.parser

ParserException() - Constructor for exception com.groupbyinc.api.parser.ParserException

ParserException(String, Throwable) - Constructor for exception com.groupbyinc.api.parser.ParserException

ParserException(String) - Constructor for exception com.groupbyinc.api.parser.ParserException

ParserException(Throwable) - Constructor for exception com.groupbyinc.api.parser.ParserException

PartialMatchRule - Class in com.groupbyinc.api.model

PartialMatchRule() - Constructor for class com.groupbyinc.api.model.PartialMatchRule

PartialMatchRule - Class in com.groupbyinc.api.request

PartialMatchRule() - Constructor for class com.groupbyinc.api.request.PartialMatchRule

PartialMatchRuleInterface - Interface in com.groupbyinc.api.interfaces

PartialMatchRule

PropertyUtils - Class in com.groupbyinc.util

Created by osman on 18/09/14.

PropertyUtils() - Constructor for class com.groupbyinc.util.PropertyUtils

Q

query - Variable in class com.groupbyinc.api.model.Results

Query - Class in com.groupbyinc.api

Query() - Constructor for class com.groupbyinc.api.Query

R

rawAggregationsRequest - Variable in class com.groupbyinc.api.model.DebugInfo

rawAggregationsResponse - Variable in class com.groupbyinc.api.model.DebugInfo

rawRequest - Variable in class com.groupbyinc.api.model.DebugInfo

rawResponse - Variable in class com.groupbyinc.api.model.DebugInfo

Record - Class in com.groupbyinc.api.model

A Record represents a result from the search engine.

Record() - Constructor for class com.groupbyinc.api.model.Record

records - Variable in class com.groupbyinc.api.model.Results

RecordZone - Class in com.groupbyinc.api.model.zone

Zone represents an area on the page that merchandisers have control over.

RecordZone() - Constructor for class com.groupbyinc.api.model.zone.RecordZone

Refinement<T extends Refinement<T>> - Class in com.groupbyinc.api.model

Abstract Refinement class holding common methods for RefinementRange and RefinementValue.

Refinement() - Constructor for class com.groupbyinc.api.model.Refinement

Refinement.Type - Enum in com.groupbyinc.api.model

RefinementMatch - Class in com.groupbyinc.api.model

Created by groupby on 07/01/15.

RefinementMatch() - Constructor for class com.groupbyinc.api.model.RefinementMatch

RefinementMatch.Value - Class in com.groupbyinc.api.model

RefinementRange - Class in com.groupbyinc.api.model.refinement

A RefinementRange extends Refinement and represents a navigation refinement between two numeric values.

RefinementRange() - Constructor for class com.groupbyinc.api.model.refinement.RefinementRange

refinements(Query, String) - Method in class com.groupbyinc.api.AbstractBridge

Connects to the refinements service, parses the response into a model Retrieves at most 10,000 refinements for the navigation specified.

refinements(RefinementsRequest) - Method in class com.groupbyinc.api.AbstractBridge

RefinementsRequest - Class in com.groupbyinc.api.request

Request object for the api to send search service requests

RefinementsRequest() - Constructor for class com.groupbyinc.api.request.RefinementsRequest

RefinementsResult - Class in com.groupbyinc.api.model

RefinementsResult() - Constructor for class com.groupbyinc.api.model.RefinementsResult

RefinementValue - Class in com.groupbyinc.api.model.refinement

A RefinementValue extends Refinement and represents a navigation refinement that holds a value.

RefinementValue() - Constructor for class com.groupbyinc.api.model.refinement.RefinementValue

RELEVANCE - Static variable in class com.groupbyinc.api.model.Sort

RELEVANCE - Static variable in class com.groupbyinc.api.request.Sort

replaceAll(String, String, String) - Static method in class com.groupbyinc.api.tags.Functions

REPLACEMENT_DELIMITER - Static variable in class com.groupbyinc.util.UrlReplacementRule

Request - Class in com.groupbyinc.api.request

Request object for the api to send search service requests

Request() - Constructor for class com.groupbyinc.api.request.Request

RestrictNavigation - Class in com.groupbyinc.api.request

Created by osman on 15/09/14.

RestrictNavigation() - Constructor for class com.groupbyinc.api.request.RestrictNavigation

Results - Class in com.groupbyinc.api.model

The results object contains a reference to all the objects that come back from the search service.

Results() - Constructor for class com.groupbyinc.api.model.Results

reverse(List<T>) - Static method in class com.groupbyinc.api.tags.Functions

RichContentZone - Class in com.groupbyinc.api.model.zone

Zone represents an area on the page that merchandisers have control over.

RichContentZone() - Constructor for class com.groupbyinc.api.model.zone.RichContentZone

S

search(Query) - Method in class com.groupbyinc.api.AbstractBridge

Connects to the search service, parses the response into a model

search(Request) - Method in class com.groupbyinc.api.AbstractBridge

SEARCH_NAVIGATION_NAME - Static variable in class com.groupbyinc.util.UrlBeautifier

SelectedRefinement<T extends SelectedRefinement<T>> - Class in com.groupbyinc.api.request

Abstract Refinement class holding common methods for RefinementRange and RefinementValue.

SelectedRefinement() - Constructor for class com.groupbyinc.api.request.SelectedRefinement

SelectedRefinement.Type - Enum in com.groupbyinc.api.request

SelectedRefinementRange - Class in com.groupbyinc.api.request.refinement

A RefinementRange extends Refinement and represents a navigation refinement between two numeric values.

SelectedRefinementRange() - Constructor for class com.groupbyinc.api.request.refinement.SelectedRefinementRange

SelectedRefinementValue - Class in com.groupbyinc.api.request.refinement

A RefinementValue extends Refinement and represents a navigation refinement that holds a value.

SelectedRefinementValue() - Constructor for class com.groupbyinc.api.request.refinement.SelectedRefinementValue

set(T) - Method in class com.groupbyinc.injector.GlobalInjector

set(T) - Method in interface com.groupbyinc.injector.StaticInjector

set(T) - Method in class com.groupbyinc.injector.ThreadLocalInjector

setAllMeta(Map<String, Object>) - Method in class com.groupbyinc.api.model.Record

setAppend(String) - Method in class com.groupbyinc.util.UrlBeautifier

Quite often URLs need to end with specific extensions to map to the correct controller in the backend.

setArea(String) - Method in class com.groupbyinc.api.model.Results

setArea(String) - Method in class com.groupbyinc.api.Query

The area you wish to fire against, production, staging, etc...

setArea(String) - Method in class com.groupbyinc.api.request.Request

setAugmentBiases(boolean) - Method in class com.groupbyinc.api.model.Biasing

Set whether the biases defined should override or augment the biases defined in Command Center

setAugmentBiases(boolean) - Method in class com.groupbyinc.api.request.Biasing

setAvailableNavigation(List<Navigation>) - Method in class com.groupbyinc.api.model.Results

setBannerUrl(String) - Method in class com.groupbyinc.api.model.zone.BannerZone

setBiases(List<Bias>) - Method in class com.groupbyinc.api.model.Biasing

Set the list of biases

setBiases(List<Bias>) - Method in class com.groupbyinc.api.request.Biasing

setBiasing(Biasing) - Method in class com.groupbyinc.api.Query

Add a biasing profile, which is defined at query time.

setBiasing(Biasing) - Method in class com.groupbyinc.api.request.Request

setBiasingAugment(boolean) - Method in class com.groupbyinc.api.Query

setBiasingProfile(String) - Method in class com.groupbyinc.api.model.Results

setBiasingProfile(String) - Method in class com.groupbyinc.api.Query

Override the biasing profile used for this query - takes precedence over any biasing profile set in the command center.

setBiasingProfile(String) - Method in class com.groupbyinc.api.request.Request

setBringToTop(List<String>) - Method in class com.groupbyinc.api.model.Biasing

A list of product IDs to bring to the top of the result set.

setBringToTop(String...) - Method in class com.groupbyinc.api.Query

setBringToTop(List<String>) - Method in class com.groupbyinc.api.request.Biasing

setCachingEnabled(boolean) - Method in class com.groupbyinc.api.CloudBridge

If using the semantic layer, this tells the semantic layer to not cache the response.

setClientKey(String) - Method in class com.groupbyinc.api.request.Request

setCollection(String) - Method in class com.groupbyinc.api.model.Record

setCollection(String) - Method in class com.groupbyinc.api.Query

The collection to use.

setCollection(String) - Method in class com.groupbyinc.api.request.Request

setConnectionRequestTimeout(int) - Method in class com.groupbyinc.api.config.ConnectionConfiguration

setConnectTimeout(int) - Method in class com.groupbyinc.api.config.ConnectionConfiguration

setContent(String) - Method in class com.groupbyinc.api.model.Bias

Set the field name to bias on

setContent(String) - Method in class com.groupbyinc.api.model.zone.AbstractContentZone

setContent(String) - Method in class com.groupbyinc.api.model.zone.ContentZone

setContent(String) - Method in class com.groupbyinc.api.request.Bias

setCorrectedQuery(String) - Method in class com.groupbyinc.api.model.Results

setCount(int) - Method in class com.groupbyinc.api.model.Refinement

setCount(Integer) - Method in class com.groupbyinc.api.model.RefinementMatch.Value

setCount(int) - Method in class com.groupbyinc.api.request.RestrictNavigation

setCustomUrlParams(List<CustomUrlParam>) - Method in class com.groupbyinc.api.request.Request

setDidYouMean(List<String>) - Method in class com.groupbyinc.api.model.Results

setDisableAutocorrection(boolean) - Method in class com.groupbyinc.api.Query

Specifies whether the auto-correction behavior should be disabled.

setDisableAutocorrection(Boolean) - Method in class com.groupbyinc.api.request.Request

setDisplayName(String) - Method in class com.groupbyinc.api.model.Navigation

setErrors(String) - Method in class com.groupbyinc.api.model.RefinementsResult

setErrors(String) - Method in class com.groupbyinc.api.model.Results

setExclude(Boolean) - Method in class com.groupbyinc.api.model.Refinement

setExclude(Boolean) - Method in class com.groupbyinc.api.request.SelectedRefinement

setExcludedNavigations(List<String>) - Method in class com.groupbyinc.api.request.Request

setField(String) - Method in class com.groupbyinc.api.model.Sort

setField(String) - Method in class com.groupbyinc.api.request.Sort

setFields(List<String>) - Method in class com.groupbyinc.api.request.Request

setHeaders(List<Header>) - Method in class com.groupbyinc.api.AbstractBridge

Set a list of headers.

setHigh(String) - Method in class com.groupbyinc.api.model.refinement.RefinementRange

setHigh(String) - Method in class com.groupbyinc.api.request.refinement.SelectedRefinementRange

setId(String) - Method in class com.groupbyinc.api.model.Navigation

setId(String) - Method in class com.groupbyinc.api.model.Record

setId(String) - Method in class com.groupbyinc.api.model.Refinement

setId(String) - Method in class com.groupbyinc.api.model.Results

setId(String) - Method in class com.groupbyinc.api.model.Template

setId(String) - Method in class com.groupbyinc.api.model.Zone

setId(String) - Method in class com.groupbyinc.api.request.SelectedRefinement

setIgnored(Boolean) - Method in class com.groupbyinc.api.model.Navigation

setIncludedNavigations(List<String>) - Method in class com.groupbyinc.api.request.Request

setInfluence(Float) - Method in class com.groupbyinc.api.model.Biasing

Set the influence of the biases.

setInfluence(Float) - Method in class com.groupbyinc.api.Query

setInfluence(Float) - Method in class com.groupbyinc.api.request.Biasing

setKey(String) - Method in class com.groupbyinc.api.model.CustomUrlParam

setKey(String) - Method in class com.groupbyinc.api.model.Metadata

setLanguage(String) - Method in class com.groupbyinc.api.Query

Sets the language filter on the query and restricts the results to a certain language.

setLanguage(String) - Method in class com.groupbyinc.api.request.Request

setLow(String) - Method in class com.groupbyinc.api.model.refinement.RefinementRange

setLow(String) - Method in class com.groupbyinc.api.request.refinement.SelectedRefinementRange

setMatchStrategy(MatchStrategy) - Method in class com.groupbyinc.api.model.Results

setMatchStrategy(MatchStrategy) - Method in class com.groupbyinc.api.Query

A match strategy allows you to explicitly manage recall on a per query basis.

setMatchStrategy(MatchStrategy) - Method in class com.groupbyinc.api.request.Request

setMatchStrategyName(String) - Method in class com.groupbyinc.api.Query

Override the match strategy used for this query - takes precedence over any match strategy set in the command center.

setMatchStrategyName(String) - Method in class com.groupbyinc.api.request.Request

setMaxConnections(int) - Method in class com.groupbyinc.api.config.ConnectionConfiguration

setMaxConnectionsPerRoute(int) - Method in class com.groupbyinc.api.config.ConnectionConfiguration

setMaxTries(long) - Method in class com.groupbyinc.api.AbstractBridge

Sets the maximum number of times to try a request before returning an error.

setMetadata(List<Metadata>) - Method in class com.groupbyinc.api.model.Navigation

setMoreRefinements(Boolean) - Method in class com.groupbyinc.api.model.Navigation

setMustMatch(Integer) - Method in class com.groupbyinc.api.model.PartialMatchRule

setMustMatch(Integer) - Method in class com.groupbyinc.api.request.PartialMatchRule

setName(String) - Method in class com.groupbyinc.api.model.Bias

Set the field name to bias on

setName(String) - Method in class com.groupbyinc.api.model.MatchStrategy

setName(String) - Method in class com.groupbyinc.api.model.Navigation

setName(String) - Method in class com.groupbyinc.api.model.RefinementMatch

setName(String) - Method in class com.groupbyinc.api.model.Template

setName(String) - Method in class com.groupbyinc.api.model.Zone

setName(String) - Method in class com.groupbyinc.api.request.Bias

setName(String) - Method in class com.groupbyinc.api.request.RestrictNavigation

setNavigation(Navigation) - Method in class com.groupbyinc.api.model.RefinementsResult

setNavigationName(String) - Method in class com.groupbyinc.api.request.RefinementsRequest

setNavigationName(String) - Method in class com.groupbyinc.api.request.SelectedRefinement

setOr(boolean) - Method in class com.groupbyinc.api.model.Navigation

setOrder(Sort.Order) - Method in class com.groupbyinc.api.model.Sort

Order in which the field will be applied.

setOrder(Sort.Order) - Method in class com.groupbyinc.api.request.Sort

Order in which the field will be applied.

setOrFields(List<String>) - Method in class com.groupbyinc.api.request.Request

setOriginalQuery(String) - Method in class com.groupbyinc.api.model.Results

setOriginalQuery(Request) - Method in class com.groupbyinc.api.request.RefinementsRequest

setOriginalRequest(Request) - Method in class com.groupbyinc.api.model.Results

setPageInfo(PageInfo) - Method in class com.groupbyinc.api.model.Results

setPageSize(int) - Method in class com.groupbyinc.api.Query

Page size.

setPageSize(Integer) - Method in class com.groupbyinc.api.request.Request

setPercentage(Boolean) - Method in class com.groupbyinc.api.model.PartialMatchRule

setPercentage(Boolean) - Method in class com.groupbyinc.api.request.PartialMatchRule

setPruneRefinements(boolean) - Method in class com.groupbyinc.api.Query

Specifies whether refinements should be pruned from the available navigation.

setPruneRefinements(Boolean) - Method in class com.groupbyinc.api.request.Request

setQuery(String) - Method in class com.groupbyinc.api.model.Results

setQuery(String) - Method in class com.groupbyinc.api.model.zone.RecordZone

setQuery(String) - Method in class com.groupbyinc.api.Query

Set a search string.

setQuery(String) - Method in class com.groupbyinc.api.request.Request

setQueryUrlParams(Map<String, String>) - Method in class com.groupbyinc.api.Query

Sets the query level url parameters.

setQueryUrlParams(Map<String, String>) - Method in class com.groupbyinc.api.request.Request

setRange(boolean) - Method in class com.groupbyinc.api.model.Navigation

setRecordEnd(int) - Method in class com.groupbyinc.api.model.PageInfo

setRecords(List<ClusterRecord>) - Method in class com.groupbyinc.api.model.Cluster

Set a list of cluster records

setRecords(List<Record>) - Method in class com.groupbyinc.api.model.Results

setRecords(List<Record>) - Method in class com.groupbyinc.api.model.zone.RecordZone

setRecordStart(int) - Method in class com.groupbyinc.api.model.PageInfo

setRedirect(String) - Method in class com.groupbyinc.api.model.Results

setRefinementMatches(List<RefinementMatch>) - Method in class com.groupbyinc.api.model.Record

setRefinementQuery(String) - Method in class com.groupbyinc.api.request.Request

setRefinements(List<Refinement>) - Method in class com.groupbyinc.api.model.Navigation

setRefinements(List<SelectedRefinement>) - Method in class com.groupbyinc.api.request.Request

setRefinementsQueryParameterName(String) - Method in class com.groupbyinc.util.UrlBeautifier

Sets the name of the query parameter with which non-mapped refinements will show up in the query string.

setRelatedQueries(List<String>) - Method in class com.groupbyinc.api.model.Results

setRestrictNavigation(RestrictNavigation) - Method in class com.groupbyinc.api.Query

Warning This will count as two queries against your search index.

setRestrictNavigation(String, int) - Method in class com.groupbyinc.api.Query

Warning @see Query#setRestrictNavigation(RestrictNavigation).

setRestrictNavigation(RestrictNavigation) - Method in class com.groupbyinc.api.request.Request

setRetryTimeout(long) - Method in class com.groupbyinc.api.AbstractBridge

Sets the retry timeout for a failed request.

setReturnBinary(boolean) - Method in class com.groupbyinc.api.Query

Tells the search service to return binary data.

setReturnBinary(Boolean) - Method in class com.groupbyinc.api.request.Request

setRewrites(List<String>) - Method in class com.groupbyinc.api.model.Results

setRichContent(String) - Method in class com.groupbyinc.api.model.zone.RichContentZone

setRuleName(String) - Method in class com.groupbyinc.api.model.Template

setRules(PartialMatchRule...) - Method in class com.groupbyinc.api.model.MatchStrategy

setRules(List<PartialMatchRule>) - Method in class com.groupbyinc.api.model.MatchStrategy

setRules(List<PartialMatchRule>) - Method in class com.groupbyinc.api.request.MatchStrategy

setSearchMapping(char) - Method in class com.groupbyinc.util.UrlBeautifier

Set the mapping from a search term to a path segment.

setSelectedNavigation(List<Navigation>) - Method in class com.groupbyinc.api.model.Results

setSessionId(String) - Method in class com.groupbyinc.api.Query

A unique string identifier of the session that your customer is currently in.

setSessionId(String) - Method in class com.groupbyinc.api.request.Request

setSiteParams(List<Metadata>) - Method in class com.groupbyinc.api.model.Results

setSkip(int) - Method in class com.groupbyinc.api.Query

Tell the search service to offset by N records.

setSkip(Integer) - Method in class com.groupbyinc.api.request.Request

setSnippet(String) - Method in class com.groupbyinc.api.model.ClusterRecord

setSnippet(String) - Method in class com.groupbyinc.api.model.Record

setSocketTimeout(int) - Method in class com.groupbyinc.api.config.ConnectionConfiguration

setSort(Navigation.Sort) - Method in class com.groupbyinc.api.model.Navigation

setSort(String) - Method in class com.groupbyinc.api.model.Navigation

Helper method

setSort(Sort...) - Method in class com.groupbyinc.api.Query

Specifies the sort order applied to the fields in the order specified.

setSort(Sort...) - Method in class com.groupbyinc.api.request.Request

setSort(List<Sort>) - Method in class com.groupbyinc.api.request.Request

setStrength(String) - Method in class com.groupbyinc.api.model.Bias

Set the field name to bias on

setStrength(Bias.Strength) - Method in class com.groupbyinc.api.model.Bias

setStrength(String) - Method in class com.groupbyinc.api.request.Bias

setStrength(Bias.Strength) - Method in class com.groupbyinc.api.request.Bias

setSubCollection(String) - Method in class com.groupbyinc.api.Query

Deprecated.

since 2.0, use setCollection instead.

setTemplate(Template) - Method in class com.groupbyinc.api.model.Results

setTerm(String) - Method in class com.groupbyinc.api.model.Cluster

Set the term for this cluster.

setTerms(Integer) - Method in class com.groupbyinc.api.model.PartialMatchRule

setTerms(Integer) - Method in class com.groupbyinc.api.request.PartialMatchRule

setTermsGreaterThan(Integer) - Method in class com.groupbyinc.api.model.PartialMatchRule

setTermsGreaterThan(Integer) - Method in class com.groupbyinc.api.request.PartialMatchRule

setTitle(String) - Method in class com.groupbyinc.api.model.ClusterRecord

setTitle(String) - Method in class com.groupbyinc.api.model.Record

setTotalRecordCount(long) - Method in class com.groupbyinc.api.model.Results

setType(Navigation.Type) - Method in class com.groupbyinc.api.model.Navigation

setUrl(String) - Method in class com.groupbyinc.api.model.ClusterRecord

setUrl(String) - Method in class com.groupbyinc.api.model.Record

setValue(String) - Method in class com.groupbyinc.api.model.CustomUrlParam

setValue(String) - Method in class com.groupbyinc.api.model.Metadata

setValue(String) - Method in class com.groupbyinc.api.model.refinement.RefinementValue

setValue(String) - Method in class com.groupbyinc.api.model.RefinementMatch.Value

setValue(String) - Method in class com.groupbyinc.api.request.refinement.SelectedRefinementValue

setValues(List<RefinementMatch.Value>) - Method in class com.groupbyinc.api.model.RefinementMatch

setVisitorId(String) - Method in class com.groupbyinc.api.Query

A unique string identifier of an end customer.

setVisitorId(String) - Method in class com.groupbyinc.api.request.Request

setWarnings(List<String>) - Method in class com.groupbyinc.api.model.Results

setWildcardSearchEnabled(boolean) - Method in class com.groupbyinc.api.Query

Indicate if the *(star) character in the search string should be treated as a wildcard prefix search.

setWildcardSearchEnabled(Boolean) - Method in class com.groupbyinc.api.request.Request

setZones(Map<String, Zone>) - Method in class com.groupbyinc.api.model.Template

shutdown() - Method in class com.groupbyinc.api.AbstractBridge

Cleanup HTTP connection pool.

Sort - Class in com.groupbyinc.api.model

Object that specifies sort field and direction Created by groupby on 11/11/14.

Sort() - Constructor for class com.groupbyinc.api.model.Sort

Sort - Class in com.groupbyinc.api.request

Object that specifies sort field and direction Created by groupby on 11/11/14.

Sort() - Constructor for class com.groupbyinc.api.request.Sort

Sort.Order - Enum in com.groupbyinc.api.model

Sort.Order - Enum in com.groupbyinc.api.request

splitRefinements(String) - Method in class com.groupbyinc.api.Query

StaticInjector<T> - Interface in com.groupbyinc.injector

StaticInjectorFactory<T> - Class in com.groupbyinc.injector

StaticInjectorFactory() - Constructor for class com.groupbyinc.injector.StaticInjectorFactory

T

Template - Class in com.groupbyinc.api.model

A template is always returned.

Template() - Constructor for class com.groupbyinc.api.model.Template

ThreadLocalInjector<T> - Class in com.groupbyinc.injector

ThreadLocalInjector() - Constructor for class com.groupbyinc.injector.ThreadLocalInjector

toString() - Method in class com.groupbyinc.api.request.RestrictNavigation

toString() - Method in class com.groupbyinc.util.UrlReplacement

toTildeString() - Method in class com.groupbyinc.api.model.refinement.RefinementRange

toTildeString() - Method in class com.groupbyinc.api.model.refinement.RefinementValue

toTildeString() - Method in class com.groupbyinc.api.model.Refinement

toTildeString() - Method in class com.groupbyinc.api.request.refinement.SelectedRefinementRange

toTildeString() - Method in class com.groupbyinc.api.request.refinement.SelectedRefinementValue

toTildeString() - Method in class com.groupbyinc.api.request.SelectedRefinement

toUrl(String, String) - Method in class com.groupbyinc.util.UrlBeautifier

Deprecated.

Use #toUrl(String, Map) ()}

toUrl(String, Map<String, Navigation>) - Method in class com.groupbyinc.util.UrlBeautifier

Convert a search term and a list of refinements into a beautified URL.

toUrlAdd(String, String, List<Navigation>, String, Refinement) - Static method in class com.groupbyinc.api.tags.UrlFunctions

toUrlRemove(String, String, List<Navigation>, String, Refinement) - Static method in class com.groupbyinc.api.tags.UrlFunctions

U

uncamel(String) - Static method in class com.groupbyinc.api.tags.Functions

UrlBeautificationException(String) - Constructor for exception com.groupbyinc.util.UrlBeautifier.UrlBeautificationException

UrlBeautificationException(String, Throwable) - Constructor for exception com.groupbyinc.util.UrlBeautifier.UrlBeautificationException

UrlBeautifier - Class in com.groupbyinc.util

UrlBeautifier.UrlBeautificationException - Exception in com.groupbyinc.util

UrlEncoder - Class in com.groupbyinc.util

UrlEncoder() - Constructor for class com.groupbyinc.util.UrlEncoder

UrlFunctions - Class in com.groupbyinc.api.tags

UrlFunctions() - Constructor for class com.groupbyinc.api.tags.UrlFunctions

UrlReplacement - Class in com.groupbyinc.util

UrlReplacement(int, String, UrlReplacement.OperationType) - Constructor for class com.groupbyinc.util.UrlReplacement

UrlReplacement.OperationType - Enum in com.groupbyinc.util

UrlReplacementRule - Class in com.groupbyinc.util

UrlReplacementRule(char, Character, String) - Constructor for class com.groupbyinc.util.UrlReplacementRule

V

Value() - Constructor for class com.groupbyinc.api.model.RefinementMatch.Value

valueOf(String) - Static method in enum com.groupbyinc.api.model.Bias.Strength

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.groupbyinc.api.model.Navigation.Sort

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.groupbyinc.api.model.Navigation.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.groupbyinc.api.model.Refinement.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.groupbyinc.api.model.Sort.Order

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.groupbyinc.api.model.Zone.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.groupbyinc.api.request.Bias.Strength

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.groupbyinc.api.request.SelectedRefinement.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.groupbyinc.api.request.Sort.Order

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.groupbyinc.util.UrlReplacement.OperationType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.groupbyinc.api.model.Bias.Strength

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

values() - Static method in enum com.groupbyinc.api.model.Navigation.Sort

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

values() - Static method in enum com.groupbyinc.api.model.Navigation.Type

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

values() - Static method in enum com.groupbyinc.api.model.Refinement.Type

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

values() - Static method in enum com.groupbyinc.api.model.Sort.Order

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

values() - Static method in enum com.groupbyinc.api.model.Zone.Type

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

values() - Static method in enum com.groupbyinc.api.request.Bias.Strength

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

values() - Static method in enum com.groupbyinc.api.request.SelectedRefinement.Type

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

values() - Static method in enum com.groupbyinc.api.request.Sort.Order

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

values() - Static method in enum com.groupbyinc.util.UrlReplacement.OperationType

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

Z

Zone<Z extends Zone<Z>> - Class in com.groupbyinc.api.model

Zone() - Constructor for class com.groupbyinc.api.model.Zone

Zone.Type - Enum in com.groupbyinc.api.model

A B C D E F G H I M N P Q R S T U V Z