org.eclipse.smila.solr

Class SolrUtils

java.lang.Object

org.eclipse.smila.solr.SolrUtils

public class SolrUtils
extends java.lang.Object

Author:

pwissel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolrUtils.LocalParamsMode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ESCAPE_CHARS
static java.lang.String	ESCAPE_CHARS_WS
static java.lang.String	QUERY_WRAPPER_FILTER The query wrapper filter string.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.StringBuilder	addLocalParams(java.lang.String value, AnyMap localParams)
static java.lang.String	decodeQuery(java.lang.String query) decode a query from application/x-www-form-urlencoded format.
static java.lang.String	encodeQuery(java.lang.String query) Encode a query into application/x-www-form-urlencoded format.
static java.lang.String	escape(java.lang.String string)
static java.lang.String	escape(java.lang.String string, java.lang.String escapeChars)
static java.lang.String	escapeWS(java.lang.String string)
static java.lang.String	getConstQueryOnField(java.lang.String fieldName, java.lang.String constant) return a query string on the given field for a constant which must be searched "as is", i.e. escaping fo chars and wrapping in quotes
static java.lang.String	getPerFieldParameter(java.lang.String fieldName, java.lang.String parameterName)
static java.lang.String	getSolrQueryFilter(java.lang.String luceneFilter) Convert a lucene QueryWrapperFilter to a query filter for solr.
static java.lang.String	getTokenQueryOnField(java.lang.String fieldName, java.lang.String token) returns an escaped query string of the form (<field>:<token>).
static boolean	isErrorResponse(SolrResponseBase response)
static void	parseArrayList(java.util.ArrayList<?> list, AnySeq target, DataFactory factory)
static AnyMap	parseNamedList( list)
static void	parseNamedList( list, AnyMap target)
static void	parseNamedList( list, AnyMap target, DataFactory factory)
static AnyMap	putLocalParam(AnyMap config, java.lang.String param, java.lang.String value, boolean create)
static AnyMap	putLocalParam(AnyMap config, java.lang.String param, java.lang.String value, boolean create, SolrUtils.LocalParamsMode mode)
static java.lang.StringBuilder	writeLocalParams(AnyMap localParams)
static java.lang.StringBuilder	writeLocalParams(java.lang.StringBuilder sb, AnyMap localParams)

Methods inherited from class java.lang.Object

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

Field Detail

ESCAPE_CHARS

public static final java.lang.String ESCAPE_CHARS

See Also:

Constant Field Values

ESCAPE_CHARS_WS

public static final java.lang.String ESCAPE_CHARS_WS

See Also:

Constant Field Values

QUERY_WRAPPER_FILTER

public static final java.lang.String QUERY_WRAPPER_FILTER

The query wrapper filter string.

See Also:

Constant Field Values

Method Detail

isErrorResponse

public static boolean isErrorResponse(SolrResponseBase response)

escape

public static java.lang.String escape(java.lang.String string)

escapeWS

public static java.lang.String escapeWS(java.lang.String string)

escape

public static java.lang.String escape(java.lang.String string,
                      java.lang.String escapeChars)

getPerFieldParameter

public static java.lang.String getPerFieldParameter(java.lang.String fieldName,
                                    java.lang.String parameterName)

writeLocalParams

public static java.lang.StringBuilder writeLocalParams(AnyMap localParams)

writeLocalParams

public static java.lang.StringBuilder writeLocalParams(java.lang.StringBuilder sb,
                                       AnyMap localParams)

addLocalParams

public static java.lang.StringBuilder addLocalParams(java.lang.String value,
                                     AnyMap localParams)

putLocalParam

public static AnyMap putLocalParam(AnyMap config,
                   java.lang.String param,
                   java.lang.String value,
                   boolean create)

putLocalParam

public static AnyMap putLocalParam(AnyMap config,
                   java.lang.String param,
                   java.lang.String value,
                   boolean create,
                   SolrUtils.LocalParamsMode mode)

parseNamedList

public static AnyMap parseNamedList( list)

parseNamedList

public static void parseNamedList( list,
                  AnyMap target)

parseNamedList

public static void parseNamedList( list,
                  AnyMap target,
                  DataFactory factory)

parseArrayList

public static void parseArrayList(java.util.ArrayList<?> list,
                  AnySeq target,
                  DataFactory factory)

getSolrQueryFilter

public static java.lang.String getSolrQueryFilter(java.lang.String luceneFilter)

Convert a lucene QueryWrapperFilter to a query filter for solr.

Parameters:

luceneFilter - the filter.

Returns:

the solr query filter.

getConstQueryOnField

public static java.lang.String getConstQueryOnField(java.lang.String fieldName,
                                    java.lang.String constant)

return a query string on the given field for a constant which must be searched "as is", i.e. escaping fo chars and wrapping in quotes

Parameters:

fieldName - must not contain whitespace, but this is not checked!

constant - the constant

Returns:

the solr query string

getTokenQueryOnField

public static java.lang.String getTokenQueryOnField(java.lang.String fieldName,
                                    java.lang.String token)

returns an escaped query string of the form (<field>:<token>). The given token is fully escaped, i.e. including spaces.

Parameters:

fieldName - must not contain whitespace, but this is not checked!

token - the search token

Returns:

the solr query string

encodeQuery

public static java.lang.String encodeQuery(java.lang.String query)
                                    throws java.io.UnsupportedEncodingException

Encode a query into application/x-www-form-urlencoded format.

Parameters:

query - the query.

Returns:

the urlencoded query.

Throws:

java.io.UnsupportedEncodingException - UnsupportedEncodingException.

decodeQuery

public static java.lang.String decodeQuery(java.lang.String query)
                                    throws java.io.UnsupportedEncodingException

decode a query from application/x-www-form-urlencoded format.

Parameters:

query - the query.

Returns:

the urlencoded query.

Throws:

java.io.UnsupportedEncodingException - UnsupportedEncodingException.