es.prodevelop.pui9.elasticsearch.services.interfaces

Interface IPuiElasticSearchSearchingService

public interface IPuiElasticSearchSearchingService

API to manage the Searches against ElasticSearch

Author:

Marc Gil - mgil@prodevelop.es

Method Summary

Modifier and Type	Method and Description
Long	count(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass, FilterBuilder filterBuilder) Get the number of indexed documents that fits the given filter (language independent)
<V extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> SearchResponse<V>	findForDataGrid(SearchRequest req) Executes a search to be used in the Grid
List<ESSearchResultItem>	findMultiple(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass, FilterBuilder filterBuilder, OrderBuilder orderBuilder, PuiLanguage language) Search for the documents that fits the given filter, in the given order, within the given index (language)
ESSearchResultItem	findOne(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass, FilterBuilder filterBuilder, OrderBuilder orderBuilder, PuiLanguage language) Get a document that fits the given filter, within the given index (language)
<N extends Number> N	getMaxValue(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass, String column, FilterBuilder filterBuilder) Get the maximum value of the given column that fits the given filter

Method Detail

count

Long count(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass,
           FilterBuilder filterBuilder)
    throws PuiElasticSearchSearchException,
           PuiElasticSearchNoNodesException

Get the number of indexed documents that fits the given filter (language independent)

Parameters:

dtoClass - The View DTO Class that represents the View to be searched

filterBuilder - The filter to apply in the search

Returns:

The Number of elements that fits the given filter

Throws:

PuiElasticSearchSearchException - If an error occurs while searching the documents that fits the given filter

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

getMaxValue

<N extends Number> N getMaxValue(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass,
                                 String column,
                                 FilterBuilder filterBuilder)
                          throws PuiElasticSearchSearchException,
                                 PuiElasticSearchNoNodesException

Get the maximum value of the given column that fits the given filter

Parameters:

dtoClass - The View DTO Class that represents the View to be searched

column - The column to search the maximum value

filterBuilder - The filter to apply in the search

Returns:

The maximum value for the given column number (0 is no documents were found)

Throws:

PuiElasticSearchSearchException - If an error occurs while searching the documents that fits the given filter

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

findOne

ESSearchResultItem findOne(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass,
                           FilterBuilder filterBuilder,
                           OrderBuilder orderBuilder,
                           PuiLanguage language)
                    throws PuiElasticSearchSearchException,
                           PuiElasticSearchNoNodesException

Get a document that fits the given filter, within the given index (language)

Parameters:

dtoClass - The View DTO Class that represents the View to be searched

filterBuilder - The filter to apply in the search

orderBuilder - The order of the search

language - The language of the documents (the index is calculated from it)

Returns:

The document from the given index (language) that fits the given filter

Throws:

PuiElasticSearchSearchException - If an error occurs while searching the documents that fits the given filter

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

findMultiple

List<ESSearchResultItem> findMultiple(Class<? extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> dtoClass,
                                      FilterBuilder filterBuilder,
                                      OrderBuilder orderBuilder,
                                      PuiLanguage language)
                               throws PuiElasticSearchSearchException,
                                      PuiElasticSearchNoNodesException

Search for the documents that fits the given filter, in the given order, within the given index (language)

Parameters:

dtoClass - The View DTO Class that represents the View to be searched

filterBuilder - The filter to apply in the search

orderBuilder - The order of the search

language - The language of the documents (the index is calculated from it)

Returns:

The list of document from the given index (language) that fits the given filter, ordered by the given order

Throws:

PuiElasticSearchSearchException - If an error occurs while searching the documents that fits the given filter

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node

findForDataGrid

<V extends es.prodevelop.pui9.model.dto.interfaces.IViewDto> SearchResponse<V> findForDataGrid(SearchRequest req)
                                                                                        throws PuiElasticSearchSearchException,
                                                                                               PuiElasticSearchNoNodesException

Executes a search to be used in the Grid

Parameters:

req - The information of the search

Returns:

The list of documents in SearchResponse format

Throws:

PuiElasticSearchSearchException - If an error occurs while searching the documents that fits the given filter

PuiElasticSearchNoNodesException - If Elastic Search is not connected to any Node