de.hybris.platform.solrfacetsearch.search

Interface FacetSearchService

All Known Implementing Classes:

DefaultFacetSearchService

public interface FacetSearchService

Implementations of this interface, should be responsible for searching operations.

Method Summary

Modifier and Type	Method and Description
String	convertSearchQueryToString(SearchQuery query) Converts the search query as a string.
SearchQuery	createFreeTextSearchQuery(FacetSearchConfig facetSearchConfig, IndexedType indexedType, String userQuery) Creates the search query, populates, adds free text query fields and user query field
SearchQuery	createFreeTextSearchQueryFromTemplate(FacetSearchConfig facetSearchConfig, IndexedType indexedType, String queryTemplateName, String userQuery) Creates the search query from the template, populates, adds free text query fields and user query field
SearchQuery	createPopulatedSearchQuery(FacetSearchConfig facetSearchConfig, IndexedType indexedType) Creates the search query and populates it
SearchQuery	createSearchQuery(FacetSearchConfig facetSearchConfig, IndexedType indexedType) Creates the search query
SearchQuery	createSearchQueryFromTemplate(FacetSearchConfig facetSearchConfig, IndexedType indexedType, String queryTemplateName) Creates the search query from the template, populates, adds free text query fields and user query field
SearchResult	search(SearchQuery query) Does the search with the specific search query.
SearchResult	search(SearchQuery query, Map<String,String> searchHints) Same as search(SearchQuery) but allows to pass the search hints as parameter.

Method Detail

createSearchQuery

SearchQuery createSearchQuery(FacetSearchConfig facetSearchConfig,
                              IndexedType indexedType)

Creates the search query

Parameters:

facetSearchConfig - the facet search configuration

indexedType - the indexed type

Returns:

the search query

createPopulatedSearchQuery

SearchQuery createPopulatedSearchQuery(FacetSearchConfig facetSearchConfig,
                                       IndexedType indexedType)

Creates the search query and populates it

Parameters:

facetSearchConfig - the facet search configuration

indexedType - the indexed type

Returns:

the search query

createFreeTextSearchQuery

SearchQuery createFreeTextSearchQuery(FacetSearchConfig facetSearchConfig,
                                      IndexedType indexedType,
                                      String userQuery)

Creates the search query, populates, adds free text query fields and user query field

Parameters:

facetSearchConfig - the facet search configuration

indexedType - the indexed type

userQuery - the user query

Returns:

the search query

createSearchQueryFromTemplate

SearchQuery createSearchQueryFromTemplate(FacetSearchConfig facetSearchConfig,
                                          IndexedType indexedType,
                                          String queryTemplateName)

Creates the search query from the template, populates, adds free text query fields and user query field

Parameters:

facetSearchConfig - the facet search configuration

indexedType - the indexed type

queryTemplateName - template name to create a query from

Returns:

the search query

createFreeTextSearchQueryFromTemplate

SearchQuery createFreeTextSearchQueryFromTemplate(FacetSearchConfig facetSearchConfig,
                                                  IndexedType indexedType,
                                                  String queryTemplateName,
                                                  String userQuery)

Creates the search query from the template, populates, adds free text query fields and user query field

Parameters:

facetSearchConfig - the facet search configuration

indexedType - the indexed type

queryTemplateName - template name to create a query from

userQuery - the user query

Returns:

the search query

search

SearchResult search(SearchQuery query)
             throws FacetSearchException

Does the search with the specific search query.

Parameters:

query - the query to be searched

Returns:

the search result of the given query

Throws:

FacetSearchException - throws FacetSearchException if the search query is not correctly configured

search

SearchResult search(SearchQuery query,
                    Map<String,String> searchHints)
             throws FacetSearchException

Same as search(SearchQuery) but allows to pass the search hints as parameter.

Parameters:

query - the query to be searched

searchHints - the search hints

Returns:

the search result of the given query

Throws:

FacetSearchException - throws FacetSearchException if the search query is not correctly configured

convertSearchQueryToString

String convertSearchQueryToString(SearchQuery query)
                           throws FacetSearchException

Converts the search query as a string.

Parameters:

query - the query to be converted

Returns:

converted query as string

Throws:

FacetSearchException - throws FacetSearchException if the search query is not correctly configured