de.hybris.platform.solrfacetsearch.search.impl

Class DefaultSolrQueryConverter

java.lang.Object

de.hybris.platform.solrfacetsearch.search.impl.DefaultSolrQueryConverter

All Implemented Interfaces:

SolrQueryConverter

public class DefaultSolrQueryConverter
extends Object
implements SolrQueryConverter

Default Implementation of SolrQueryConverter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultSolrQueryConverter.FacetSort
static class	DefaultSolrQueryConverter.IndexedFacetInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ALL_QUERY
protected static SearchQuery.Operator	DEFAULT_FIELD_OPERATOR

Constructor Summary

Constructors

Constructor and Description
DefaultSolrQueryConverter()

Method Summary

Modifier and Type	Method and Description
protected void	addFacetFields(SolrQuery solrQuery, Map<String,DefaultSolrQueryConverter.IndexedFacetInfo> facetInfoMap)
protected void	addFacetFields(SolrQuery solrQuery, SearchQuery solrSearchQuery)
protected void	addFacetFields(SolrQuery solrQuery, SearchQuery solrSearchQuery, FieldNameProvider solrFieldNameProvider)
protected void	addSolrParams(SolrQuery solrQuery, SearchQuery solrSearchQuery)
protected SolrQuery	applyPostProcessorsInOrder(SolrQuery solrQuery, SearchQuery solrSearchQuery)
protected String	buildQuery(String[] queries, SearchQuery searchQuery)
protected void	checkQuery(SearchQuery solrSearchQuery)
protected String	combine(String[] values, String separator)
protected String[]	convertCoupledQueryFields(SearchQuery searchQuery, List<CoupledQueryField> coupledQueryFields)
protected String[]	convertQueryFields(List<QueryField> queryFields, Map<String,DefaultSolrQueryConverter.IndexedFacetInfo> facetInfoMap) Converts all query fields to the solr query string.
protected String[]	convertRawQueries(SearchQuery searchQuery, List<RawQuery> rawQueries)
SolrQuery	convertSolrQuery(SearchQuery searchQuery) Converts SearchQuery instance into valid SolrQuery.
protected String	escape(String text)
BeanFactory	getBeanFactory()
Integer	getDefaultLimit()
protected Map<String,DefaultSolrQueryConverter.IndexedFacetInfo>	getFacetInfo(SearchQuery searchQuery) Retrieve info about the facet related to the searchQuery
DefaultSolrQueryConverter.FacetSort	getFacetSort()
protected FieldNameTranslator	getFieldNameTranslator()
SearchQuery.Operator	getFieldOperator()
protected IndexedTypeFieldsValuesProvider	getFieldsValuesProvider(IndexedType indexType)
String	getForbiddenChar()
List<SolrQueryPostProcessor>	getQueryPostProcessors()
protected List<CoupledQueryField>	includeCatalogVersionFields(SearchQuery searchQuery) Includes the catalogId and catalogVersion query fields in the SOLR query, based on the SearchQuery.getCatalogVersions().
protected boolean	isFilterQueryField(QueryField queryField, Map<String,DefaultSolrQueryConverter.IndexedFacetInfo> facetInfoMap) Test if the queryField part of qf
protected List<QueryField>	prepareBoostFields(SearchQuery solrSearchQuery)
protected String	prepareQueryField(QueryField field)
protected List<QueryField>	prepareQueryFields(SearchQuery searchQuery)
protected SearchQuery.Operator	resolveOperator(SearchQuery searchQuery)
void	setBeanFactory(BeanFactory beanFactory)
void	setDefaultLimit(Integer defaultLimit)
void	setFacetSort(DefaultSolrQueryConverter.FacetSort facetSort)
void	setFieldNameTranslator(FieldNameTranslator fieldNameTranslator)
void	setFieldOperator(SearchQuery.Operator fieldOperator)
void	setForbiddenChar(String forbiddenChar)
void	setQueryPostProcessors(List<SolrQueryPostProcessor> queryPostProcessors)
protected void	splitQueryFields(List<QueryField> source, List<QueryField> queries, List<QueryField> filterQueries, Map<String,DefaultSolrQueryConverter.IndexedFacetInfo> facetInfoMap) Manage the OR and AND operator in a multi-select search

Methods inherited from class java.lang.Object

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

Field Detail

ALL_QUERY

protected static final String ALL_QUERY

See Also:

Constant Field Values

DEFAULT_FIELD_OPERATOR

protected static final SearchQuery.Operator DEFAULT_FIELD_OPERATOR

Constructor Detail

DefaultSolrQueryConverter

public DefaultSolrQueryConverter()

Method Detail

getFieldNameTranslator

protected FieldNameTranslator getFieldNameTranslator()

setFieldNameTranslator

public void setFieldNameTranslator(FieldNameTranslator fieldNameTranslator)

getQueryPostProcessors

public List<SolrQueryPostProcessor> getQueryPostProcessors()

setQueryPostProcessors

