com.sdl.delivery.iq.query.api

Interface SearcherApi<T extends QueryResultData<R>,R extends QueryResult>

Type Parameters:

T - Type of QueryResultData.

R - Type of QueryResult.

All Known Implementing Classes:

DefaultSearcher, Searcher

public interface SearcherApi<T extends QueryResultData<R>,R extends QueryResult>

Searcher. The executing search class.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

withResultFilter

SearcherApi<T,R> withResultFilter(ResultFilter filter)

Sets the result filter.

Parameters:

filter - the ResultFilter

withIndexName

SearcherApi<T,R> withIndexName(String indexName)

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

Parameters:

indexName - the index name.

Returns:

the SearcherApi instance

withTransformer

SearcherApi<T,R> withTransformer(String transformer)

Sets the transformer.

Parameters:

transformer - the transformer.

Returns:

the SearcherApi instance

search

T search(Criteria criteria)
  throws QueryException

Searches items based on the given criteria.

Parameters:

criteria - a SearchCriteria object.

Returns:

a QueryResultData object.

Throws:

QueryException

search

T search(String query)
  throws QueryException

Searches items based on the given raw query.

Parameters:

query - the raw query.

Returns:

a QueryResultData object.

Throws:

QueryException