java.lang.Object
- org.apache.lucene.queryparser.flexible.standard.parser.StandardSyntaxParser

All Implemented Interfaces:: SyntaxParser, StandardSyntaxParserConstants

public class StandardSyntaxParser
extends java.lang.Object
implements SyntaxParser, StandardSyntaxParserConstants

Parser for the standard Lucene syntax

Nested Class Summary

Nested Classes
Modifier and Type Class Description

(package private) static class StandardSyntaxParser.JJCalls

private static class StandardSyntaxParser.LookaheadSuccess

Field Summary

Fields
Modifier and Type	Field	Description
`private StandardSyntaxParser.JJCalls[]`	`jj_2_rtns`
`private int`	`jj_endpos`
`private java.util.List<int[]>`	`jj_expentries`
`private int[]`	`jj_expentry`
`private int`	`jj_gc`
`private int`	`jj_gen`
`private int`	`jj_kind`
`private int`	`jj_la`
`private int[]`	`jj_la1`
`private static int[]`	`jj_la1_0`
`private static int[]`	`jj_la1_1`
`private Token`	`jj_lastpos`
`private int[]`	`jj_lasttokens`
`private StandardSyntaxParser.LookaheadSuccess`	`jj_ls`
`Token`	`jj_nt`	Next token.
`private int`	`jj_ntk`
`private boolean`	`jj_rescan`
`private Token`	`jj_scanpos`
`Token`	`token`	Current token.
`StandardSyntaxParserTokenManager`	`token_source`	Generated Token Manager.

Fields inherited from interface org.apache.lucene.queryparser.flexible.standard.parser.StandardSyntaxParserConstants
_ESCAPED_CHAR, _NUM_CHAR, _QUOTED_CHAR, _TERM_CHAR, _TERM_START_CHAR, _WHITESPACE, AND, Boost, CARAT, DEFAULT, EOF, FUZZY_SLOP, LPAREN, MINUS, NOT, NUMBER, OP_COLON, OP_EQUAL, OP_LESSTHAN, OP_LESSTHANEQ, OP_MORETHAN, OP_MORETHANEQ, OR, PLUS, QUOTED, Range, RANGE_GOOP, RANGE_QUOTED, RANGE_TO, RANGEEX_END, RANGEEX_START, RANGEIN_END, RANGEIN_START, REGEXPTERM, RPAREN, TERM, tokenImage

Constructor Summary

Constructors
Constructor	Description
`StandardSyntaxParser()`
`StandardSyntaxParser(CharStream stream)`	Constructor with user supplied CharStream.
`StandardSyntaxParser(StandardSyntaxParserTokenManager tm)`	Constructor with generated Token Manager.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`QueryNode`	`Clause(java.lang.CharSequence field)`
`QueryNode`	`ConjQuery(java.lang.CharSequence field)`
`void`	`disable_tracing()`	Disable tracing.
`QueryNode`	`DisjQuery(java.lang.CharSequence field)`
`void`	`enable_tracing()`	Enable tracing.
`ParseException`	`generateParseException()`	Generate ParseException.
`Token`	`getNextToken()`	Get the next Token.
`Token`	`getToken(int index)`	Get the specific Token.
`private boolean`	`jj_2_1(int xla)`
`private boolean`	`jj_2_2(int xla)`
`private boolean`	`jj_3_1()`
`private boolean`	`jj_3_2()`
`private boolean`	`jj_3R_10()`
`private boolean`	`jj_3R_11()`
`private boolean`	`jj_3R_12()`
`private boolean`	`jj_3R_4()`
`private boolean`	`jj_3R_5()`
`private boolean`	`jj_3R_6()`
`private boolean`	`jj_3R_7()`
`private boolean`	`jj_3R_8()`
`private boolean`	`jj_3R_9()`
`private void`	`jj_add_error_token(int kind, int pos)`
`private Token`	`jj_consume_token(int kind)`
`private static void`	`jj_la1_init_0()`
`private static void`	`jj_la1_init_1()`
`private int`	`jj_ntk()`
`private void`	`jj_rescan_token()`
`private void`	`jj_save(int index, int xla)`
`private boolean`	`jj_scan_token(int kind)`
`QueryNode`	`ModClause(java.lang.CharSequence field)`
`ModifierQueryNode.Modifier`	`Modifiers()`
`QueryNode`	`parse(java.lang.CharSequence query, java.lang.CharSequence field)`	Parses a query string, returning a `QueryNode`.
`QueryNode`	`Query(java.lang.CharSequence field)`
`void`	`ReInit(CharStream stream)`	Reinitialise.
`void`	`ReInit(StandardSyntaxParserTokenManager tm)`	Reinitialise.
`QueryNode`	`Term(java.lang.CharSequence field)`
`QueryNode`	`TopLevelQuery(java.lang.CharSequence field)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

token_source

public StandardSyntaxParserTokenManager token_source

Generated Token Manager.

token
```
public Token token
```
Current token.

jj_nt
```
public Token jj_nt
```
Next token.

jj_ntk
```
private int jj_ntk
```

jj_scanpos
```
private Token jj_scanpos
```

jj_lastpos
```
private Token jj_lastpos
```

jj_la
```
private int jj_la
```

jj_gen
```
private int jj_gen
```

jj_la1
```
private final int[] jj_la1
```

jj_la1_0
```
private static int[] jj_la1_0
```

jj_la1_1
```
private static int[] jj_la1_1
```

jj_2_rtns

private final StandardSyntaxParser.JJCalls[] jj_2_rtns

jj_rescan
```
private boolean jj_rescan
```

jj_gc
```
private int jj_gc
```

jj_ls

private final StandardSyntaxParser.LookaheadSuccess jj_ls

jj_expentries

private java.util.List<int[]> jj_expentries

jj_expentry
```
private int[] jj_expentry
```

jj_kind
```
private int jj_kind
```

jj_lasttokens
```
private int[] jj_lasttokens
```

jj_endpos
```
private int jj_endpos
```

Constructor Detail
- StandardSyntaxParser
```
public StandardSyntaxParser()
```
- StandardSyntaxParser
```
public StandardSyntaxParser(CharStream stream)
```
  Constructor with user supplied CharStream.
- StandardSyntaxParser
```
public StandardSyntaxParser(StandardSyntaxParserTokenManager tm)
```
  Constructor with generated Token Manager.

Method Detail

parse
```
public QueryNode parse(java.lang.CharSequence query,
                       java.lang.CharSequence field)
                throws QueryNodeParseException
