io.orchestrate.client

Class CollectionSearchResource

java.lang.Object

io.orchestrate.client.CollectionSearchResource

public class CollectionSearchResource
extends java.lang.Object

The resource for the collection search features in the Orchestrate API.

Field Summary

Fields

Modifier and Type	Field and Description
protected OrchestrateClient	client The Orchestrate client to make requests with.
protected JacksonMapper	jacksonMapper
protected com.fasterxml.jackson.databind.ObjectMapper	mapper The object mapper used to deserialize JSON responses.

Method Summary

Modifier and Type	Method and Description
CollectionSearchResource	aggregate(java.lang.String aggregateFields) Apply a collection of aggregate functions to the items matched by this query.
<T> OrchestrateRequest<SearchResults<T>>	get(java.lang.Class<T> clazz, java.lang.String luceneQuery) Retrieve data from the Orchestrate service.
CollectionSearchResource	limit(int limit) The number of search results to get in this query, this value cannot exceed 100.
CollectionSearchResource	offset(int offset) The position in the results list to start retrieving results from, this is useful for paginating results.
CollectionSearchResource	sort(java.lang.String sortFields) Apply sorting to the results in the search query, this will render the relevancy value in the "score" field for the results to be "0.0".
protected byte[]	toJsonBytes(java.lang.Object value)
protected com.fasterxml.jackson.databind.JsonNode	toJsonNode(org.glassfish.grizzly.http.HttpContent response)
protected <T> KvObject<T>	toKvObject(org.glassfish.grizzly.http.HttpContent response, java.lang.String collection, java.lang.String key, java.lang.Class<T> clazz)
protected <T> KvObject<T>	toKvObject(com.fasterxml.jackson.databind.JsonNode result, java.lang.Class<T> clazz)
CollectionSearchResource	withValues(boolean withValues) If withValues is true then the KV objects in the search results will be retrieved with their values.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected final OrchestrateClient client

The Orchestrate client to make requests with.

mapper

protected final com.fasterxml.jackson.databind.ObjectMapper mapper

The object mapper used to deserialize JSON responses.

jacksonMapper

protected final JacksonMapper jacksonMapper

Method Detail

get

public <T> OrchestrateRequest<SearchResults<T>> get(java.lang.Class<T> clazz,
                                                    java.lang.String luceneQuery)

Retrieve data from the Orchestrate service.

Usage:

 
 String luceneQuery = "*";
 SearchResults<String> results1 =
         client.searchCollection("someCollection")
               .limit(10)
               .offset(0)
               .sort("value.name.last:asc")
               .get(String.class, luceneQuery)
               .get();
 
 

Type Parameters:

T - The type to

Parameters:

clazz - Type information for marshalling objects at runtime.

luceneQuery - The lucene search query.

Returns:

The prepared search request.

limit

public CollectionSearchResource limit(int limit)

The number of search results to get in this query, this value cannot exceed 100.

Parameters:

limit - The number of search results in this query.

Returns:

This request.

offset

public CollectionSearchResource offset(int offset)

The position in the results list to start retrieving results from, this is useful for paginating results.

Parameters:

offset - The position to start retrieving results from.

Returns:

This request.

sort

public CollectionSearchResource sort(java.lang.String sortFields)

Apply sorting to the results in the search query, this will render the relevancy value in the "score" field for the results to be "0.0". To specify multiple sort-field names use "," to separate names, in which case the secondary fields will be used as tie-breakers.

client.searchCollection("someCollection") .sort("value.name.last:asc,value.name.first:asc") .get(String.class, "*") .get()

Parameters:

sortFields - The comma separated field names to sort by.

Returns:

This request.

aggregate

public CollectionSearchResource aggregate(java.lang.String aggregateFields)

Apply a collection of aggregate functions to the items matched by this query. Multiple different aggregate functions can be included, by separating them with commas.

client.searchCollection("someCollection") .aggregate("value.cart.items.price:stats,value.inventory.in_stock:range:0~10:10~100:100~*") .get(String.class, "*") .get()

The complete list of aggregate functions is passed into this method as a string. To make sure you use correct syntax, we recommend using the Aggregate class, with its builder functionality.

client.searchCollection("someCollection") .aggregate(Aggregate.builder() .stats("value.cart.items.price") .range( "value.inventory.in_stock", Range.between(0, 10), Range.between(10, 100), Range.above(100) ) .build() ) .get(String.class, "*") .get()

Parameters:

aggregateFields - The comma separated aggregate-function definitions.

Returns:

This request.

withValues

public CollectionSearchResource withValues(boolean withValues)

If withValues is true then the KV objects in the search results will be retrieved with their values. Defaults to true.

Parameters:

withValues - The setting for whether to retrieve KV values.

Returns:

This request.

toJsonBytes

protected byte[] toJsonBytes(java.lang.Object value)

toJsonNode

protected com.fasterxml.jackson.databind.JsonNode toJsonNode(org.glassfish.grizzly.http.HttpContent response)
                                                      throws java.io.IOException

Throws:

java.io.IOException

toKvObject

protected <T> KvObject<T> toKvObject(com.fasterxml.jackson.databind.JsonNode result,
                                     java.lang.Class<T> clazz)
                              throws java.io.IOException

Throws:

java.io.IOException

toKvObject

protected <T> KvObject<T> toKvObject(org.glassfish.grizzly.http.HttpContent response,
                                     java.lang.String collection,
                                     java.lang.String key,
                                     java.lang.Class<T> clazz)
                              throws java.io.IOException

Throws:

java.io.IOException