com.sdl.delivery.iq.query.api

Interface QueryProvider

public interface QueryProvider

Interface for actual communication between query service (or embedded client) and search engine.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	QueryProvider.QueryMergeStrategy Holds the strategies for merging queries.

Method Summary

Modifier and Type	Method and Description
long	countDocuments(String index, String query) Counts the number of documents satisfying the query under given index.
void	createQt(String name, byte[] content) Creates query transformation.
void	deleteQt(String name) Deleted query transformation.
<T extends QueryResultData<R>,R extends QueryResult> T	listDocuments(String index, String transformer) Lists limited number of documents under given index.
<T extends QueryResultData<R>,R extends QueryResult> T	listDocuments(String index, String transformer, int from, int size) Lists documents under given index.
List<String>	listQtNames() Lists the configured query transformations.
<T extends QueryResultData<R>,R extends QueryResult> T	query(String index, List<String> queryList, List<Map<QueryProvider.QueryMergeStrategy,List<String>>> subQueryMap, QueryProvider.QueryMergeStrategy strategy, QueryProvider.QueryMergeStrategy innerListStrategy, QueryFilter filter, String transformer) Merges and interprets given queries and returns back result from query provider.
<T extends QueryResultData<R>,R extends QueryResult> T	query(String index, List<String> queryList, QueryProvider.QueryMergeStrategy strategy, QueryFilter filter, String transformer) Merges and interprets given queries and returns back result from query provider.
<T extends QueryResultData<R>,R extends QueryResult> T	query(String index, Map<QueryProvider.QueryMergeStrategy,List<Map<QueryProvider.QueryMergeStrategy,List<String>>>> subQueryMap, QueryProvider.QueryMergeStrategy strategy, QueryProvider.QueryMergeStrategy innerListStrategy, QueryFilter filter, String transformer) Merges and interprets given queries and returns back result from query provider.
<T extends QueryResultData<R>,R extends QueryResult> T	query(String index, Map<QueryProvider.QueryMergeStrategy,List<String>> subQueryMap, QueryProvider.QueryMergeStrategy strategy, QueryFilter filter, String transformer) Merges and interprets given queries and returns back result from query provider.
<T extends QueryResultData<R>,R extends QueryResult> T	query(String index, QueryProvider.QueryMergeStrategy strategy, List<Map<QueryProvider.QueryMergeStrategy,List<Map<QueryProvider.QueryMergeStrategy,List<String>>>>> queryList, QueryFilter filter, String transformer) Merges and interprets given queries and returns back result from query provider.
<T extends QueryResultData<R>,R extends QueryResult> T	query(String index, String query, QueryFilter filter, String transformer) Interprets given query and returns back result from query provider.
<T extends QueryResultData<R>,R extends QueryResult> T	queryById(String index, String id, String transformer) Searches by id and returns back result from query provider.
<T extends QueryResultData<R>,R extends QueryResult> T	queryByParameters(String index, String query, String mode, QueryFilter filter, String transformer) Searches by field query and returns back result from query provider.

Method Detail

query

<T extends QueryResultData<R>,R extends QueryResult> T query(String index,
                                                             String query,
                                                             QueryFilter filter,
                                                             String transformer)
                                                      throws QueryProviderException

Interprets given query and returns back result from query provider.

Parameters:

index - The index.

query - The compiled query from client.

filter - The The query result filter.

Returns:

The result from query provider.

Throws:

QueryProviderException - If query is not valid or can not connect to provider.

query

<T extends QueryResultData<R>,R extends QueryResult> T query(String index,
                                                             List<String> queryList,
                                                             QueryProvider.QueryMergeStrategy strategy,
                                                             QueryFilter filter,
                                                             String transformer)
                                                      throws QueryProviderException

Merges and interprets given queries and returns back result from query provider.

Parameters:

index - The index.

queryList - The list of queries to be merged.

strategy - The strategy to be used to merge queries.

filter - The The query result filter.

transformer - The transformer.

Returns:

The result from query provider.

Throws:

QueryProviderException - If queries are not valid or can not connect to provider.

query

<T extends QueryResultData<R>,R extends QueryResult> T query(String index,
                                                             Map<QueryProvider.QueryMergeStrategy,List<String>> subQueryMap,
                                                             QueryProvider.QueryMergeStrategy strategy,
                                                             QueryFilter filter,
                                                             String transformer)
                                                      throws QueryProviderException

Merges and interprets given queries and returns back result from query provider.

Parameters:

index - The index.

subQueryMap - The list of sub-queries mapped to different strategies.

strategy - The strategy to be used to merge queries.

filter - The The query result filter.

transformer - The transformer.

Returns:

The result from query provider.

Throws:

QueryProviderException - If queries are not valid or can not connect to provider.

query

