Class MultiFieldQueryParser
- All Implemented Interfaces:
QueryParserConstants,CommonQueryParserConfiguration
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.queryparser.classic.QueryParser
QueryParser.OperatorNested classes/interfaces inherited from class org.apache.lucene.util.QueryBuilder
QueryBuilder.TermAndBoost -
Field Summary
FieldsFields inherited from class org.apache.lucene.queryparser.classic.QueryParser
DEFAULT_SPLIT_ON_WHITESPACE, jj_nt, token, token_sourceFields inherited from class org.apache.lucene.queryparser.classic.QueryParserBase
AND_OPERATOR, field, OR_OPERATORFields inherited from class org.apache.lucene.util.QueryBuilder
analyzer, autoGenerateMultiTermSynonymsPhraseQuery, enableGraphQueries, enablePositionIncrementsFields inherited from interface org.apache.lucene.queryparser.classic.QueryParserConstants
_ESCAPED_CHAR, _NUM_CHAR, _QUOTED_CHAR, _TERM_CHAR, _TERM_START_CHAR, _WHITESPACE, AND, BAREOPER, Boost, CARAT, COLON, DEFAULT, EOF, FUZZY_SLOP, LPAREN, MINUS, NOT, NUMBER, OR, PLUS, PREFIXTERM, QUOTED, Range, RANGE_GOOP, RANGE_QUOTED, RANGE_TO, RANGEEX_END, RANGEEX_START, RANGEIN_END, RANGEIN_START, REGEXPTERM, RPAREN, STAR, TERM, tokenImage, WILDTERM -
Constructor Summary
ConstructorsConstructorDescriptionMultiFieldQueryParser(String[] fields, Analyzer analyzer) Creates a MultiFieldQueryParser.Creates a MultiFieldQueryParser. -
Method Summary
Modifier and TypeMethodDescriptionprotected QuerygetFieldQuery(String field, String queryText, boolean quoted) protected QuerygetFieldQuery(String field, String queryText, int slop) Base implementation delegates toQueryParserBase.getFieldQuery(String,String,boolean).protected QuerygetFuzzyQuery(String field, String termStr, float minSimilarity) Factory method for generating a query (similar toQueryParserBase.getWildcardQuery(java.lang.String, java.lang.String)).protected QuerygetMultiFieldQuery(List<Query> queries) Creates a multifield queryprotected QuerygetPrefixQuery(String field, String termStr) Factory method for generating a query (similar toQueryParserBase.getWildcardQuery(java.lang.String, java.lang.String)).protected QuerygetRangeQuery(String field, String part1, String part2, boolean startInclusive, boolean endInclusive) protected QuerygetRegexpQuery(String field, String termStr) Factory method for generating a query.protected QuerygetWildcardQuery(String field, String termStr) Factory method for generating a query.static QueryParses a query which searches on the fields specified.static Queryparse(String[] queries, String[] fields, BooleanClause.Occur[] flags, Analyzer analyzer) Parses a query, searching on the fields specified.static Queryparse(String query, String[] fields, BooleanClause.Occur[] flags, Analyzer analyzer) Parses a query, searching on the fields specified.Methods inherited from class org.apache.lucene.queryparser.classic.QueryParser
Clause, Conjunction, disable_tracing, enable_tracing, generateParseException, getNextToken, getSplitOnWhitespace, getToken, Modifiers, MultiTerm, Query, ReInit, ReInit, setAutoGeneratePhraseQueries, setSplitOnWhitespace, Term, TopLevelQuery, trace_enabledMethods inherited from class org.apache.lucene.queryparser.classic.QueryParserBase
addClause, addMultiTermClauses, escape, getAllowLeadingWildcard, getAutoGeneratePhraseQueries, getBooleanQuery, getDateResolution, getDefaultOperator, getDeterminizeWorkLimit, getField, getFuzzyDistance, getFuzzyMinSim, getFuzzyPrefixLength, getLocale, getMultiTermRewriteMethod, getPhraseSlop, getTimeZone, init, newBooleanClause, newFieldQuery, newFuzzyQuery, newMatchAllDocsQuery, newPrefixQuery, newRangeQuery, newRegexpQuery, newWildcardQuery, parse, setAllowLeadingWildcard, setDateResolution, setDateResolution, setDefaultOperator, setDeterminizeWorkLimit, setFuzzyMinSim, setFuzzyPrefixLength, setLocale, setMultiTermRewriteMethod, setPhraseSlop, setTimeZoneMethods inherited from class org.apache.lucene.util.QueryBuilder
add, analyzeBoolean, analyzeGraphBoolean, analyzeGraphPhrase, analyzeMultiBoolean, analyzeMultiPhrase, analyzePhrase, analyzeTerm, createBooleanQuery, createBooleanQuery, createFieldQuery, createFieldQuery, createMinShouldMatchQuery, createPhraseQuery, createPhraseQuery, getAnalyzer, getAutoGenerateMultiTermSynonymsPhraseQuery, getEnableGraphQueries, getEnablePositionIncrements, newBooleanQuery, newGraphSynonymQuery, newMultiPhraseQueryBuilder, newSynonymQuery, newTermQuery, setAnalyzer, setAutoGenerateMultiTermSynonymsPhraseQuery, setEnableGraphQueries, setEnablePositionIncrementsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.lucene.queryparser.flexible.standard.CommonQueryParserConfiguration
getAnalyzer, getEnablePositionIncrements, setEnablePositionIncrements
-
Field Details
-
fields
-
boosts
-
-
Constructor Details
-
MultiFieldQueryParser
Creates a MultiFieldQueryParser. Allows passing of a map with term to Boost, and the boost to apply to each term.It will, when parse(String query) is called, construct a query like this (assuming the query consists of two terms and you specify the two fields
titleandbody):(title:term1 body:term1) (title:term2 body:term2)When setDefaultOperator(AND_OPERATOR) is set, the result will be:
+(title:term1 body:term1) +(title:term2 body:term2)When you pass a boost (title=>5 body=>10) you can get
+(title:term1^5.0 body:term1^10.0) +(title:term2^5.0 body:term2^10.0)In other words, all the query's terms must appear, but it doesn't matter in what fields they appear.
-
MultiFieldQueryParser
Creates a MultiFieldQueryParser.It will, when parse(String query) is called, construct a query like this (assuming the query consists of two terms and you specify the two fields
titleandbody):(title:term1 body:term1) (title:term2 body:term2)When setDefaultOperator(AND_OPERATOR) is set, the result will be:
+(title:term1 body:term1) +(title:term2 body:term2)In other words, all the query's terms must appear, but it doesn't matter in what fields they appear.
-
-
Method Details
-
getFieldQuery
Description copied from class:QueryParserBaseBase implementation delegates toQueryParserBase.getFieldQuery(String,String,boolean). This method may be overridden, for example, to return a SpanNearQuery instead of a PhraseQuery.- Overrides:
getFieldQueryin classQueryParserBase- Throws:
ParseException- throw in overridden method to disallow
-
getFieldQuery
- Overrides:
getFieldQueryin classQueryParserBase- Throws:
ParseException- throw in overridden method to disallow
-
getFuzzyQuery
protected Query getFuzzyQuery(String field, String termStr, float minSimilarity) throws ParseException Description copied from class:QueryParserBaseFactory method for generating a query (similar toQueryParserBase.getWildcardQuery(java.lang.String, java.lang.String)). Called when parser parses an input term token that has the fuzzy suffix (~) appended.- Overrides:
getFuzzyQueryin classQueryParserBase- Parameters:
field- Name of the field query will use.termStr- Term token to use for building term for the query- Returns:
- Resulting
Querybuilt for the term - Throws:
ParseException- throw in overridden method to disallow
-
getPrefixQuery
Description copied from class:QueryParserBaseFactory method for generating a query (similar toQueryParserBase.getWildcardQuery(java.lang.String, java.lang.String)). Called when parser parses an input term token that uses prefix notation; that is, contains a single '*' wildcard character as its last character. Since this is a special case of generic wildcard term, and such a query can be optimized easily, this usually results in a different query object.Depending on settings, a prefix term may be lower-cased automatically. It will not go through the default Analyzer, however, since normal Analyzers are unlikely to work properly with wildcard templates.
Can be overridden by extending classes, to provide custom handling for wild card queries, which may be necessary due to missing analyzer calls.
- Overrides:
getPrefixQueryin classQueryParserBase- Parameters:
field- Name of the field query will use.termStr- Term token to use for building term for the query (without trailing '*' character!)- Returns:
- Resulting
Querybuilt for the term - Throws:
ParseException- throw in overridden method to disallow
-
getWildcardQuery
Description copied from class:QueryParserBaseFactory method for generating a query. Called when parser parses an input term token that contains one or more wildcard characters (? and *), but is not a prefix term token (one that has just a single * character at the end)Depending on settings, prefix term may be lower-cased automatically. It will not go through the default Analyzer, however, since normal Analyzers are unlikely to work properly with wildcard templates.
Can be overridden by extending classes, to provide custom handling for wildcard queries, which may be necessary due to missing analyzer calls.
- Overrides:
getWildcardQueryin classQueryParserBase- Parameters:
field- Name of the field query will use.termStr- Term token that contains one or more wild card characters (? or *), but is not simple prefix term- Returns:
- Resulting
Querybuilt for the term - Throws:
ParseException- throw in overridden method to disallow
-
getRangeQuery
protected Query getRangeQuery(String field, String part1, String part2, boolean startInclusive, boolean endInclusive) throws ParseException - Overrides:
getRangeQueryin classQueryParserBase- Throws:
ParseException
-
getRegexpQuery
Description copied from class:QueryParserBaseFactory method for generating a query. Called when parser parses an input term token that contains a regular expression query.Depending on settings, pattern term may be lower-cased automatically. It will not go through the default Analyzer, however, since normal Analyzers are unlikely to work properly with regular expression templates.
Can be overridden by extending classes, to provide custom handling for regular expression queries, which may be necessary due to missing analyzer calls.
- Overrides:
getRegexpQueryin classQueryParserBase- Parameters:
field- Name of the field query will use.termStr- Term token that contains a regular expression- Returns:
- Resulting
Querybuilt for the term - Throws:
ParseException- throw in overridden method to disallow
-
getMultiFieldQuery
Creates a multifield query- Throws:
ParseException
-
parse
public static Query parse(String[] queries, String[] fields, Analyzer analyzer) throws ParseException Parses a query which searches on the fields specified.If x fields are specified, this effectively constructs:
(field1:query1) (field2:query2) (field3:query3)...(fieldx:queryx)- Parameters:
queries- Queries strings to parsefields- Fields to search onanalyzer- Analyzer to use- Throws:
ParseException- if query parsing failsIllegalArgumentException- if the length of the queries array differs from the length of the fields array
-
parse
public static Query parse(String query, String[] fields, BooleanClause.Occur[] flags, Analyzer analyzer) throws ParseException Parses a query, searching on the fields specified. Use this if you need to specify certain fields as required, and others as prohibited.Usage:
String[] fields = {"filename", "contents", "description"}; BooleanClause.Occur[] flags = {BooleanClause.Occur.SHOULD, BooleanClause.Occur.MUST, BooleanClause.Occur.MUST_NOT}; MultiFieldQueryParser.parse("query", fields, flags, analyzer);The code above would construct a query:
(filename:query) +(contents:query) -(description:query)- Parameters:
query- Query string to parsefields- Fields to search onflags- Flags describing the fieldsanalyzer- Analyzer to use- Throws:
ParseException- if query parsing failsIllegalArgumentException- if the length of the fields array differs from the length of the flags array
-
parse
public static Query parse(String[] queries, String[] fields, BooleanClause.Occur[] flags, Analyzer analyzer) throws ParseException Parses a query, searching on the fields specified. Use this if you need to specify certain fields as required, and others as prohibited.Usage:
String[] query = {"query1", "query2", "query3"}; String[] fields = {"filename", "contents", "description"}; BooleanClause.Occur[] flags = {BooleanClause.Occur.SHOULD, BooleanClause.Occur.MUST, BooleanClause.Occur.MUST_NOT}; MultiFieldQueryParser.parse(query, fields, flags, analyzer);The code above would construct a query:
(filename:query1) +(contents:query2) -(description:query3)- Parameters:
queries- Queries string to parsefields- Fields to search onflags- Flags describing the fieldsanalyzer- Analyzer to use- Throws:
ParseException- if query parsing failsIllegalArgumentException- if the length of the queries, fields, and flags array differ
-