com.sdl.delivery.iq.query.client.rest

Class RestQueryClient

java.lang.Object

com.sdl.delivery.iq.query.client.rest.RestQueryClient

All Implemented Interfaces:

ConfigurationClient, QueryClient

public class RestQueryClient
extends Object
implements QueryClient, ConfigurationClient

RestQueryClient.

Constructor Summary

Constructors

Constructor and Description
RestQueryClient()
RestQueryClient(ApiClient client)

Method Summary

Modifier and Type	Method and Description
void	loadLocaleLanguageConfiguration() Loads locale configuration to the internal cache.
void	registerQueryTransformer(Class<? extends QueryResultData> resultDataClass, Class<? extends QueryResult> resultClass, String transformerName) Registers the query transformer for given type tokens.
<T extends QueryResultData<R>,R extends QueryResult> T	searchById(String index, String id, Class<T> resultSetClass, Class<R> resultClass) Searches a document by Id.
<T extends QueryResultData<R>,R extends QueryResult> T	searchWithCriteria(String index, String criteria, Class<T> resultSetClass, Class<R> resultClass, ResultFilter filter) Searches for documents by the specified criteria.
void	shutdown() Closes any resources hold by client.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestQueryClient

public RestQueryClient()
                throws com.sdl.delivery.configuration.ConfigurationException

Throws:

com.sdl.delivery.configuration.ConfigurationException

RestQueryClient

public RestQueryClient(ApiClient client)

Method Detail

searchById

public <T extends QueryResultData<R>,R extends QueryResult> T searchById(String index,
                                                                         String id,
                                                                         Class<T> resultSetClass,
                                                                         Class<R> resultClass)
                                                                  throws QueryException

Description copied from interface: QueryClient

Searches a document by Id.

Specified by:

searchById in interface QueryClient

Parameters:

index - the search index name.

id - the id.

Returns:

Service response data with query results.

Throws:

QueryException

searchWithCriteria

public <T extends QueryResultData<R>,R extends QueryResult> T searchWithCriteria(String index,
                                                                                 String criteria,
                                                                                 Class<T> resultSetClass,
                                                                                 Class<R> resultClass,
                                                                                 ResultFilter filter)
                                                                          throws QueryException

Description copied from interface: QueryClient

Searches for documents by the specified criteria.

Specified by:

searchWithCriteria in interface QueryClient

Parameters:

index - the search index name.

criteria - the criteria.

filter - The result filter

Returns:

Service response data with query results.

Throws:

QueryException

registerQueryTransformer

public void registerQueryTransformer(Class<? extends QueryResultData> resultDataClass,
                                     Class<? extends QueryResult> resultClass,
                                     String transformerName)

Description copied from interface: QueryClient

Registers the query transformer for given type tokens.

Specified by:

registerQueryTransformer in interface QueryClient

loadLocaleLanguageConfiguration

public void loadLocaleLanguageConfiguration()
                                     throws QueryException

Description copied from interface: ConfigurationClient

Loads locale configuration to the internal cache.

Specified by:

loadLocaleLanguageConfiguration in interface ConfigurationClient

Throws:

QueryException

shutdown

public void shutdown()

Description copied from interface: QueryClient

Closes any resources hold by client.

Specified by:

shutdown in interface QueryClient