public class SolrPluginUtils extends Object
Utilities that may be of use to RequestHandlers.
Many of these functions have code that was stolen/mutated from StandardRequestHandler.
:TODO: refactor StandardRequestHandler to use these utilities
:TODO: Many "standard" functionality methods are not cognisant of default parameter settings.
Modifier and Type | Class and Description |
---|---|
static class |
SolrPluginUtils.DisjunctionMaxQueryParser
A subclass of SolrQueryParser that supports aliasing fields for
constructing DisjunctionMaxQueries.
|
static class |
SolrPluginUtils.IdentityRegenerator
A CacheRegenerator that can be used whenever the items in the cache
are not dependant on the current searcher.
|
Modifier and Type | Field and Description |
---|---|
static String |
FL
Deprecated.
Use org.apache.solr.common.params.CommonParams.FL.
|
Constructor and Description |
---|
SolrPluginUtils() |
Modifier and Type | Method and Description |
---|---|
static void |
addOrReplaceResults(SolrQueryResponse rsp,
SolrDocumentList docs)
Given a SolrQueryResponse replace the DocList if it is in the result.
|
static SolrDocumentList |
docListToSolrDocumentList(DocList docs,
SolrIndexSearcher searcher,
Set<String> fields,
Map<SolrDocument,Integer> ids)
Convert a DocList to a SolrDocumentList
The optional param "ids" is populated with the lucene document id
for each SolrDocument.
|
static DocList |
doSimpleQuery(String sreq,
SolrQueryRequest req,
int start,
int limit)
Executes a basic query in lucene syntax
|
static NamedList |
doStandardDebug(SolrQueryRequest req,
String userQuery,
Query query,
DocList results)
Returns a NamedList containing many "standard" pieces of debugging
information.
|
static NamedList |
doStandardDebug(SolrQueryRequest req,
String userQuery,
Query query,
DocList results,
CommonParams params)
Deprecated.
Use doStandardDebug(SolrQueryRequest,String,Query,DocList) with setDefaults
|
static NamedList<NamedList<Object>> |
explanationsToNamedLists(NamedList<Explanation> explanations) |
static NamedList<Object> |
explanationToNamedList(Explanation e) |
static void |
flattenBooleanQuery(BooleanQuery to,
BooleanQuery from)
Recursively walks the "from" query pulling out sub-queries and
adding them to the "to" query.
|
static boolean |
getBooleanParam(SolrQueryRequest req,
String param,
boolean def)
Deprecated.
use SolrParam.getBool(String,boolean)
|
static NamedList |
getExplainList(Query query,
DocList docs,
SolrIndexSearcher searcher,
IndexSchema schema)
Deprecated.
this returns the explanations as Strings, instead it
is recommeded to use getExplanations and call toString()
yourself, or use explanationsToNamedLists
|
static NamedList<Explanation> |
getExplanations(Query query,
DocList docs,
SolrIndexSearcher searcher,
IndexSchema schema)
Generates an NamedList of Explanations for each item in a list of docs.
|
static Number |
getNumberParam(SolrQueryRequest req,
String param,
Number def)
Deprecated.
use SolrParam.getFloat(String,float)
|
static String |
getParam(SolrQueryRequest req,
String param,
String def)
Deprecated.
use SolrParam.get(String,String)
|
static Sort |
getSort(SolrQueryRequest req)
Determines the correct Sort based on the request parameter "sort"
|
static void |
invokeSetters(Object bean,
NamedList initArgs) |
static int |
numDocs(SolrIndexSearcher s,
Query q,
Query f)
SolrIndexSearch.numDocs(Query,Query) freaks out if the filtering
query is null, so we use this workarround.
|
static void |
optimizePreFetchDocs(DocList docs,
Query query,
SolrQueryRequest req,
SolrQueryResponse res)
Pre-fetch documents into the index searcher's document cache.
|
static Map<String,Float> |
parseFieldBoosts(String in)
Given a string containing fieldNames and boost info,
converts it to a Map from field name to boost info.
|
static Map<String,Float> |
parseFieldBoosts(String[] fieldLists)
Like
parseFieldBoosts(String) , but parses all the strings
in the provided array (which may be null). |
static List<Query> |
parseFilterQueries(SolrQueryRequest req)
Builds a list of Query objects that should be used to filter results
|
static List<Query> |
parseFuncs(IndexSchema s,
String in)
Deprecated.
|
static List<Query> |
parseQueryStrings(SolrQueryRequest req,
String[] queries)
Turns an array of query strings into a List of Query objects.
|
static CharSequence |
partialEscape(CharSequence s)
Escapes all special characters except '"', '-', and '+'
|
static String |
resolveUpdateChainParam(SolrParams params,
org.slf4j.Logger log)
Deprecated.
|
static void |
setDefaults(SolrQueryRequest req,
SolrParams defaults)
Set defaults on a SolrQueryRequest.
|
static void |
setDefaults(SolrQueryRequest req,
SolrParams defaults,
SolrParams appends,
SolrParams invariants)
Set default-ish params on a SolrQueryRequest.
|
static void |
setMinShouldMatch(BooleanQuery q,
String spec)
Checks the number of optional clauses in the query, and compares it
with the specification string to determine the proper value to use.
|
static int |
setReturnFields(SolrQueryRequest req,
SolrQueryResponse res)
Assumes the standard query param of "fl" to specify the return fields
|
static int |
setReturnFields(String fl,
SolrQueryResponse res)
Given a space seperated list of field names, sets the field list on the
SolrQueryResponse.
|
static String[] |
split(String value)
Split a value that may contain a comma, space of bar separated list.
|
static CharSequence |
stripIllegalOperators(CharSequence s)
Strips operators that are used illegally, otherwise reuturns it's
input.
|
static CharSequence |
stripUnbalancedQuotes(CharSequence s)
Returns it's input if there is an even (ie: balanced) number of
'"' characters -- otherwise returns a String in which all '"'
characters are striped out.
|
@Deprecated public static String FL
public static void setDefaults(SolrQueryRequest req, SolrParams defaults)
public static void setDefaults(SolrQueryRequest req, SolrParams defaults, SolrParams appends, SolrParams invariants)
req
- The request whose params we are interested idefaults
- values to be used if no values are specified in the request paramsappends
- values to be appended to those from the request (or defaults) when dealing with multi-val params, or treated as another layer of defaults for singl-val params.invariants
- values which will be used instead of any request, or default values, regardless of context.public static int numDocs(SolrIndexSearcher s, Query q, Query f) throws IOException
IOException
@Deprecated public static String getParam(SolrQueryRequest req, String param, String def)
@Deprecated public static Number getNumberParam(SolrQueryRequest req, String param, Number def)
@Deprecated public static boolean getBooleanParam(SolrQueryRequest req, String param, boolean def)
public static String[] split(String value)
public static int setReturnFields(SolrQueryRequest req, SolrQueryResponse res)
public static int setReturnFields(String fl, SolrQueryResponse res)
public static void optimizePreFetchDocs(DocList docs, Query query, SolrQueryRequest req, SolrQueryResponse res) throws IOException
IOException
@Deprecated public static NamedList doStandardDebug(SolrQueryRequest req, String userQuery, Query query, DocList results, CommonParams params) throws IOException
Returns a NamedList containing many "standard" pieces of debugging information.
req
- the request we are dealing withuserQuery
- the users query as a string, after any basic
preprocessing has been donequery
- the query built from the userQuery
(and perhaps other clauses) that identifies the main
result set of the response.results
- the main result set of the responseIOException
public static NamedList doStandardDebug(SolrQueryRequest req, String userQuery, Query query, DocList results) throws IOException
Returns a NamedList containing many "standard" pieces of debugging information.
req
- the request we are dealing withuserQuery
- the users query as a string, after any basic
preprocessing has been donequery
- the query built from the userQuery
(and perhaps other clauses) that identifies the main
result set of the response.results
- the main result set of the responseIOException
public static NamedList<Object> explanationToNamedList(Explanation e)
public static NamedList<NamedList<Object>> explanationsToNamedLists(NamedList<Explanation> explanations)
public static NamedList<Explanation> getExplanations(Query query, DocList docs, SolrIndexSearcher searcher, IndexSchema schema) throws IOException
query
- The Query you want explanations in the context ofdocs
- The Documents you want explained relative that queryIOException
@Deprecated public static NamedList getExplainList(Query query, DocList docs, SolrIndexSearcher searcher, IndexSchema schema) throws IOException
query
- The Query you want explanations in the context ofdocs
- The Documents you want explained relative that queryIOException
public static DocList doSimpleQuery(String sreq, SolrQueryRequest req, int start, int limit) throws IOException
IOException
public static Map<String,Float> parseFieldBoosts(String in)
Doesn't care if boost info is negative, you're on your own.
Doesn't care if boost info is missing, again: you're on your own.
in
- a String like "fieldOne^2.3 fieldTwo fieldThree^-0.4"public static Map<String,Float> parseFieldBoosts(String[] fieldLists)
parseFieldBoosts(String)
, but parses all the strings
in the provided array (which may be null).fieldLists
- an array of Strings eg. {"fieldOne^2.3", "fieldTwo", fieldThree^-0.4}
@Deprecated public static List<Query> parseFuncs(IndexSchema s, String in) throws ParseException
NOTE: intra-function whitespace is not allowed.
ParseException
parseFieldBoosts(java.lang.String)
public static void setMinShouldMatch(BooleanQuery q, String spec)
Details about the specification format can be found here
A few important notes...
:TODO: should optimize the case where number is same as clauses to just make them all "required"
public static void flattenBooleanQuery(BooleanQuery to, BooleanQuery from)
Boosts are multiplied as needed. Sub-BooleanQueryies which are not optional will not be flattened. From will be mangled durring the walk, so do not attempt to reuse it.
public static CharSequence partialEscape(CharSequence s)
QueryParser.escape(java.lang.String)
public static CharSequence stripIllegalOperators(CharSequence s)
public static CharSequence stripUnbalancedQuotes(CharSequence s)
public static Sort getSort(SolrQueryRequest req)
public static List<Query> parseFilterQueries(SolrQueryRequest req) throws ParseException
ParseException
CommonParams.FQ
public static List<Query> parseQueryStrings(SolrQueryRequest req, String[] queries) throws ParseException
ParseException
public static SolrDocumentList docListToSolrDocumentList(DocList docs, SolrIndexSearcher searcher, Set<String> fields, Map<SolrDocument,Integer> ids) throws IOException
docs
- The DocList
to convertsearcher
- The SolrIndexSearcher
to use to load the docs from the Lucene indexfields
- The names of the Fields to loadids
- A map to store the ids of the docsSolrDocumentList
containing all the loaded docsIOException
- if there was a problem loading the docspublic static void addOrReplaceResults(SolrQueryResponse rsp, SolrDocumentList docs)
public static String resolveUpdateChainParam(SolrParams params, org.slf4j.Logger log)
params
- an instance of SolrParams from the requestlog
- an instance of a slf4j logger to log a warning in case of deprecated param usage