org.sindice.siren.qparser.json

Class JsonQueryParser

java.lang.Object

org.apache.lucene.queryparser.flexible.core.QueryParserHelper

org.sindice.siren.qparser.json.JsonQueryParser

public class JsonQueryParser
extends org.apache.lucene.queryparser.flexible.core.QueryParserHelper

This class is a helper that enables users to easily use the SIREn's JSON query parser.

To construct a Query object from a query string, use the parse(String, String) method:

 JsonQueryParser queryParser = new JsonQueryParser();
 Query query = JsonQueryParser.parse("{ \"node\" : { \"query\" : \"aaa\" }}", "defaultField");
 

To change any configuration before parsing the query string do, for example:

 // the query config handler returned by JsonQueryParser is a JsonQueryConfigHandler
 queryParser.getQueryConfigHandler().setDefaultOperator(Operator.AND);
 

Examples of appropriately formatted queries can be found in the query syntax documentation.

The text parser used by this helper is a JsonSyntaxParser.

The query node processor used by this helper is a JsonQueryNodeProcessorPipeline.

The builder used by this helper is a JsonQueryTreeBuilder.

See Also:

JsonQueryConfigHandler, JsonSyntaxParser, JsonQueryNodeProcessorPipeline, JsonQueryTreeBuilder

Constructor Summary

Constructors

Constructor and Description
JsonQueryParser()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.queryparser.flexible.standard.config.StandardQueryConfigHandler.Operator	getDefaultOperator() Gets implicit operator setting, which will be either StandardQueryConfigHandler.Operator.AND or StandardQueryConfigHandler.Operator.OR.
KeywordQueryParser	getKeywordQueryParser()
org.apache.lucene.search.Query	parse(String query, String defaultField) Overrides QueryParserHelper.parse(String, String) so it casts the return object to Query.
void	setDefaultOperator(org.apache.lucene.queryparser.flexible.standard.config.StandardQueryConfigHandler.Operator operator) Sets the boolean operator of the QueryParser.
void	setKeywordQueryParser(KeywordQueryParser keywordParser) Set the keyword query parser that will be used to parse boolean expressions found in the JSON query objects.
void	setQueryConfigHandler(org.apache.lucene.queryparser.flexible.core.config.QueryConfigHandler config)

Methods inherited from class org.apache.lucene.queryparser.flexible.core.QueryParserHelper

getQueryBuilder, getQueryConfigHandler, getQueryNodeProcessor, getSyntaxParser, setQueryBuilder, setQueryNodeProcessor, setSyntaxParser

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonQueryParser

public JsonQueryParser()

Method Detail

parse

public org.apache.lucene.search.Query parse(String query,
                                   String defaultField)
                                     throws org.apache.lucene.queryparser.flexible.core.QueryNodeException

Overrides QueryParserHelper.parse(String, String) so it casts the return object to Query. For more reference about this method, check QueryParserHelper.parse(String, String).

Overrides:

parse in class org.apache.lucene.queryparser.flexible.core.QueryParserHelper

Parameters:

query - the query string

defaultField - the default field used by the text parser

Returns:

the object built from the query

Throws:

ParseException - if something wrong happens during the query parsing

org.apache.lucene.queryparser.flexible.core.QueryNodeException

getDefaultOperator

public org.apache.lucene.queryparser.flexible.standard.config.StandardQueryConfigHandler.Operator getDefaultOperator()

Gets implicit operator setting, which will be either StandardQueryConfigHandler.Operator.AND or StandardQueryConfigHandler.Operator.OR.

setDefaultOperator

public void setDefaultOperator(org.apache.lucene.queryparser.flexible.standard.config.StandardQueryConfigHandler.Operator operator)

Sets the boolean operator of the QueryParser. In default mode ( StandardQueryConfigHandler.Operator.OR) terms without any modifiers are considered optional: for example capital of Hungary is equal to capital OR of OR Hungary.
In StandardQueryConfigHandler.Operator.AND mode terms are considered to be in conjunction: the above mentioned query is parsed as capital AND of AND Hungary

getKeywordQueryParser

public KeywordQueryParser getKeywordQueryParser()

setKeywordQueryParser

public void setKeywordQueryParser(KeywordQueryParser keywordParser)

Set the keyword query parser that will be used to parse boolean expressions found in the JSON query objects.

setQueryConfigHandler

public void setQueryConfigHandler(org.apache.lucene.queryparser.flexible.core.config.QueryConfigHandler config)

Overrides:

setQueryConfigHandler in class org.apache.lucene.queryparser.flexible.core.QueryParserHelper