|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.queryParser.QueryParser
org.apache.lucene.queryParser.MultiFieldQueryParser
public class MultiFieldQueryParser
A QueryParser which constructs queries to search multiple fields.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.lucene.queryParser.QueryParser |
---|
QueryParser.Operator |
Field Summary | |
---|---|
static int |
NORMAL_FIELD
Deprecated. |
static int |
PROHIBITED_FIELD
Deprecated. |
static int |
REQUIRED_FIELD
Deprecated. |
Fields inherited from class org.apache.lucene.queryParser.QueryParser |
---|
AND_OPERATOR, DEFAULT_OPERATOR_AND, DEFAULT_OPERATOR_OR, jj_nt, lookingAhead, OR_OPERATOR, token, token_source |
Fields inherited from interface org.apache.lucene.queryParser.QueryParserConstants |
---|
_ESCAPED_CHAR, _NUM_CHAR, _TERM_CHAR, _TERM_START_CHAR, _WHITESPACE, AND, Boost, CARAT, COLON, DEFAULT, EOF, FUZZY_SLOP, LPAREN, MINUS, NOT, NUMBER, OR, PLUS, PREFIXTERM, QUOTED, RangeEx, RANGEEX_END, RANGEEX_GOOP, RANGEEX_QUOTED, RANGEEX_START, RANGEEX_TO, RangeIn, RANGEIN_END, RANGEIN_GOOP, RANGEIN_QUOTED, RANGEIN_START, RANGEIN_TO, RPAREN, TERM, tokenImage, WILDTERM |
Constructor Summary | |
---|---|
MultiFieldQueryParser(CharStream stream)
Deprecated. use MultiFieldQueryParser(String[], Analyzer) instead |
|
MultiFieldQueryParser(QueryParserTokenManager tm)
Deprecated. use MultiFieldQueryParser(String[], Analyzer) instead |
|
MultiFieldQueryParser(java.lang.String[] fields,
Analyzer analyzer)
Creates a MultiFieldQueryParser. |
|
MultiFieldQueryParser(java.lang.String f,
Analyzer a)
Deprecated. use MultiFieldQueryParser(String[], Analyzer) instead |
Method Summary | |
---|---|
protected Query |
getFieldQuery(java.lang.String field,
Analyzer analyzer,
java.lang.String queryText)
Deprecated. use getFieldQuery(String, String) |
protected Query |
getFieldQuery(java.lang.String field,
java.lang.String queryText)
|
protected Query |
getFieldQuery(java.lang.String field,
java.lang.String queryText,
int slop)
Base implementation delegates to QueryParser.getFieldQuery(String,String) . |
protected Query |
getFuzzyQuery(java.lang.String field,
java.lang.String termStr)
Deprecated. use getFuzzyQuery(String, String, float) |
protected Query |
getFuzzyQuery(java.lang.String field,
java.lang.String termStr,
float minSimilarity)
Factory method for generating a query (similar to QueryParser.getWildcardQuery(java.lang.String, java.lang.String) ). |
protected Query |
getPrefixQuery(java.lang.String field,
java.lang.String termStr)
Factory method for generating a query (similar to QueryParser.getWildcardQuery(java.lang.String, java.lang.String) ). |
protected Query |
getRangeQuery(java.lang.String field,
Analyzer analyzer,
java.lang.String part1,
java.lang.String part2,
boolean inclusive)
Deprecated. use getRangeQuery(String, String, String, boolean) |
protected Query |
getRangeQuery(java.lang.String field,
java.lang.String part1,
java.lang.String part2,
boolean inclusive)
|
protected Query |
getWildcardQuery(java.lang.String field,
java.lang.String termStr)
Factory method for generating a query. |
static Query |
parse(java.lang.String[] queries,
java.lang.String[] fields,
Analyzer analyzer)
Parses a query which searches on the fields specified. |
static Query |
parse(java.lang.String[] queries,
java.lang.String[] fields,
BooleanClause.Occur[] flags,
Analyzer analyzer)
Parses a query, searching on the fields specified. |
static Query |
parse(java.lang.String[] queries,
java.lang.String[] fields,
int[] flags,
Analyzer analyzer)
Deprecated. use parse(String[], String[], BooleanClause.Occur[], Analyzer) instead |
static Query |
parse(java.lang.String query,
java.lang.String[] fields,
Analyzer analyzer)
Deprecated. use QueryParser.parse(String) instead but note that it
returns a different query for queries where all terms are required:
its query excepts all terms, no matter in what field they occur whereas
the query built by this (deprecated) method expected all terms in all fields
at the same time. |
static Query |
parse(java.lang.String query,
java.lang.String[] fields,
BooleanClause.Occur[] flags,
Analyzer analyzer)
Parses a query, searching on the fields specified. |
static Query |
parse(java.lang.String query,
java.lang.String[] fields,
int[] flags,
Analyzer analyzer)
Deprecated. use parse(String, String[], BooleanClause.Occur[], Analyzer) instead |
Methods inherited from class org.apache.lucene.queryParser.QueryParser |
---|
addClause, Clause, Conjunction, disable_tracing, enable_tracing, escape, generateParseException, getAnalyzer, getBooleanQuery, getBooleanQuery, getDefaultOperator, getField, getFieldQuery, getFuzzyMinSim, getFuzzyPrefixLength, getLocale, getLowercaseExpandedTerms, getLowercaseWildcardTerms, getNextToken, getOperator, getPhraseSlop, getToken, main, Modifiers, parse, parse, Query, ReInit, ReInit, setDefaultOperator, setFuzzyMinSim, setFuzzyPrefixLength, setLocale, setLowercaseExpandedTerms, setLowercaseWildcardTerms, setOperator, setPhraseSlop, Term |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NORMAL_FIELD
public static final int REQUIRED_FIELD
public static final int PROHIBITED_FIELD
Constructor Detail |
---|
public MultiFieldQueryParser(java.lang.String[] fields, Analyzer analyzer)
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 title
and body
):
(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.
public MultiFieldQueryParser(QueryParserTokenManager tm)
MultiFieldQueryParser(String[], Analyzer)
instead
public MultiFieldQueryParser(CharStream stream)
MultiFieldQueryParser(String[], Analyzer)
instead
public MultiFieldQueryParser(java.lang.String f, Analyzer a)
MultiFieldQueryParser(String[], Analyzer)
instead
Method Detail |
---|
protected Query getFieldQuery(java.lang.String field, java.lang.String queryText, int slop) throws ParseException
QueryParser
QueryParser.getFieldQuery(String,String)
.
This method may be overridden, for example, to return
a SpanNearQuery instead of a PhraseQuery.
getFieldQuery
in class QueryParser
ParseException
- throw in overridden method to disallowprotected Query getFieldQuery(java.lang.String field, java.lang.String queryText) throws ParseException
getFieldQuery
in class QueryParser
ParseException
- throw in overridden method to disallowprotected Query getFieldQuery(java.lang.String field, Analyzer analyzer, java.lang.String queryText) throws ParseException
getFieldQuery(String, String)
QueryParser
getFieldQuery
in class QueryParser
ParseException
- throw in overridden method to disallowprotected Query getFuzzyQuery(java.lang.String field, java.lang.String termStr) throws ParseException
getFuzzyQuery(String, String, float)
getFuzzyQuery
in class QueryParser
ParseException
protected Query getFuzzyQuery(java.lang.String field, java.lang.String termStr, float minSimilarity) throws ParseException
QueryParser
QueryParser.getWildcardQuery(java.lang.String, java.lang.String)
). Called when parser parses
an input term token that has the fuzzy suffix (~) appended.
getFuzzyQuery
in class QueryParser
field
- Name of the field query will use.termStr
- Term token to use for building term for the query
Query
built for the term
ParseException
- throw in overridden method to disallowprotected Query getPrefixQuery(java.lang.String field, java.lang.String termStr) throws ParseException
QueryParser
QueryParser.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.
getPrefixQuery
in class QueryParser
field
- Name of the field query will use.termStr
- Term token to use for building term for the query
(without trailing '*' character!)
Query
built for the term
ParseException
- throw in overridden method to disallowprotected Query getWildcardQuery(java.lang.String field, java.lang.String termStr) throws ParseException
QueryParser
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.
getWildcardQuery
in class QueryParser
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
Query
built for the term
ParseException
- throw in overridden method to disallowprotected Query getRangeQuery(java.lang.String field, Analyzer analyzer, java.lang.String part1, java.lang.String part2, boolean inclusive) throws ParseException
getRangeQuery(String, String, String, boolean)
QueryParser
getRangeQuery
in class QueryParser
ParseException
protected Query getRangeQuery(java.lang.String field, java.lang.String part1, java.lang.String part2, boolean inclusive) throws ParseException
getRangeQuery
in class QueryParser
ParseException
- throw in overridden method to disallowpublic static Query parse(java.lang.String query, java.lang.String[] fields, Analyzer analyzer) throws ParseException
QueryParser.parse(String)
instead but note that it
returns a different query for queries where all terms are required:
its query excepts all terms, no matter in what field they occur whereas
the query built by this (deprecated) method expected all terms in all fields
at the same time.
(field1:query) (field2:query) (field3:query)...(fieldx:query)
query
- Query string to parsefields
- Fields to search onanalyzer
- Analyzer to use
ParseException
- if query parsing fails
TokenMgrError
- if query parsing failspublic static Query parse(java.lang.String[] queries, java.lang.String[] fields, Analyzer analyzer) throws ParseException
If x fields are specified, this effectively constructs:
(field1:query1) (field2:query2) (field3:query3)...(fieldx:queryx)
queries
- Queries strings to parsefields
- Fields to search onanalyzer
- Analyzer to use
ParseException
- if query parsing fails
TokenMgrError
- if query parsing fails
java.lang.IllegalArgumentException
- if the length of the queries array differs
from the length of the fields arraypublic static Query parse(java.lang.String query, java.lang.String[] fields, int[] flags, Analyzer analyzer) throws ParseException
parse(String, String[], BooleanClause.Occur[], Analyzer)
instead
Usage:
String[] fields = {"filename", "contents", "description"};
int[] flags = {MultiFieldQueryParser.NORMAL_FIELD,
MultiFieldQueryParser.REQUIRED_FIELD,
MultiFieldQueryParser.PROHIBITED_FIELD,};
parse(query, fields, flags, analyzer);
The code above would construct a query:
(filename:query) +(contents:query) -(description:query)
query
- Query string to parsefields
- Fields to search onflags
- Flags describing the fieldsanalyzer
- Analyzer to use
ParseException
- if query parsing fails
TokenMgrError
- if query parsing fails
java.lang.IllegalArgumentException
- if the length of the fields array differs
from the length of the flags arraypublic static Query parse(java.lang.String query, java.lang.String[] fields, BooleanClause.Occur[] flags, Analyzer analyzer) throws ParseException
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)
query
- Query string to parsefields
- Fields to search onflags
- Flags describing the fieldsanalyzer
- Analyzer to use
ParseException
- if query parsing fails
TokenMgrError
- if query parsing fails
java.lang.IllegalArgumentException
- if the length of the fields array differs
from the length of the flags arraypublic static Query parse(java.lang.String[] queries, java.lang.String[] fields, int[] flags, Analyzer analyzer) throws ParseException
parse(String[], String[], BooleanClause.Occur[], Analyzer)
instead
Usage:
String[] fields = { "filename", "contents", "description" };
int[] flags = { MultiFieldQueryParser.NORMAL_FIELD,
MultiFieldQueryParser.REQUIRED_FIELD,
MultiFieldQueryParser.PROHIBITED_FIELD, };
parse(query, fields, flags, analyzer);
The code above would construct a query:
(filename:query1) +(contents:query2) -(description:query3)
queries
- Queries string to parsefields
- Fields to search onflags
- Flags describing the fieldsanalyzer
- Analyzer to use
ParseException
- if query parsing fails
TokenMgrError
- if query parsing fails
java.lang.IllegalArgumentException
- if the length of the queries, fields, and flags array differpublic static Query parse(java.lang.String[] queries, java.lang.String[] fields, BooleanClause.Occur[] flags, Analyzer analyzer) throws ParseException
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)
queries
- Queries string to parsefields
- Fields to search onflags
- Flags describing the fieldsanalyzer
- Analyzer to use
ParseException
- if query parsing fails
TokenMgrError
- if query parsing fails
java.lang.IllegalArgumentException
- if the length of the queries, fields,
and flags array differ
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |