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

A

AbstractBridge<RQ extends AbstractRequest<RQ>,Q extends AbstractQuery<RQ,Q>,D extends AbstractRecord<D>,R extends AbstractResults<D,R>> - 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) - 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

AbstractQuery<R extends AbstractRequest<R>,Q extends AbstractQuery<R,Q>> - Class in com.groupbyinc.api

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

Default constructor

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

A Record represents a result from the search engine.

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

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

Request object for the api to send search service requests

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

AbstractResults<R extends AbstractRecord<R>,T extends AbstractResults<R,T>> - Class in com.groupbyinc.api.model

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

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

AbstractUrlBeautifier<RQ extends AbstractRequest<RQ>,Q extends AbstractQuery<RQ,Q>> - Class in com.groupbyinc.util

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

AbstractUrlBeautifier.UrlBeautificationException - Exception in com.groupbyinc.util

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

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

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

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

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

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

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

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

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

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

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

Add a range refinement.

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

Add a range refinement.

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

Set up a mapping for a refinement.

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

A helper method to parse and set refinements.

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

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.AbstractUrlBeautifier

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

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

Add a value refinement.

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

Add a value refinement.

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.AbstractResults

availableNavigation - Variable in class com.groupbyinc.api.model.AbstractResults

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

Default constructor

BaseQuery - Class in com.groupbyinc.api

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

BaseRecord - Class in com.groupbyinc.api.model

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

BaseRequest - Class in com.groupbyinc.api.request

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

BaseResults - Class in com.groupbyinc.api.model

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

biasingProfile - Variable in class com.groupbyinc.api.model.AbstractResults

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

C

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

Clean up all mappings.

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

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

Default constructor

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

Default constructor

clusters - Variable in class com.groupbyinc.api.model.AbstractResults

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

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

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

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

Default constructor

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

correctedQuery - Variable in class com.groupbyinc.api.model.AbstractResults

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.AbstractUrlBeautifier

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

Default constructor

D

DebugInfo - Class in com.groupbyinc.api.model

Created by groupby on 08/04/15.

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

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

didYouMean - Variable in class com.groupbyinc.api.model.AbstractResults

E

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

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

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

errors - Variable in class com.groupbyinc.api.model.AbstractResults

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

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

F

fireRequest(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.AbstractUrlBeautifier

Convert a URI into a query object.

fromUrl(String, Q) - Method in class com.groupbyinc.util.AbstractUrlBeautifier

Convert a URI into a query object.

Functions - Class in com.groupbyinc.api.tags

G

generateRequest() - Method in class com.groupbyinc.api.AbstractQuery

generateRequest() - Method in class com.groupbyinc.api.BaseQuery

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.AbstractRecord

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

Return the current appended URL segment

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

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

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

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

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

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

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

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

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

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.AbstractQuery

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

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

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

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

getClusters() - Method in class com.groupbyinc.api.model.AbstractResults

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.AbstractQuery

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

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

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.AbstractRecord

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

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

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

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.AbstractQuery

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

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

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

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.AbstractRecord

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

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

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.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.AbstractQuery

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.AbstractQuery

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

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

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

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

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

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

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

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

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

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

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.request.AbstractRequest

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

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

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

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.AbstractResults

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.request.AbstractRequest

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

Deprecated.

since 2.0, use getCollection instead.

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

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

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

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

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

The title of this record

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

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

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.AbstractRecord

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

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

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.request.refinement.SelectedRefinementValue

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

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

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

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

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.AbstractQuery

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(AbstractResults<?, ?>, String, String) - Static method in class com.groupbyinc.api.tags.Functions

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

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.request

MatchStrategy() - Constructor for class com.groupbyinc.api.request.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

Default constructor

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

Default constructor

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

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

O

originalQuery - Variable in class com.groupbyinc.api.model.AbstractResults

P

pageInfo - Variable in class com.groupbyinc.api.model.AbstractResults

PageInfo - Class in com.groupbyinc.api.model

Holds information about this page of data.

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

Default constructor

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

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.request

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

populateRefinementRequest() - Method in class com.groupbyinc.api.AbstractQuery

populateRefinementRequest() - Method in class com.groupbyinc.api.BaseQuery

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.AbstractResults

R

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

RecordZone<D extends AbstractRecord<D>> - 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

Default constructor

redirect - Variable in class com.groupbyinc.api.model.AbstractResults

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

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

Default constructor

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

RefinementsRequest<R extends AbstractRequest<R>> - 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

Default constructor

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

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

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

restrictNavigation - Variable in class com.groupbyinc.api.AbstractQuery

RestrictNavigation - Class in com.groupbyinc.api.request

Created by osman on 15/09/14.

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

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

Default constructor

S

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

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

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

selectedNavigation - Variable in class com.groupbyinc.api.model.AbstractResults

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

Default constructor

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

Default constructor

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.AbstractRecord

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

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.AbstractQuery

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

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

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

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

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

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

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.model.AbstractResults

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

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

setClusters(List<Cluster>) - Method in class com.groupbyinc.api.model.AbstractResults

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

The collection to use.

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

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

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

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

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

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

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

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

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

Specifies whether the auto-correction behavior should be disabled.

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

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

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

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

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

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

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.AbstractRequest

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.AbstractRecord

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

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

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

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.AbstractQuery

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

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

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

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

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.request.PartialMatchRule

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

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.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.AbstractRequest

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

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

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

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

Page size.

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

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

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

Specifies whether refinements should be pruned from the available navigation.

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

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

Set a search string.

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

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

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

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

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

setRecords(List<R>) - Method in class com.groupbyinc.api.model.AbstractResults

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

Set a list of cluster records

setRecords(List<D>) - 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.AbstractResults

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

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

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

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

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.AbstractResults

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

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

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

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

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

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.AbstractQuery

Tells the search service to return binary data.

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

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

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

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

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

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

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

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

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

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

Tell the search service to offset to the Nth record.

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

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

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

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

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

Helper method

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

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

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

Deprecated.

since 2.0, use setCollection instead.

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

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

Set the term for this cluster.

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

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

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

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

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

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

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

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.request.refinement.SelectedRefinementValue

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

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

Cleanup HTTP connection pool.

siteParams - Variable in class com.groupbyinc.api.model.AbstractResults

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.AbstractQuery

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

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

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

T

template - Variable in class com.groupbyinc.api.model.AbstractResults

Template - Class in com.groupbyinc.api.model

A template is always returned.

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

Default constructor

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

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

TILDE_REGEX - Static variable in class com.groupbyinc.api.AbstractQuery

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

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

totalRecordCount - Variable in class com.groupbyinc.api.model.AbstractResults

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.AbstractUrlBeautifier

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

U

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

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

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

UrlEncoder - Class in com.groupbyinc.util

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

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

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.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.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.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.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.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

Default constructor

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

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