All Implemented Interfaces:
QueryParserConstants, CommonQueryParserConfiguration
Direct Known Subclasses:
ComplexPhraseQueryParser, ExtendableQueryParser, MultiFieldQueryParser

public class QueryParser extends QueryParserBase implements QueryParserConstants
This class is generated by JavaCC. The most important method is QueryParserBase.parse(String). The syntax for query strings is as follows: A Query is a series of clauses. A clause may be prefixed by:
  • a plus (+) or a minus (-) sign, indicating that the clause is required or prohibited respectively; or
  • a term followed by a colon, indicating the field to be searched. This enables one to construct queries which search multiple fields.
A clause may be either:
  • a term, indicating all the documents that contain this term; or
  • a nested query, enclosed in parentheses. Note that this may be used with a +/- prefix to require any of a set of terms.
Thus, in BNF, the query grammar is:
   Query  ::= ( Clause )*
   Clause ::= ["+", "-"] [<TERM> ":"] ( <TERM> | "(" Query ")" )
 

Examples of appropriately formatted queries can be found in the query syntax documentation.

In TermRangeQuerys, QueryParser tries to detect date values, e.g. date:[6/1/2005 TO 6/4/2005] produces a range query that searches for "date" fields between 2005-06-01 and 2005-06-04. Note that the format of the accepted input depends on the locale. A DateTools.Resolution has to be set, if you want to use DateTools for date conversion.

The date resolution that shall be used for RangeQueries can be set using QueryParserBase.setDateResolution(DateTools.Resolution) or QueryParserBase.setDateResolution(String, DateTools.Resolution). The former sets the default date resolution for all fields, whereas the latter can be used to set field specific date resolutions. Field specific date resolutions take, if set, precedence over the default date resolution.

If you don't use DateTools in your index, you can create your own query parser that inherits QueryParser and overwrites QueryParserBase.getRangeQuery(String, String, String, boolean, boolean) to use a different method for date conversion.

Note that QueryParser is not thread-safe.

NOTE: there is a new QueryParser in contrib, which matches the same syntax as this class, but is more modular, enabling substantial customization to how a query is created.

  • Field Details

    • DEFAULT_SPLIT_ON_WHITESPACE

      public static final boolean DEFAULT_SPLIT_ON_WHITESPACE
      default split on whitespace behavior
      See Also:
    • splitOnWhitespace

      private boolean splitOnWhitespace
    • disallowedPostMultiTerm

      private static IntHashSet disallowedPostMultiTerm
    • token_source

      public QueryParserTokenManager 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_lookingAhead

      private boolean jj_lookingAhead
      Whether we are looking ahead.
    • jj_semLA

      private boolean jj_semLA
    • 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 QueryParser.JJCalls[] jj_2_rtns
    • jj_rescan

      private boolean jj_rescan
    • jj_gc

      private int jj_gc
    • jj_ls

      private static final QueryParser.LookaheadSuccess jj_ls
    • jj_expentries

      private 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
    • trace_enabled

      private boolean trace_enabled
  • Constructor Details

    • QueryParser

      public QueryParser(String f, Analyzer a)
      Create a query parser.
      Parameters:
      f - the default field for query terms.
      a - used to find terms in the query text.
    • QueryParser

      protected QueryParser(CharStream stream)
      Constructor with user supplied CharStream.
    • QueryParser

      protected QueryParser(QueryParserTokenManager tm)
      Constructor with generated Token Manager.
  • Method Details

    • setAutoGeneratePhraseQueries

      public void setAutoGeneratePhraseQueries(boolean value)
      Set to true if phrase queries will be automatically generated when the analyzer returns more than one term from whitespace delimited text. NOTE: this behavior may not be suitable for all languages.

      Set to false if phrase queries should only be generated when surrounded by double quotes.

      The combination splitOnWhitespace=false and autoGeneratePhraseQueries=true is disallowed. See LUCENE-7533.

      Overrides:
      setAutoGeneratePhraseQueries in class QueryParserBase
    • getSplitOnWhitespace

      public boolean getSplitOnWhitespace()
      See Also:
    • setSplitOnWhitespace

      public void setSplitOnWhitespace(boolean splitOnWhitespace)
      Whether query text should be split on whitespace prior to analysis. Default is false.

      The combination splitOnWhitespace=false and autoGeneratePhraseQueries=true is disallowed. See LUCENE-7533.

    • allowedPostMultiTerm

      private static boolean allowedPostMultiTerm(int tokenKind)
    • Conjunction

      public final int Conjunction() throws ParseException
      Throws:
      ParseException
    • Modifiers

      public final int Modifiers() throws ParseException
      Throws:
      ParseException
    • TopLevelQuery

      public final Query TopLevelQuery(String field) throws ParseException
      Specified by:
      TopLevelQuery in class QueryParserBase
      Throws:
      ParseException
    • Query

      public final Query Query(String field) throws ParseException
      Throws:
      ParseException
    • Clause

      public final Query Clause(String field) throws ParseException
      Throws:
      ParseException
    • Term

      public final Query Term(String field) throws ParseException
      Throws:
      ParseException
    • MultiTerm

      public final Query MultiTerm(String field, List<BooleanClause> clauses) throws ParseException
      Returns the first query if splitOnWhitespace=true or otherwise the entire produced query
      Throws:
      ParseException
    • jj_2_1

      private boolean jj_2_1(int xla)
    • jj_2_2

      private boolean jj_2_2(int xla)
    • jj_2_3

      private boolean jj_2_3(int xla)
    • jj_3R_MultiTerm_381_3_3

      private boolean jj_3R_MultiTerm_381_3_3()
    • jj_3R_MultiTerm_389_3_6

      private boolean jj_3R_MultiTerm_389_3_6()
    • jj_3R_Clause_306_9_5

      private boolean jj_3R_Clause_306_9_5()
    • jj_3R_Clause_305_7_4

      private boolean jj_3R_Clause_305_7_4()
    • jj_3_2

      private boolean jj_3_2()
    • jj_3_1

      private boolean jj_3_1()
    • jj_3R_MultiTerm_391_5_7

      private boolean jj_3R_MultiTerm_391_5_7()
    • jj_3_3

      private boolean jj_3_3()
    • 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.
      Specified by:
      ReInit in class QueryParserBase
    • ReInit

      public void ReInit(QueryParserTokenManager 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_f

      private int jj_ntk_f()
    • jj_add_error_token

      private void jj_add_error_token(int kind, int pos)
    • generateParseException

      public ParseException generateParseException()
      Generate ParseException.
    • trace_enabled

      public final boolean trace_enabled()
      Trace enabled.
    • 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)