org.sindice.siren.qparser.keyword

Class KeywordQueryParser

java.lang.Object

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

org.apache.lucene.queryparser.flexible.standard.StandardQueryParser

org.sindice.siren.qparser.keyword.KeywordQueryParser

All Implemented Interfaces:

org.apache.lucene.queryparser.flexible.standard.CommonQueryParserConfiguration

public class KeywordQueryParser
extends org.apache.lucene.queryparser.flexible.standard.StandardQueryParser

This class is a helper that enables to create easily a boolean of twig queries.

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

 KeywordQueryParser queryParser = new KeywordQueryParser(); 

 Query query = queryParser.parse("a : b", "sirenField");
 

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

 queryParser.getQueryConfigHandler().setDefaultOperator(Operator.AND);
 

or use the setter methods:

   queryParser.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 KeywordSyntaxParser. The BNF grammar of this parser is available here.

The QueryConfigHandler used by this helper is a KeywordQueryConfigHandler.

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

The builder used by this helper is a KeywordQueryTreeBuilder.

See Also:

KeywordQueryConfigHandler, KeywordSyntaxParser, KeywordQueryNodeProcessorPipeline, KeywordQueryTreeBuilder

Constructor Summary

Constructors

Constructor and Description
KeywordQueryParser() Constructs a KeywordQueryParser object.

Method Summary

Methods

Modifier and Type	Method and Description
void	setAllowFuzzyAndWildcard(boolean allowFuzzyWildcard) Set to true to allow fuzzy and wildcard queries.
void	setAllowTwig(boolean allowTwig) Enable or not TwigQuery
void	setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)
void	setDatatypeAnalyzers(Map<String,org.apache.lucene.analysis.Analyzer> dtAnalyzers) Set the Map that associates a datatype to its Analyzer.
void	setDefaultOperator(org.apache.lucene.queryparser.flexible.standard.config.StandardQueryConfigHandler.Operator operator) Sets the boolean operator of the QueryParser.
void	setQNames(Properties qnames) Set the set of qnames to URI mappings.
void	setRootLevel(int level) Set the default root level of a TwigQuery
String	toString()

Methods inherited from class org.apache.lucene.queryparser.flexible.standard.StandardQueryParser

getAllowLeadingWildcard, getAnalyzer, getDateResolution, getDateResolutionMap, getDefaultOperator, getEnablePositionIncrements, getFieldsBoost, getFuzzyMinSim, getFuzzyPrefixLength, getLocale, getLowercaseExpandedTerms, getMultiFields, getMultiTermRewriteMethod, getNumericConfigMap, getPhraseSlop, getTimeZone, parse, setAllowLeadingWildcard, setDateResolution, setDateResolution, setDateResolutionMap, setDefaultPhraseSlop, setEnablePositionIncrements, setFieldsBoost, setFuzzyMinSim, setFuzzyPrefixLength, setLocale, setLowercaseExpandedTerms, setMultiFields, setMultiTermRewriteMethod, setNumericConfigMap, setPhraseSlop, setTimeZone

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordQueryParser

public KeywordQueryParser()

Constructs a KeywordQueryParser object.

Method Detail

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

Default: StandardQueryConfigHandler.Operator.AND

Overrides:

setDefaultOperator in class org.apache.lucene.queryparser.flexible.standard.StandardQueryParser

setQNames

public void setQNames(Properties qnames)

Set the set of qnames to URI mappings.

Default: null.

setAllowFuzzyAndWildcard

public void setAllowFuzzyAndWildcard(boolean allowFuzzyWildcard)

Set to true to allow fuzzy and wildcard queries.

Default: true.

setDatatypeAnalyzers

public void setDatatypeAnalyzers(Map<String,org.apache.lucene.analysis.Analyzer> dtAnalyzers)

Set the Map that associates a datatype to its Analyzer.

Default:

     map.put(XSDDatatype.XSD_STRING, new StandardAnalyzer(Version.LUCENE_40));
     map.put(JSONDatatype.JSON_FIELD, new WhitespaceAnalyzer(Version.LUCENE_40));
 

setAnalyzer

public void setAnalyzer(org.apache.lucene.analysis.Analyzer analyzer)

Overrides:

setAnalyzer in class org.apache.lucene.queryparser.flexible.standard.StandardQueryParser

setRootLevel

public void setRootLevel(int level)

Set the default root level of a TwigQuery

Default: 1

setAllowTwig

public void setAllowTwig(boolean allowTwig)

Enable or not TwigQuery

Default: true

toString

public String toString()

Overrides:

toString in class org.apache.lucene.queryparser.flexible.standard.StandardQueryParser