org.apache.solr.search

Class QueryParsing

java.lang.Object

org.apache.solr.search.QueryParsing

public class QueryParsing
extends Object

Collection of static utilities useful for query parsing.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFTYPE
static String	F
static char	LOCALPARAM_END
static String	LOCALPARAM_START
static String	OP
static String	SPLIT_ON_WHITESPACE
static String	TYPE
static String	V
static String	VAL_EXPLICIT

Constructor Summary

Constructors

Constructor and Description
QueryParsing()

Method Summary

Modifier and Type	Method and Description
static String	getDefaultField(IndexSchema s, String df) Returns the effective default field based on the 'df' param or hardcoded schema default.
static SolrParams	getLocalParams(String txt, SolrParams params) "foo" returns null "{!prefix f=myfield}yes" returns type="prefix",f="myfield",v="yes" "{!prefix f=myfield v=$p}" returns type="prefix",f="myfield",v=params.get("p")
static QueryParser.Operator	getQueryParserDefaultOperator(IndexSchema sch, String override) Deprecated. this will probably be removed in 8.x. Keeping in 7.x for code back compat
static int	parseLocalParams(String txt, int start, ModifiableSolrParams target, SolrParams params)
static int	parseLocalParams(String txt, int start, ModifiableSolrParams target, SolrParams params, String startString, char endChar)
static List<String>	toString(List<Query> queries, IndexSchema schema) Builds a list of String which are stringified versions of a list of Queries
static String	toString(Query query, IndexSchema schema) Formats a Query for debugging, using the IndexSchema to make complex field types readable.
static void	toString(Query query, IndexSchema schema, Appendable out, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

OP

public static final String OP

See Also:

Constant Field Values

V

public static final String V

See Also:

Constant Field Values

F

public static final String F

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

DEFTYPE

public static final String DEFTYPE

See Also:

Constant Field Values

SPLIT_ON_WHITESPACE

public static final String SPLIT_ON_WHITESPACE

See Also:

Constant Field Values

LOCALPARAM_START

public static final String LOCALPARAM_START

See Also:

Constant Field Values

LOCALPARAM_END

public static final char LOCALPARAM_END

See Also:

Constant Field Values

VAL_EXPLICIT

public static final String VAL_EXPLICIT

See Also:

Constant Field Values

Constructor Detail

QueryParsing

public QueryParsing()

Method Detail

getQueryParserDefaultOperator

@Deprecated
public static QueryParser.Operator getQueryParserDefaultOperator(IndexSchema sch,
                                                                             String override)

Deprecated. this will probably be removed in 8.x. Keeping in 7.x for code back compat

Returns the "preferred" default operator for use by Query Parsers, based on the settings in the IndexSchema which may be overridden using an optional String override value.

See Also:

IndexSchema.getQueryParserDefaultOperator(), OP

getDefaultField

public static String getDefaultField(IndexSchema s,
                                     String df)

Returns the effective default field based on the 'df' param or hardcoded schema default. May be null if either exists specified.

See Also:

CommonParams.DF, IndexSchema.getDefaultSearchFieldName()

parseLocalParams

public static int parseLocalParams(String txt,
                                   int start,
                                   ModifiableSolrParams target,
                                   SolrParams params)
                            throws SyntaxError

Parameters:

txt - Text to parse

start - Index into text for start of parsing

target - Object to inject with parsed settings

params - Additional existing parameters

Throws:

SyntaxError

parseLocalParams

public static int parseLocalParams(String txt,
                                   int start,
                                   ModifiableSolrParams target,
                                   SolrParams params,
                                   String startString,
                                   char endChar)
                            throws SyntaxError

Parameters:

txt - Text to parse

start - Index into text for start of parsing

target - Object to inject with parsed settings

params - Additional existing parameters

startString - String that indicates the start of a localParams section

endChar - Character that indicates the end of a localParams section

Throws:

SyntaxError

getLocalParams

public static SolrParams getLocalParams(String txt,
                                        SolrParams params)
                                 throws SyntaxError

"foo" returns null "{!prefix f=myfield}yes" returns type="prefix",f="myfield",v="yes" "{!prefix f=myfield v=$p}" returns type="prefix",f="myfield",v=params.get("p")

Throws:

SyntaxError

toString

public static void toString(Query query,
                            IndexSchema schema,
                            Appendable out,
                            int flags)
                     throws IOException

Throws:

IOException

See Also:

toString(Query,IndexSchema)

toString

public static String toString(Query query,
                              IndexSchema schema)

Formats a Query for debugging, using the IndexSchema to make complex field types readable.

The benefit of using this method instead of calling Query.toString directly is that it knows about the data types of each field, so any field which is encoded in a particularly complex way is still readable. The downside is that it only knows about built in Query types, and will not be able to format custom Query classes.

toString

public static List<String> toString(List<Query> queries,
                                    IndexSchema schema)

Builds a list of String which are stringified versions of a list of Queries