core.tut.pori.dao

Class SolrQueryBuilder

java.lang.Object

core.tut.pori.dao.SolrQueryBuilder

public class SolrQueryBuilder
extends java.lang.Object

Helper class, which can be used to build a SOLR query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolrQueryBuilder.RequestHandlerType Type of the request handler.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	QUERY_ALL Solr query selector for all items
static char	SEPARATOR_SOLR_FIELD_VALUE Separator for solr fields and values
static char	SOLR_WILD_CARD Solr wild card

Constructor Summary

Constructors

Constructor and Description
SolrQueryBuilder() same as calling the overloaded constructor with parameter null (without relation map)
SolrQueryBuilder(java.util.Map<java.lang.String,java.lang.String> elementFieldMap) Note: the given map is ASSUMED to be escaped and to contain only valid element names and field names

Method Summary

Modifier and Type	Method and Description
void	addCustomFilter(AbstractQueryFilter filter) Add new filter query.
void	addField(java.lang.String field) Add field to be selected in the response.
void	addFields(java.lang.String... fields) Add a list of fields to be selected in the response
void	addSortOption(SortOptions.Option option)
void	clearCustomFilters() clear the list of currently set custom filters
static org.apache.solr.client.solrj.SolrQuery.ORDER	fromOrderDirection(SQLSelectBuilder.OrderDirection direction) Can be used to convert SQL OrderDirection to SOLR ORDER clause.
boolean	isUseExtendedDismax()
void	setLimits(Limits limits)
void	setQueryParameter(QueryParameter queryParameter)
static org.apache.solr.client.solrj.SolrQuery	setRequestHandler(org.apache.solr.client.solrj.SolrQuery query, SolrQueryBuilder.RequestHandlerType type) Helper method to set the correct path for different kinds of request handlers (mainly for suggest-handler)
void	setSortOptions(SortOptions sortOptions)
void	setUseExtendedDismax(boolean useExtendedDismax) Setter for the use of enabling Extended Query Parser (edismax).
org.apache.solr.client.solrj.SolrQuery	toSolrQuery() get an executable SolrQuery from the builder
org.apache.solr.client.solrj.SolrQuery	toSolrQuery(java.lang.String type) Get the query using a specified type parameter for sort and limit operations.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR_SOLR_FIELD_VALUE

public static final char SEPARATOR_SOLR_FIELD_VALUE

Separator for solr fields and values

See Also:

Constant Field Values

QUERY_ALL

public static final java.lang.String QUERY_ALL

Solr query selector for all items

See Also:

Constant Field Values

SOLR_WILD_CARD

public static final char SOLR_WILD_CARD

Solr wild card

See Also:

Constant Field Values

Constructor Detail

SolrQueryBuilder

public SolrQueryBuilder(java.util.Map<java.lang.String,java.lang.String> elementFieldMap)

Note: the given map is ASSUMED to be escaped and to contain only valid element names and field names

Parameters:

elementFieldMap - map of element-solr field relations

SolrQueryBuilder

public SolrQueryBuilder()

same as calling the overloaded constructor with parameter null (without relation map)

Method Detail

setLimits

public void setLimits(Limits limits)

Parameters:

limits - the limits to set

addSortOption

public void addSortOption(SortOptions.Option option)

Parameters:

option -

addField

public void addField(java.lang.String field)

Add field to be selected in the response.

Parameters:

field -

addFields

public void addFields(java.lang.String... fields)

Add a list of fields to be selected in the response

Parameters:

fields -

setQueryParameter

public void setQueryParameter(QueryParameter queryParameter)

Parameters:

queryParameter - the query to set

setSortOptions

public void setSortOptions(SortOptions sortOptions)

Parameters:

sortOptions - the sortOptions to set

isUseExtendedDismax

public boolean isUseExtendedDismax()

Returns:

true if extended dismax is enabled

setUseExtendedDismax

public void setUseExtendedDismax(boolean useExtendedDismax)

Setter for the use of enabling Extended Query Parser (edismax). Setting this true will be using the more user friendly query parser.

Parameters:

useExtendedDismax -

addCustomFilter

public void addCustomFilter(AbstractQueryFilter filter)

Add new filter query.

Parameters:

filter -

clearCustomFilters

public void clearCustomFilters()

clear the list of currently set custom filters

toSolrQuery

public org.apache.solr.client.solrj.SolrQuery toSolrQuery(java.lang.String type)
                                                   throws java.lang.IllegalArgumentException

Get the query using a specified type parameter for sort and limit operations.

Parameters:

type - the type or null

Returns:

new query created with the given parameters using type information

Throws:

java.lang.IllegalArgumentException - on bad query value

toSolrQuery

public org.apache.solr.client.solrj.SolrQuery toSolrQuery()

get an executable SolrQuery from the builder

Returns:

new query created with the given parameters

fromOrderDirection

public static org.apache.solr.client.solrj.SolrQuery.ORDER fromOrderDirection(SQLSelectBuilder.OrderDirection direction)
                                                                       throws java.lang.UnsupportedOperationException

Can be used to convert SQL OrderDirection to SOLR ORDER clause.

Parameters:

direction -

Returns:

the given sql order direction converted to solr order direction

Throws:

java.lang.UnsupportedOperationException

setRequestHandler

public static org.apache.solr.client.solrj.SolrQuery setRequestHandler(org.apache.solr.client.solrj.SolrQuery query,
                                                                       SolrQueryBuilder.RequestHandlerType type)

Helper method to set the correct path for different kinds of request handlers (mainly for suggest-handler)

Parameters:

query -

type -

Returns:

the passed query