```
Parses a query string, returning a QueryNode.

Specified by:

parse in interface SyntaxParser

Parameters:

query - the query string to be parsed.

field - - default field name

Returns:

QueryNode tree

Throws:

ParseException - if the parsing fails

QueryNodeParseException

Modifiers

public final ModifierQueryNode.Modifier Modifiers()
                                           throws ParseException

Throws:: ParseException

TopLevelQuery

public final QueryNode TopLevelQuery(java.lang.CharSequence field)
                              throws ParseException

Throws:: ParseException

Query

public final QueryNode Query(java.lang.CharSequence field)
                      throws ParseException

Throws:: ParseException

DisjQuery

public final QueryNode DisjQuery(java.lang.CharSequence field)
                          throws ParseException

Throws:: ParseException

ConjQuery

public final QueryNode ConjQuery(java.lang.CharSequence field)
                          throws ParseException

Throws:: ParseException

ModClause

public final QueryNode ModClause(java.lang.CharSequence field)
                          throws ParseException

Throws:: ParseException

Clause

public final QueryNode Clause(java.lang.CharSequence field)
                       throws ParseException

Throws:: ParseException

Term

public final QueryNode Term(java.lang.CharSequence field)
                     throws ParseException

Throws:: ParseException

jj_2_1
```
private boolean jj_2_1(int xla)
```

jj_2_2
```
private boolean jj_2_2(int xla)
```

jj_3R_12
```
private boolean jj_3R_12()
```

jj_3R_11
```
private boolean jj_3R_11()
```

jj_3_1
```
private boolean jj_3_1()
```

jj_3R_8
```
private boolean jj_3R_8()
```

jj_3R_10
```
private boolean jj_3R_10()
```

jj_3R_7
```
private boolean jj_3R_7()
```

jj_3R_9
```
private boolean jj_3R_9()
```

jj_3R_5
```
private boolean jj_3R_5()
```

jj_3R_4
```
private boolean jj_3R_4()
```

jj_3R_6
```
private boolean jj_3R_6()
```

jj_3_2
```
private boolean jj_3_2()
```

jj_la1_init_0
```
private static void jj_la1_init_0()
```

jj_la1_init_1
```
private static void jj_la1_init_1()
```

ReInit

public void ReInit(CharStream stream)

Reinitialise.

ReInit

public void ReInit(StandardSyntaxParserTokenManager tm)

Reinitialise.

jj_consume_token

private Token jj_consume_token(int kind)
                        throws ParseException

Throws:: ParseException

jj_scan_token

private boolean jj_scan_token(int kind)

getNextToken
```
public final Token getNextToken()
```
Get the next Token.

getToken

public final Token getToken(int index)

Get the specific Token.

jj_ntk
```
private int jj_ntk()
```

jj_add_error_token

private void jj_add_error_token(int kind,
                                int pos)

generateParseException

public ParseException generateParseException()

Generate ParseException.

enable_tracing
```
public final void enable_tracing()
```
Enable tracing.

disable_tracing
```
public final void disable_tracing()
```
Disable tracing.

jj_rescan_token
```
private void jj_rescan_token()
```

jj_save

private void jj_save(int index,
                     int xla)

Modifier and Type	Class	Description
`(package private) static class`	`StandardSyntaxParser.JJCalls`
`private static class`	`StandardSyntaxParser.LookaheadSuccess`

Class StandardSyntaxParser

Nested Class Summary

Field Summary

Fields inherited from interface org.apache.lucene.queryparser.flexible.standard.parser.StandardSyntaxParserConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

token_source

token

jj_nt

jj_ntk

jj_scanpos

jj_lastpos

jj_la

jj_gen

jj_la1

jj_la1_0

jj_la1_1

jj_2_rtns

jj_rescan

jj_gc

jj_ls

jj_expentries

jj_expentry

jj_kind

jj_lasttokens

jj_endpos

Constructor Detail

StandardSyntaxParser

StandardSyntaxParser

StandardSyntaxParser

Method Detail

parse

Modifiers

TopLevelQuery

Query

DisjQuery

ConjQuery

ModClause

Clause

Term

jj_2_1

jj_2_2

jj_3R_12

jj_3R_11

jj_3_1

jj_3R_8

jj_3R_10

jj_3R_7

jj_3R_9

jj_3R_5

jj_3R_4

jj_3R_6

jj_3_2

jj_la1_init_0

jj_la1_init_1

ReInit

ReInit

jj_consume_token

jj_scan_token

getNextToken

getToken

jj_ntk

jj_add_error_token

generateParseException

enable_tracing

disable_tracing

jj_rescan_token

jj_save