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, Michael Rocke

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(MappingContext<? extends SolrPersistentEntity<?>,SolrPersistentProperty> mappingContext)

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, Long offset, Integer rows) Append pagination information start, rows to SolrQuery
protected void	appendProjectionOnFields(org.apache.solr.client.solrj.SolrQuery solrQuery, List<Field> fields) Deprecated.
protected void	appendProjectionOnFields(org.apache.solr.client.solrj.SolrQuery solrQuery, List<Field> fields, Class<?> domainType) 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, Class<?> domainType) Convert given Query into a SolrQuery executable via SolrClient
protected String	createCalculatedFieldFragment(CalculatedField calculatedField, Class<?> domainType) Create SolrClient readable String representation for CalculatedField.
protected String	createFunctionFragment(Function function, int level, Class<?> domainType) Create SolrClient readable String representation for Function
protected String	createQueryFragmentForCriteria(Criteria part, Class<?> domainType) Creates query string representation of a single critiera.
protected String	createQueryStringFromCriteria(Criteria criteria) Deprecated. since 4.0. Use createQueryStringFromCriteria(Criteria, Class) instead.
protected String	createQueryStringFromCriteria(Criteria criteria, Class<?> domainType) 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) Deprecated. since 4.0. Use createQueryStringFromNode(Node, Class) instead
String	createQueryStringFromNode(Node node, Class<?> domainType) Create the plain query string representation of the given node using mapping information derived from the domain type.
String	createQueryStringFromNode(Node node, int position) Deprecated. since 4.0. Use createQueryStringFromNode(Node, int, Class) instead.
String	createQueryStringFromNode(Node node, int position, Class<?> domainType) Create the plain query string representation of the given node using mapping information derived from the domain type.
abstract org.apache.solr.client.solrj.SolrQuery	doConstructSolrQuery(QUERYTPYE query, Class<?> domainType)
protected String	getMappedFieldName(Field field, Class<?> domainType) Get the mapped field name using meta information derived from the given domain type.
protected String	getMappedFieldName(String fieldName, Class<?> domainType) Get the mapped field name using meta information derived from the given domain type.
String	getQueryString(SolrDataQuery query, Class<?> domainType) Get the queryString to use withSolrQuery.setParam(CommonParams.Q, "queryString"}
protected String	prependJoin(String queryString, SolrDataQuery query, Class<?> domainType) 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

Methods inherited from interface org.springframework.data.solr.core.QueryParser

constructSolrQuery, getQueryString

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(@Nullable
                       MappingContext<? extends SolrPersistentEntity<?>,SolrPersistentProperty> mappingContext)

Parameters:

mappingContext -

Since:

4.0

Method Detail

getQueryString

public String getQueryString(SolrDataQuery query,
                             @Nullable
                             Class<?> domainType)

Description copied from interface: QueryParser

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

Specified by:

getQueryString in interface QueryParser

domainType - used for mapping fields to properties. Can be null.

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

@Deprecated
public String createQueryStringFromNode(Node node)

Deprecated. since 4.0. Use createQueryStringFromNode(Node, Class) instead

Create the plain query string representation of the given node.

Parameters:

node -

Returns:

createQueryStringFromNode

public String createQueryStringFromNode(Node node,
                                        @Nullable
                                        Class<?> domainType)

Create the plain query string representation of the given node using mapping information derived from the domain type.

Parameters:

node -

domainType - can be null.

Returns:

Since:

4.0

createQueryStringFromNode

@Deprecated
public String createQueryStringFromNode(Node node,
                                                    int position)

Deprecated. since 4.0. Use createQueryStringFromNode(Node, int, Class) instead.

Create the plain query string representation of the given node.

Parameters:

node -

Returns:

createQueryStringFromNode

public String createQueryStringFromNode(Node node,
                                        int position,
                                        @Nullable
                                        Class<?> domainType)

Create the plain query string representation of the given node using mapping information derived from the domain type.

Parameters:

node -

position -

domainType - can be null.

Returns:

Since:

4.0

createQueryStringFromCriteria

@Deprecated
protected String createQueryStringFromCriteria(Criteria criteria)

Deprecated. since 4.0. Use createQueryStringFromCriteria(Criteria, Class) instead.

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

Parameters:

criteria -

Returns:

createQueryStringFromCriteria

protected String createQueryStringFromCriteria(Criteria criteria,
                                               @Nullable
                                               Class<?> domainType)

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

Parameters:

criteria -

domainType -

Returns:

Since:

4.0

createQueryFragmentForCriteria

protected String createQueryFragmentForCriteria(Criteria part,
                                                @Nullable
                                                Class<?> domainType)

Creates query string representation of a single critiera.

Parameters:

part -

domainType -

Returns:

getMappedFieldName

protected String getMappedFieldName(Field field,
                                    @Nullable
                                    Class<?> domainType)

Get the mapped field name using meta information derived from the given domain type.

Parameters:

field -

domainType -

Returns:

Since:

4.0

getMappedFieldName

protected String getMappedFieldName(String fieldName,
                                    @Nullable
                                    Class<?> domainType)

Get the mapped field name using meta information derived from the given domain type.

Parameters:

fieldName -

domainType -

Returns:

Since:

4.0

createCalculatedFieldFragment

protected String createCalculatedFieldFragment(CalculatedField calculatedField,
                                               @Nullable
                                               Class<?> domainType)

Create SolrClient readable String representation for CalculatedField.

Parameters:

calculatedField -

Returns:

Since:

1.1

createFunctionFragment

protected String createFunctionFragment(Function function,
                                        int level,
                                        @Nullable
                                        Class<?> domainType)

Create SolrClient readable String representation for Function

Parameters:

function -

Returns:

Since:

1.1

prependJoin

protected String prependJoin(String queryString,
                             @Nullable
                             SolrDataQuery query,
                             @Nullable
                             Class<?> domainType)

Prepend !join from= to= to given queryString

Parameters:

queryString -

query -

domainType -

Returns:

appendPagination

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

Append pagination information start, rows to SolrQuery

Parameters:

query -

offset -

rows -

appendProjectionOnFields

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

Deprecated.

appendProjectionOnFields

protected void appendProjectionOnFields(org.apache.solr.client.solrj.SolrQuery solrQuery,
                                        List<Field> fields,
                                        @Nullable
                                        Class<?> domainType)

Append field list to SolrQuery

Parameters:

solrQuery -

fields -

appendDefaultOperator

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

Set q.op parameter for SolrQuery

Parameters:

solrQuery -

defaultOperator -

appendTimeAllowed

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

Set SolrQuery.setTimeAllowed(Integer)

Parameters:

solrQuery -

timeAllowed -

appendDefType

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

Set defType for SolrQuery

Parameters:

solrQuery -

defType -

appendRequestHandler

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

Set request handler parameter for SolrQuery

Parameters:

solrQuery -

requestHandler -

constructSolrQuery

public org.apache.solr.client.solrj.SolrQuery constructSolrQuery(SolrDataQuery query,
                                                                 @Nullable
                                                                 Class<?> domainType)

Description copied from interface: QueryParser

Convert given Query into a SolrQuery executable via SolrClient

Specified by:

constructSolrQuery in interface QueryParser

domainType - used for mapping fields to properties. Can be null.

Returns:

doConstructSolrQuery

public abstract org.apache.solr.client.solrj.SolrQuery doConstructSolrQuery(QUERYTPYE query,
                                                                            @Nullable
                                                                            Class<?> domainType)