org.springframework.data.solr.core

Class QueryParserBase<QUERYTPYE extends SolrDataQuery>

java.lang.Object

org.springframework.data.solr.core.QueryParserBase<QUERYTPYE>

All Implemented Interfaces:

QueryParser

Direct Known Subclasses:

DefaultQueryParser, TermsQueryParser

public abstract class QueryParserBase<QUERYTPYE extends SolrDataQuery>
extends Object
implements QueryParser

Base Implementation of QueryParser providing common functions for creating SolrQuery.

Author:

Christoph Strobl, Francisco Spaeth, Radek Mensik, David Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryParserBase.PredicateProcessor QueryParserBase.PredicateProcessor creates a solr reable query string representation for a given Criteria.Predicate

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BOOST
protected GenericConversionService	conversionService
protected static String	CRITERIA_VALUE_SEPERATOR
protected static String	DELIMINATOR
protected static String	NOT

Constructor Summary

Constructors

Constructor and Description
QueryParserBase()

Method Summary

Modifier and Type	Method and Description
void	addPredicateProcessor(QueryParserBase.PredicateProcessor processor) add another QueryParserBase.PredicateProcessor
protected void	appendDefaultOperator(org.apache.solr.client.solrj.SolrQuery solrQuery, Query.Operator defaultOperator) Set q.op parameter for SolrQuery
protected void	appendDefType(org.apache.solr.client.solrj.SolrQuery solrQuery, String defType) Set defType for SolrQuery
protected void	appendPagination(org.apache.solr.client.solrj.SolrQuery query, Integer offset, Integer rows) Append pagination information start, rows to SolrQuery
protected void	appendProjectionOnFields(org.apache.solr.client.solrj.SolrQuery solrQuery, List<Field> fields) Append field list to SolrQuery
protected void	appendRequestHandler(org.apache.solr.client.solrj.SolrQuery solrQuery, String requestHandler) Set request handler parameter for SolrQuery
protected void	appendTimeAllowed(org.apache.solr.client.solrj.SolrQuery solrQuery, Integer timeAllowed) Set SolrQuery.setTimeAllowed(Integer)
org.apache.solr.client.solrj.SolrQuery	constructSolrQuery(SolrDataQuery query) Convert given Query into a SolrQuery executable via SolrClient
protected String	createCalculatedFieldFragment(CalculatedField calculatedField) Create SolrClient readable String representation for CalculatedField.
protected String	createFunctionFragment(Function function, int level) Create SolrClient readable String representation for Function
protected String	createQueryFragmentForCriteria(Criteria part) Creates query string representation of a single critiera
protected String	createQueryStringFromCriteria(Criteria criteria) Iterates criteria list and concats query string fragments to form a valid query string to be used with SolrQuery.setQuery(String)
String	createQueryStringFromNode(Node node)
String	createQueryStringFromNode(Node node, int position)
abstract org.apache.solr.client.solrj.SolrQuery	doConstructSolrQuery(QUERYTPYE query)
String	getQueryString(SolrDataQuery query) Get the queryString to use withSolrQuery.setParam(CommonParams.Q, "queryString"}
protected String	prependJoin(String queryString, SolrDataQuery query) Prepend {@code !
void	registerConverter(Converter<?,?> converter) Register an additional converter for transforming object values to solr readable format

Methods inherited from class java.lang.Object

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

Field Detail

CRITERIA_VALUE_SEPERATOR

protected static final String CRITERIA_VALUE_SEPERATOR

See Also:

Constant Field Values

DELIMINATOR

protected static final String DELIMINATOR

See Also:

Constant Field Values

NOT

protected static final String NOT

See Also:

Constant Field Values

BOOST

protected static final String BOOST

See Also:

Constant Field Values

conversionService

protected final GenericConversionService conversionService

Constructor Detail

QueryParserBase

public QueryParserBase()

Method Detail

getQueryString

public String getQueryString(SolrDataQuery query)

Description copied from interface: QueryParser

Get the queryString to use withSolrQuery.setParam(CommonParams.Q, "queryString"}

Specified by:

getQueryString in interface QueryParser

Returns:

String representation of query without faceting, pagination, projection...

registerConverter

public void registerConverter(Converter<?,?> converter)

Description copied from interface: QueryParser

Register an additional converter for transforming object values to solr readable format

Specified by:

registerConverter in interface QueryParser

addPredicateProcessor

public void addPredicateProcessor(QueryParserBase.PredicateProcessor processor)

add another QueryParserBase.PredicateProcessor

Parameters:

processor -

createQueryStringFromNode

public String createQueryStringFromNode(Node node)

createQueryStringFromNode

public String createQueryStringFromNode(Node node,
                                        int position)

createQueryStringFromCriteria

protected String createQueryStringFromCriteria(Criteria criteria)

Iterates criteria list and concats query string fragments to form a valid query string to be used with SolrQuery.setQuery(String)

Parameters:

criteria -

Returns:

createQueryFragmentForCriteria

protected String createQueryFragmentForCriteria(Criteria part)

Creates query string representation of a single critiera

Parameters:

criteria -

Returns:

createCalculatedFieldFragment

protected String createCalculatedFieldFragment(CalculatedField calculatedField)

Create SolrClient readable String representation for CalculatedField.

Parameters:

calculatedField -

Returns:

Since:

1.1

createFunctionFragment

protected String createFunctionFragment(Function function,
                                        int level)

Create SolrClient readable String representation for Function

Parameters:

function -

Returns:

Since:

1.1

prependJoin

protected String prependJoin(String queryString,
                             SolrDataQuery query)

Prepend !join from= to= to given queryString

Parameters:

queryString -

query -

Returns:

appendPagination

protected void appendPagination(org.apache.solr.client.solrj.SolrQuery query,
                                Integer offset,
                                Integer rows)

Append pagination information start, rows to SolrQuery

Parameters:

query -

offset -

rows -

appendProjectionOnFields

protected void appendProjectionOnFields(org.apache.solr.client.solrj.SolrQuery solrQuery,
                                        List<Field> fields)

Append field list to SolrQuery

Parameters:

solrQuery -

fields -

appendDefaultOperator

protected void appendDefaultOperator(org.apache.solr.client.solrj.SolrQuery solrQuery,
                                     Query.Operator defaultOperator)

Set q.op parameter for SolrQuery

Parameters:

solrQuery -

defaultOperator -

appendTimeAllowed

protected void appendTimeAllowed(org.apache.solr.client.solrj.SolrQuery solrQuery,
                                 Integer timeAllowed)

Set SolrQuery.setTimeAllowed(Integer)

Parameters:

solrQuery -

timeAllowed -

appendDefType

protected void appendDefType(org.apache.solr.client.solrj.SolrQuery solrQuery,
                             String defType)

Set defType for SolrQuery

Parameters:

solrQuery -

defType -

appendRequestHandler

protected void appendRequestHandler(org.apache.solr.client.solrj.SolrQuery solrQuery,
                                    String requestHandler)

Set request handler parameter for SolrQuery

Parameters:

solrQuery -

requestHandler -

constructSolrQuery

public org.apache.solr.client.solrj.SolrQuery constructSolrQuery(SolrDataQuery query)

Description copied from interface: QueryParser

Convert given Query into a SolrQuery executable via SolrClient

Specified by:

constructSolrQuery in interface QueryParser

Returns:

doConstructSolrQuery

public abstract org.apache.solr.client.solrj.SolrQuery doConstructSolrQuery(QUERYTPYE query)