Class QueryParser
- java.lang.Object
-
- org.apache.lucene.queryparser.surround.parser.QueryParser
-
- All Implemented Interfaces:
QueryParserConstants
public class QueryParser extends java.lang.Object implements QueryParserConstants
This class is generated by JavaCC. The only method that clients should need to call isparse()
.This parser generates queries that make use of position information (Span queries). It provides positional operators (
w
andn
) that accept a numeric distance, as well as boolean operators (and
,or
, andnot
, wildcards (*
and?
), quoting (with"
), and boosting (via^
).The operators (W, N, AND, OR, NOT) can be expressed lower-cased or upper-cased, and the non-unary operators (everything but NOT) support both infix
(a AND b AND c)
and prefixAND(a, b, c)
notation.The W and N operators express a positional relationship among their operands. N is ordered, and W is unordered. The distance is 1 by default, meaning the operands are adjacent, or may be provided as a prefix from 2-99. So, for example, 3W(a, b) means that terms a and b must appear within three positions of each other, or in other words, up to two terms may appear between a and b.
-
-
Field Summary
Fields Modifier and Type Field Description Token
jj_nt
Next token.Token
token
Current token.QueryParserTokenManager
token_source
Generated Token Manager.-
Fields inherited from interface org.apache.lucene.queryparser.surround.parser.QueryParserConstants
_DISTOP_NUM, _NUM_CHAR, _ONE_CHAR, _STAR, _TERM_CHAR, _WHITESPACE, AND, Boost, CARAT, COLON, COMMA, DEFAULT, EOF, LPAREN, N, NOT, NUMBER, OR, QUOTED, RPAREN, SUFFIXTERM, TERM, tokenImage, TRUNCQUOTED, TRUNCTERM, W
-
-
Constructor Summary
Constructors Constructor Description QueryParser()
QueryParser(CharStream stream)
Constructor with user supplied CharStream.QueryParser(QueryParserTokenManager tm)
Constructor with generated Token Manager.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SrndQuery
AndQuery()
void
disable_tracing()
Disable tracing.void
enable_tracing()
Enable tracing.SrndQuery
FieldsQuery()
java.util.List<SrndQuery>
FieldsQueryList()
ParseException
generateParseException()
Generate ParseException.Token
getNextToken()
Get the next Token.Token
getToken(int index)
Get the specific Token.SrndQuery
NotQuery()
SrndQuery
NQuery()
java.util.ArrayList<java.lang.String>
OptionalFields()
void
OptionalWeights(SrndQuery q)
SrndQuery
OrQuery()
static SrndQuery
parse(java.lang.String query)
SrndQuery
parse2(java.lang.String query)
SrndQuery
PrefixOperatorQuery()
SrndQuery
PrimaryQuery()
void
ReInit(CharStream stream)
Reinitialise.void
ReInit(QueryParserTokenManager tm)
Reinitialise.SrndQuery
SimpleTerm()
SrndQuery
TopSrndQuery()
SrndQuery
WQuery()
-
-
-
Field Detail
-
token_source
public QueryParserTokenManager token_source
Generated Token Manager.
-
token
public Token token
Current token.
-
jj_nt
public Token jj_nt
Next token.
-
-
Constructor Detail
-
QueryParser
public QueryParser()
-
QueryParser
public QueryParser(CharStream stream)
Constructor with user supplied CharStream.
-
QueryParser
public QueryParser(QueryParserTokenManager tm)
Constructor with generated Token Manager.
-
-
Method Detail
-
parse
public static SrndQuery parse(java.lang.String query) throws ParseException
- Throws:
ParseException
-
parse2
public SrndQuery parse2(java.lang.String query) throws ParseException
- Throws:
ParseException
-
TopSrndQuery
public final SrndQuery TopSrndQuery() throws ParseException
- Throws:
ParseException
-
FieldsQuery
public final SrndQuery FieldsQuery() throws ParseException
- Throws:
ParseException
-
OptionalFields
public final java.util.ArrayList<java.lang.String> OptionalFields() throws ParseException
- Throws:
ParseException
-
OrQuery
public final SrndQuery OrQuery() throws ParseException
- Throws:
ParseException
-
AndQuery
public final SrndQuery AndQuery() throws ParseException
- Throws:
ParseException
-
NotQuery
public final SrndQuery NotQuery() throws ParseException
- Throws:
ParseException
-
NQuery
public final SrndQuery NQuery() throws ParseException
- Throws:
ParseException
-
WQuery
public final SrndQuery WQuery() throws ParseException
- Throws:
ParseException
-
PrimaryQuery
public final SrndQuery PrimaryQuery() throws ParseException
- Throws:
ParseException
-
PrefixOperatorQuery
public final SrndQuery PrefixOperatorQuery() throws ParseException
- Throws:
ParseException
-
FieldsQueryList
public final java.util.List<SrndQuery> FieldsQueryList() throws ParseException
- Throws:
ParseException
-
SimpleTerm
public final SrndQuery SimpleTerm() throws ParseException
- Throws:
ParseException
-
OptionalWeights
public final void OptionalWeights(SrndQuery q) throws ParseException
- Throws:
ParseException
-
ReInit
public void ReInit(CharStream stream)
Reinitialise.
-
ReInit
public void ReInit(QueryParserTokenManager tm)
Reinitialise.
-
getNextToken
public final Token getNextToken()
Get the next Token.
-
getToken
public final Token getToken(int index)
Get the specific Token.
-
generateParseException
public ParseException generateParseException()
Generate ParseException.
-
enable_tracing
public final void enable_tracing()
Enable tracing.
-
disable_tracing
public final void disable_tracing()
Disable tracing.
-
-