Package com.loop54.model.request

Class SearchRequest

java.lang.Object

com.loop54.model.request.Request

com.loop54.model.request.ContentRequest

com.loop54.model.request.SearchRequest

public class SearchRequest
extends ContentRequest

This class is used to configure a search request to the Loop54 e-commerce search engine.

Field Summary

Fields

Modifier and Type	Field	Description
final String	query	The search query from the end-user.
final QueryCollectionParameters	relatedQueriesOptions	Parameters for specifying how related queries should be retrieved.
final EntityCollectionParameters	relatedResultsOptions	Parameters for specifying which related results to retrieve.
final EntityCollectionParameters	resultsOptions	Parameters for specifying which direct results to retrieve.
final QueryCollectionParameters	spellingSuggestionsOptions	Parameters for specifying how spelling suggestions should be retrieved.

Fields inherited from class com.loop54.model.request.ContentRequest

contentResultsOptions

Fields inherited from class com.loop54.model.request.Request

customData

Constructor Summary

Constructors

Constructor	Description
SearchRequest(String query)	The search query from the end-user.

Method Summary

Modifier and Type	Method	Description
SearchRequest	withContentResults(String entityType, Consumer<TypedEntityCollectionParameters> configurator)	Chainable variant of ContentRequest.addContentResultsOptions(String): adds the options for a content entity type (or reuses the existing ones) and configures them, e.g.
SearchRequest	withCustomData(String key, Object value)	Chainable variant of Request.addCustomData(String, Object).
SearchRequest	withRelatedQueries(Consumer<QueryCollectionParameters> configurator)	Configures relatedQueriesOptions.
SearchRequest	withRelatedResults(Consumer<EntityCollectionParameters> configurator)	Configures relatedResultsOptions.
SearchRequest	withResults(Consumer<EntityCollectionParameters> configurator)	Configures resultsOptions, e.g.
SearchRequest	withSpellingSuggestions(Consumer<QueryCollectionParameters> configurator)	Configures spellingSuggestionsOptions.

Methods inherited from class com.loop54.model.request.ContentRequest

addContentResultsOptions

Methods inherited from class com.loop54.model.request.Request

addCustomData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

query

public final String query

The search query from the end-user. Can at most be 200 chars long.

resultsOptions

public final EntityCollectionParameters resultsOptions

Parameters for specifying which direct results to retrieve. Such as filtering, faceting, sorting and paging. Only affects the direct results, to modify the related results use relatedResultsOptions.

relatedResultsOptions

public final EntityCollectionParameters relatedResultsOptions

Parameters for specifying which related results to retrieve. Such as filtering, faceting, sorting and paging. Only affects the related results, to modify the direct results use resultsOptions.

spellingSuggestionsOptions

public final QueryCollectionParameters spellingSuggestionsOptions

Parameters for specifying how spelling suggestions should be retrieved. Contains paging and sorting options.

relatedQueriesOptions

public final QueryCollectionParameters relatedQueriesOptions

Parameters for specifying how related queries should be retrieved. Contains paging and sorting options.

Constructor Details

SearchRequest

public SearchRequest(String query)

The search query from the end-user. Can at most be 200 chars long.

Parameters:

query - The query to search for.

Method Details

withResults

public SearchRequest withResults(Consumer<EntityCollectionParameters> configurator)

Configures resultsOptions, e.g. request.withResults(r -> r.page(0, 20).distinctFacet("Category")).

Parameters:

configurator - Applied to resultsOptions.

Returns:

This request, for chaining.

withRelatedResults

public SearchRequest withRelatedResults(Consumer<EntityCollectionParameters> configurator)

Configures relatedResultsOptions.

Parameters:

configurator - Applied to relatedResultsOptions.

Returns:

This request, for chaining.

withSpellingSuggestions

public SearchRequest withSpellingSuggestions(Consumer<QueryCollectionParameters> configurator)

Configures spellingSuggestionsOptions.

Parameters:

configurator - Applied to spellingSuggestionsOptions.

Returns:

This request, for chaining.

withRelatedQueries

public SearchRequest withRelatedQueries(Consumer<QueryCollectionParameters> configurator)

Configures relatedQueriesOptions.

Parameters:

configurator - Applied to relatedQueriesOptions.

Returns:

This request, for chaining.

withContentResults

public SearchRequest withContentResults(String entityType,
 Consumer<TypedEntityCollectionParameters> configurator)

Description copied from class: ContentRequest

Chainable variant of ContentRequest.addContentResultsOptions(String): adds the options for a content entity type (or reuses the existing ones) and configures them, e.g. request.withContentResults("Brand", c -> c.page(0, 3)).

Overrides:

withContentResults in class ContentRequest

Parameters:

entityType - The content entity type to search, e.g. "Brand". Case-sensitive.

configurator - Applied to the parameters of that content entity type.

Returns:

This request, for chaining.

withCustomData

public SearchRequest withCustomData(String key,
 Object value)

Description copied from class: Request

Chainable variant of Request.addCustomData(String, Object). Subclasses override this to return their own type.

Overrides:

withCustomData in class Request

Parameters:

key - Key to set the data on. The keys will be treated as case-sensitive.

value - Value to add to the custom data.

Returns:

This request, for chaining.