com.sdl.delivery.iq.query.client

Class Searcher<T extends QueryResultData<R>,R extends QueryResult>

java.lang.Object

com.sdl.delivery.iq.query.client.Searcher<T,R>

Type Parameters:

T - Type of QueryResultData.

R - Type of QueryResult.

All Implemented Interfaces:

SearcherApi<T,R>

public class Searcher<T extends QueryResultData<R>,R extends QueryResult>
extends Object
implements SearcherApi<T,R>

Generic Searcher. Client entry point.

Method Summary

Modifier and Type	Method and Description
static <T extends QueryResultData<R>,R extends QueryResult> Searcher<T,R>	newSearcher(Class<T> queryResultDataClass, Class<R> queryResultClass)
static <T extends QueryResultData<R>,R extends QueryResult> Searcher<T,R>	newSearcher(QueryClient client, Class<T> queryResultDataClass, Class<R> queryResultClass)
T	search(Criteria criteria) Searches items based on the given criteria.
T	search(String query) Searches items based on the given raw query.
SearcherApi<T,R>	withIndexName(String indexName) Sets the index name to search for.
SearcherApi<T,R>	withResultFilter(ResultFilter filter) Sets the result filter.
SearcherApi<T,R>	withTransformer(String transformer) Sets the transformer.

Methods inherited from class java.lang.Object

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

Method Detail

newSearcher

public static <T extends QueryResultData<R>,R extends QueryResult> Searcher<T,R> newSearcher(Class<T> queryResultDataClass,
                                                                                             Class<R> queryResultClass)
                                                                                      throws QueryException

Throws:

QueryException

newSearcher

public static <T extends QueryResultData<R>,R extends QueryResult> Searcher<T,R> newSearcher(QueryClient client,
                                                                                             Class<T> queryResultDataClass,
                                                                                             Class<R> queryResultClass)
                                                                                      throws QueryException

Throws:

QueryException

withResultFilter

public SearcherApi<T,R> withResultFilter(ResultFilter filter)

Description copied from interface: SearcherApi

Sets the result filter.

Specified by:

withResultFilter in interface SearcherApi<T extends QueryResultData<R>,R extends QueryResult>

Parameters:

filter - the ResultFilter

withIndexName

public SearcherApi<T,R> withIndexName(String indexName)

Description copied from interface: SearcherApi

Sets the index name to search for. Defaults to the index given in udp-client-conf.xml

Specified by:

withIndexName in interface SearcherApi<T extends QueryResultData<R>,R extends QueryResult>

Parameters:

indexName - the index name.

Returns:

the SearcherApi instance

withTransformer

public SearcherApi<T,R> withTransformer(String transformer)

Description copied from interface: SearcherApi

Sets the transformer.

Specified by:

withTransformer in interface SearcherApi<T extends QueryResultData<R>,R extends QueryResult>

Parameters:

transformer - the transformer.

Returns:

the SearcherApi instance

search

public T search(Criteria criteria)
         throws QueryException

Description copied from interface: SearcherApi

Searches items based on the given criteria.

Specified by:

search in interface SearcherApi<T extends QueryResultData<R>,R extends QueryResult>

Parameters:

criteria - a SearchCriteria object.

Returns:

a QueryResultData object.

Throws:

QueryException

search

public T search(String query)
         throws QueryException

Description copied from interface: SearcherApi

Searches items based on the given raw query.

Specified by:

search in interface SearcherApi<T extends QueryResultData<R>,R extends QueryResult>

Parameters:

query - the raw query.

Returns:

a QueryResultData object.

Throws:

QueryException