<T extends QueryResultData<R>,R extends QueryResult> T query(String index,
                                                             Map<QueryProvider.QueryMergeStrategy,List<Map<QueryProvider.QueryMergeStrategy,List<String>>>> subQueryMap,
                                                             QueryProvider.QueryMergeStrategy strategy,
                                                             QueryProvider.QueryMergeStrategy innerListStrategy,
                                                             QueryFilter filter,
                                                             String transformer)
                                                      throws QueryProviderException

Merges and interprets given queries and returns back result from query provider.

Parameters:

index - The index.

subQueryMap - The list of sub-queries mapped to different strategies.

strategy - The strategy to be used to merge queries.

filter - The The query result filter.

transformer - The transformer.

Returns:

The result from query provider.

Throws:

QueryProviderException - If queries are not valid or can not connect to provider.

query

<T extends QueryResultData<R>,R extends QueryResult> T query(String index,
                                                             QueryProvider.QueryMergeStrategy strategy,
                                                             List<Map<QueryProvider.QueryMergeStrategy,List<Map<QueryProvider.QueryMergeStrategy,List<String>>>>> queryList,
                                                             QueryFilter filter,
                                                             String transformer)
                                                      throws QueryProviderException

Merges and interprets given queries and returns back result from query provider.

Parameters:

index - The index.

strategy - The strategy to be used to merge queries.

queryList - The list of sub-queries mapped to different strategies.

filter - The The query result filter.

transformer - The transformer.

Returns:

The result from query provider.

Throws:

QueryProviderException - If queries are not valid or can not connect to provider.

query

<T extends QueryResultData<R>,R extends QueryResult> T query(String index,
                                                             List<String> queryList,
                                                             List<Map<QueryProvider.QueryMergeStrategy,List<String>>> subQueryMap,
                                                             QueryProvider.QueryMergeStrategy strategy,
                                                             QueryProvider.QueryMergeStrategy innerListStrategy,
                                                             QueryFilter filter,
                                                             String transformer)
                                                      throws QueryProviderException

Merges and interprets given queries and returns back result from query provider.

Parameters:

index - The index.

subQueryMap - The list of sub-queries mapped to different strategies.

strategy - The strategy to be used to merge queries.

filter - The The query result filter.

transformer - The transformer.

Returns:

The result from query provider.

Throws:

QueryProviderException - If queries are not valid or can not connect to provider.

queryById

<T extends QueryResultData<R>,R extends QueryResult> T queryById(String index,
                                                                 String id,
                                                                 String transformer)
                                                          throws QueryProviderException

Searches by id and returns back result from query provider.

Parameters:

index - The index.

id - The id.

transformer - The transformer.

Returns:

The result from query provider.

Throws:

QueryProviderException - If query is not valid or can not connect to provider.

queryByParameters

<T extends QueryResultData<R>,R extends QueryResult> T queryByParameters(String index,
                                                                         String query,
                                                                         String mode,
                                                                         QueryFilter filter,
                                                                         String transformer)
                                                                  throws QueryProviderException

Searches by field query and returns back result from query provider.

Parameters:

index - The index.

query - The field query.

mode - The mode.

filter - The The query result filter.

Returns:

The result from query provider.

Throws:

QueryProviderException - If query is not valid or can not connect to provider.

listQtNames

List<String> listQtNames()
                  throws QueryProviderException

Lists the configured query transformations.

Returns:

The list of transformations.

Throws:

QueryProviderException - If can not retrieve list.

createQt

void createQt(String name,
              byte[] content)
       throws QueryProviderException

Creates query transformation.

Parameters:

name - The name.

content - The content of binary Jar.

Throws:

QueryProviderException - If can not create.

deleteQt

void deleteQt(String name)
       throws QueryProviderException

Deleted query transformation.

Parameters:

name - The name.

Throws:

QueryProviderException - If can not delete.

listDocuments

<T extends QueryResultData<R>,R extends QueryResult> T listDocuments(String index,
                                                                     String transformer)
                                                              throws QueryProviderException

Lists limited number of documents under given index. Uses transformer if present.

Parameters:

index - The index name.

transformer - The transformer (null for default model).

Returns:

The result data.

Throws:

QueryProviderException - If can not list.

listDocuments

<T extends QueryResultData<R>,R extends QueryResult> T listDocuments(String index,
                                                                     String transformer,
                                                                     int from,
                                                                     int size)
                                                              throws QueryProviderException

Lists documents under given index. Uses transformer if present. The from and size parameters define the pagination. Remember that high values of `from` parameter may cause low performance on underlying search provider.

Parameters:

index - The index name.

transformer - The transformer (null for default model).

from - The form index of page.

size - The size of page.

Returns:

The result data.

Throws:

QueryProviderException - If can not list.

countDocuments

long countDocuments(String index,
                    String query)
             throws QueryProviderException

Counts the number of documents satisfying the query under given index.

Parameters:

index - The index.

query - The query. When passed null, method returns the number of all documents.

Returns:

The number of documents.

Throws:

QueryProviderException - If can not get the count.