- 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) - 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.
- 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
-
- availableNavigation - Variable in class com.groupbyinc.api.model.Results
-
- 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.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.Query
-
- getCollection() - Method in class com.groupbyinc.api.request.Request
-
- 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
-
- getEffectiveGreaterThan() - Method in class com.groupbyinc.api.request.PartialMatchRule
-
- 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
-
- 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.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.request.Request
-
- 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 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.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
-
- 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 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
-
- 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 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
-
- 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
-
- 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
-
- getTemplate() - Method in class com.groupbyinc.api.model.Results
-
- getTerm() - Method in class com.groupbyinc.api.model.Cluster
-
- getTerms() - Method in class com.groupbyinc.api.model.PartialMatchRule
-
- getTerms() - Method in class com.groupbyinc.api.request.PartialMatchRule
-
- 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.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.
- getUserId() - Method in class com.groupbyinc.api.Query
-
- getUserId() - Method in class com.groupbyinc.api.request.Request
-
- 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
-
- 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
-
- search(Query) - 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.UrlBeautifier
-
- selectedNavigation - Variable in class com.groupbyinc.api.model.Results
-
- 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.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
-
- setClientKey(String) - Method in class com.groupbyinc.api.request.Request
-
- setCollection(String) - Method in class com.groupbyinc.api.Query
-
The collection to use.
- setCollection(String) - Method in class com.groupbyinc.api.request.Request
-
- 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
-
- 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.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.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
-
- 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.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
-
- 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.
- 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
-
- 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 to the Nth record.
- 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
-
- setSort(String) - Method in class com.groupbyinc.api.model.Navigation
-
Helper method
- setSort(Navigation.Sort) - Method in class com.groupbyinc.api.model.Navigation
-
- 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
-
- 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
-
- setUrl(String) - Method in class com.groupbyinc.api.model.ClusterRecord
-
- setUrl(String) - Method in class com.groupbyinc.api.model.Record
-
- setUserId(String) - Method in class com.groupbyinc.api.Query
-
An ID that is associated with a user.
- setUserId(String) - Method in class com.groupbyinc.api.request.Request
-
- 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
-
- 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.
- siteParams - Variable in class com.groupbyinc.api.model.Results
-
- 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
-
- 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.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.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.