public void setQueryPostProcessors(List<SolrQueryPostProcessor> queryPostProcessors)

getFacetSort

public DefaultSolrQueryConverter.FacetSort getFacetSort()

setFacetSort

public void setFacetSort(DefaultSolrQueryConverter.FacetSort facetSort)

getFieldOperator

public SearchQuery.Operator getFieldOperator()

setFieldOperator

public void setFieldOperator(SearchQuery.Operator fieldOperator)

getDefaultLimit

public Integer getDefaultLimit()

setDefaultLimit

public void setDefaultLimit(Integer defaultLimit)

getForbiddenChar

public String getForbiddenChar()

setForbiddenChar

public void setForbiddenChar(String forbiddenChar)

getBeanFactory

public BeanFactory getBeanFactory()

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Throws:

BeansException

convertSolrQuery

public SolrQuery convertSolrQuery(SearchQuery searchQuery)
                           throws FacetSearchException

Description copied from interface: SolrQueryConverter

Converts SearchQuery instance into valid SolrQuery.

Specified by:

convertSolrQuery in interface SolrQueryConverter

Throws:

FacetSearchException

includeCatalogVersionFields

protected List<CoupledQueryField> includeCatalogVersionFields(SearchQuery searchQuery)

Includes the catalogId and catalogVersion query fields in the SOLR query, based on the SearchQuery.getCatalogVersions().

Returns:

List of CoupledQueryField

buildQuery

protected String buildQuery(String[] queries,
                            SearchQuery searchQuery)

splitQueryFields

protected void splitQueryFields(List<QueryField> source,
                                List<QueryField> queries,
                                List<QueryField> filterQueries,
                                Map<String,DefaultSolrQueryConverter.IndexedFacetInfo> facetInfoMap)

Manage the OR and AND operator in a multi-select search

Parameters:

source -

queries -

filterQueries -

facetInfoMap -

getFacetInfo

protected Map<String,DefaultSolrQueryConverter.IndexedFacetInfo> getFacetInfo(SearchQuery searchQuery)
                                                                       throws FacetSearchException

Retrieve info about the facet related to the searchQuery

Parameters:

searchQuery -

Returns:

Map of IndexedFacetInfo

Throws:

FacetSearchException

escape

protected String escape(String text)

isFilterQueryField

protected boolean isFilterQueryField(QueryField queryField,
                                     Map<String,DefaultSolrQueryConverter.IndexedFacetInfo> facetInfoMap)

Test if the queryField part of qf

Parameters:

queryField -

facetInfoMap -

Returns:

true if the queryField is part of qf query

checkQuery

protected void checkQuery(SearchQuery solrSearchQuery)
                   throws FacetSearchException

Throws:

FacetSearchException

convertQueryFields

protected String[] convertQueryFields(List<QueryField> queryFields,
                                      Map<String,DefaultSolrQueryConverter.IndexedFacetInfo> facetInfoMap)

Converts all query fields to the solr query string. Example: [hardware:cpu, hardware:intel, manufacture:sony(OR), manufacture:ibm(OR)] --> [(hardware:(cpu AND intel)) AND (manufacture:(sony OR ibm))]

Returns:

converted query string

convertCoupledQueryFields

protected String[] convertCoupledQueryFields(SearchQuery searchQuery,
                                             List<CoupledQueryField> coupledQueryFields)

convertRawQueries

protected String[] convertRawQueries(SearchQuery searchQuery,
                                     List<RawQuery> rawQueries)

prepareQueryField

protected String prepareQueryField(QueryField field)

getFieldsValuesProvider

protected IndexedTypeFieldsValuesProvider getFieldsValuesProvider(IndexedType indexType)

addFacetFields

protected void addFacetFields(SolrQuery solrQuery,
                              SearchQuery solrSearchQuery,
                              FieldNameProvider solrFieldNameProvider)
                       throws FacetSearchException

Throws:

FacetSearchException

addFacetFields

protected void addFacetFields(SolrQuery solrQuery,
                              SearchQuery solrSearchQuery)
                       throws FacetSearchException

Throws:

FacetSearchException

addFacetFields

protected void addFacetFields(SolrQuery solrQuery,
                              Map<String,DefaultSolrQueryConverter.IndexedFacetInfo> facetInfoMap)

addSolrParams

protected void addSolrParams(SolrQuery solrQuery,
                             SearchQuery solrSearchQuery)

applyPostProcessorsInOrder

protected SolrQuery applyPostProcessorsInOrder(SolrQuery solrQuery,
                                               SearchQuery solrSearchQuery)

combine

protected String combine(String[] values,
                         String separator)

prepareQueryFields

protected List<QueryField> prepareQueryFields(SearchQuery searchQuery)
                                       throws FacetSearchException

Throws:

FacetSearchException

prepareBoostFields

protected List<QueryField> prepareBoostFields(SearchQuery solrSearchQuery)
                                       throws FacetSearchException

Throws:

FacetSearchException

resolveOperator

protected SearchQuery.Operator resolveOperator(SearchQuery searchQuery)