QueryParser.jj
上传用户:zhangkuixh
上传日期:2013-09-30
资源大小:5473k
文件大小:31k
源码类别:

搜索引擎

开发平台:

C#

  1. /**
  2.  * Copyright 2004 The Apache Software Foundation
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *     http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  */
  16. options {
  17.   STATIC=false;
  18.   JAVA_UNICODE_ESCAPE=true;
  19.   USER_CHAR_STREAM=true;
  20. }
  21. PARSER_BEGIN(QueryParser)
  22. package org.apache.lucene.queryParser;
  23. import java.util.Vector;
  24. import java.io.*;
  25. import java.text.*;
  26. import java.util.*;
  27. import org.apache.lucene.index.Term;
  28. import org.apache.lucene.analysis.*;
  29. import org.apache.lucene.document.*;
  30. import org.apache.lucene.search.*;
  31. import org.apache.lucene.util.Parameter;
  32. /**
  33.  * This class is generated by JavaCC.  The most important method is
  34.  * {@link #parse(String)}.
  35.  *
  36.  * The syntax for query strings is as follows:
  37.  * A Query is a series of clauses.
  38.  * A clause may be prefixed by:
  39.  * <ul>
  40.  * <li> a plus (<code>+</code>) or a minus (<code>-</code>) sign, indicating
  41.  * that the clause is required or prohibited respectively; or
  42.  * <li> a term followed by a colon, indicating the field to be searched.
  43.  * This enables one to construct queries which search multiple fields.
  44.  * </ul>
  45.  *
  46.  * A clause may be either:
  47.  * <ul>
  48.  * <li> a term, indicating all the documents that contain this term; or
  49.  * <li> a nested query, enclosed in parentheses.  Note that this may be used
  50.  * with a <code>+</code>/<code>-</code> prefix to require any of a set of
  51.  * terms.
  52.  * </ul>
  53.  *
  54.  * Thus, in BNF, the query grammar is:
  55.  * <pre>
  56.  *   Query  ::= ( Clause )*
  57.  *   Clause ::= ["+", "-"] [&lt;TERM&gt; ":"] ( &lt;TERM&gt; | "(" Query ")" )
  58.  * </pre>
  59.  *
  60.  * <p>
  61.  * Examples of appropriately formatted queries can be found in the <a
  62.  * href="http://lucene.apache.org/java/docs/queryparsersyntax.html">query syntax
  63.  * documentation</a>.
  64.  * </p>
  65.  *
  66.  * <p>Note that QueryParser is <em>not</em> thread-safe.</p>
  67.  *
  68.  * @author Brian Goetz
  69.  * @author Peter Halacsy
  70.  * @author Tatu Saloranta
  71.  */
  72. public class QueryParser {
  73.   private static final int CONJ_NONE   = 0;
  74.   private static final int CONJ_AND    = 1;
  75.   private static final int CONJ_OR     = 2;
  76.   private static final int MOD_NONE    = 0;
  77.   private static final int MOD_NOT     = 10;
  78.   private static final int MOD_REQ     = 11;
  79.   /** @deprecated use {@link #OR_OPERATOR} instead */
  80.   public static final int DEFAULT_OPERATOR_OR  = 0;
  81.   /** @deprecated use {@link #AND_OPERATOR} instead */
  82.   public static final int DEFAULT_OPERATOR_AND = 1;
  83.   // make it possible to call setDefaultOperator() without accessing 
  84.   // the nested class:
  85.   /** Alternative form of QueryParser.Operator.AND */
  86.   public static final Operator AND_OPERATOR = Operator.AND;
  87.   /** Alternative form of QueryParser.Operator.OR */
  88.   public static final Operator OR_OPERATOR = Operator.OR;
  89.   /** The actual operator that parser uses to combine query terms */
  90.   private Operator operator = OR_OPERATOR;
  91.   boolean lowercaseExpandedTerms = true;
  92.   Analyzer analyzer;
  93.   String field;
  94.   int phraseSlop = 0;
  95.   float fuzzyMinSim = FuzzyQuery.defaultMinSimilarity;
  96.   int fuzzyPrefixLength = FuzzyQuery.defaultPrefixLength;
  97.   Locale locale = Locale.getDefault();
  98.   /** The default operator for parsing queries. 
  99.    * Use {@link QueryParser#setDefaultOperator} to change it.
  100.    */
  101.   static public final class Operator extends Parameter {
  102.     private Operator(String name) {
  103.       super(name);
  104.     }
  105.     static public final Operator OR = new Operator("OR");
  106.     static public final Operator AND = new Operator("AND");
  107.   }
  108.   /** Parses a query string, returning a {@link org.apache.lucene.search.Query}.
  109.    *  @param query  the query string to be parsed.
  110.    *  @param field  the default field for query terms.
  111.    *  @param analyzer   used to find terms in the query text.
  112.    *  @throws ParseException if the parsing fails
  113.    *
  114.    *  @deprecated Use an instance of QueryParser and the {@link #parse(String)} method instead.
  115.    */
  116.   static public Query parse(String query, String field, Analyzer analyzer)
  117.        throws ParseException {
  118.     QueryParser parser = new QueryParser(field, analyzer);
  119.     return parser.parse(query);
  120.   }
  121.   /** Constructs a query parser.
  122.    *  @param f  the default field for query terms.
  123.    *  @param a   used to find terms in the query text.
  124.    */
  125.   public QueryParser(String f, Analyzer a) {
  126.     this(new FastCharStream(new StringReader("")));
  127.     analyzer = a;
  128.     field = f;
  129.   }
  130.   /** Parses a query string, returning a {@link org.apache.lucene.search.Query}.
  131.    *  @param query  the query string to be parsed.
  132.    *  @throws ParseException if the parsing fails
  133.    */
  134.   public Query parse(String query) throws ParseException {
  135.     ReInit(new FastCharStream(new StringReader(query)));
  136.     try {
  137.       return Query(field);
  138.     }
  139.     catch (TokenMgrError tme) {
  140.       throw new ParseException(tme.getMessage());
  141.     }
  142.     catch (BooleanQuery.TooManyClauses tmc) {
  143.       throw new ParseException("Too many boolean clauses");
  144.     }
  145.   }
  146.   
  147.    /**
  148.    * @return Returns the analyzer.
  149.    */
  150.   public Analyzer getAnalyzer() {
  151.     return analyzer;
  152.   }
  153.   
  154.   /**
  155.    * @return Returns the field.
  156.    */
  157.   public String getField() {
  158.     return field;
  159.   }
  160.   
  161.    /**
  162.    * Get the minimal similarity for fuzzy queries.
  163.    */
  164.   public float getFuzzyMinSim() {
  165.       return fuzzyMinSim;
  166.   }
  167.   
  168.   /**
  169.    * Set the minimum similarity for fuzzy queries.
  170.    * Default is 0.5f.
  171.    */
  172.   public void setFuzzyMinSim(float fuzzyMinSim) {
  173.       this.fuzzyMinSim = fuzzyMinSim;
  174.   }
  175.   
  176.    /**
  177.    * Get the prefix length for fuzzy queries. 
  178.    * @return Returns the fuzzyPrefixLength.
  179.    */
  180.   public int getFuzzyPrefixLength() {
  181.     return fuzzyPrefixLength;
  182.   }
  183.   
  184.   /**
  185.    * Set the prefix length for fuzzy queries. Default is 0.
  186.    * @param fuzzyPrefixLength The fuzzyPrefixLength to set.
  187.    */
  188.   public void setFuzzyPrefixLength(int fuzzyPrefixLength) {
  189.     this.fuzzyPrefixLength = fuzzyPrefixLength;
  190.   }
  191.   /**
  192.    * Sets the default slop for phrases.  If zero, then exact phrase matches
  193.    * are required.  Default value is zero.
  194.    */
  195.   public void setPhraseSlop(int phraseSlop) {
  196.     this.phraseSlop = phraseSlop;
  197.   }
  198.   /**
  199.    * Gets the default slop for phrases.
  200.    */
  201.   public int getPhraseSlop() {
  202.     return phraseSlop;
  203.   }
  204.   /**
  205.    * Sets the boolean operator of the QueryParser.
  206.    * In default mode (<code>DEFAULT_OPERATOR_OR</code>) terms without any modifiers
  207.    * are considered optional: for example <code>capital of Hungary</code> is equal to
  208.    * <code>capital OR of OR Hungary</code>.<br/>
  209.    * In <code>DEFAULT_OPERATOR_AND</code> terms are considered to be in conjuction: the
  210.    * above mentioned query is parsed as <code>capital AND of AND Hungary</code>
  211.    * @deprecated use {@link #setDefaultOperator(QueryParser.Operator)} instead
  212.    */
  213.   public void setOperator(int op) {
  214.     if (op == DEFAULT_OPERATOR_AND)
  215.       this.operator = AND_OPERATOR;
  216.     else if (op == DEFAULT_OPERATOR_OR)
  217.       this.operator = OR_OPERATOR;
  218.     else
  219.       throw new IllegalArgumentException("Unknown operator " + op);
  220.   }
  221.   /**
  222.    * Sets the boolean operator of the QueryParser.
  223.    * In default mode (<code>OR_OPERATOR</code>) terms without any modifiers
  224.    * are considered optional: for example <code>capital of Hungary</code> is equal to
  225.    * <code>capital OR of OR Hungary</code>.<br/>
  226.    * In <code>AND_OPERATOR</code> mode terms are considered to be in conjuction: the
  227.    * above mentioned query is parsed as <code>capital AND of AND Hungary</code>
  228.    */
  229.   public void setDefaultOperator(Operator op) {
  230.     this.operator = op;
  231.   }
  232.   /**
  233.    * Gets implicit operator setting, which will be either DEFAULT_OPERATOR_AND
  234.    * or DEFAULT_OPERATOR_OR.
  235.    * @deprecated use {@link #getDefaultOperator()} instead
  236.    */
  237.   public int getOperator() {
  238.     if(operator == AND_OPERATOR)
  239.       return DEFAULT_OPERATOR_AND;
  240.     else if(operator == OR_OPERATOR)
  241.       return DEFAULT_OPERATOR_OR;
  242.     else
  243.       throw new IllegalStateException("Unknown operator " + operator);
  244.   }
  245.   /**
  246.    * Gets implicit operator setting, which will be either AND_OPERATOR
  247.    * or OR_OPERATOR.
  248.    */
  249.   public Operator getDefaultOperator() {
  250.     return operator;
  251.   }
  252.   /**
  253.    * Whether terms of wildcard, prefix, fuzzy and range queries are to be automatically
  254.    * lower-cased or not.  Default is <code>true</code>.
  255.    * @deprecated use {@link #setLowercaseExpandedTerms(boolean)} instead
  256.    */
  257.   public void setLowercaseWildcardTerms(boolean lowercaseExpandedTerms) {
  258.     this.lowercaseExpandedTerms = lowercaseExpandedTerms;
  259.   }
  260.   /**
  261.    * Whether terms of wildcard, prefix, fuzzy and range queries are to be automatically
  262.    * lower-cased or not.  Default is <code>true</code>.
  263.    */
  264.   public void setLowercaseExpandedTerms(boolean lowercaseExpandedTerms) {
  265.     this.lowercaseExpandedTerms = lowercaseExpandedTerms;
  266.   }
  267.   /**
  268.    * @deprecated use {@link #getLowercaseExpandedTerms()} instead
  269.    */
  270.   public boolean getLowercaseWildcardTerms() {
  271.     return lowercaseExpandedTerms;
  272.   }
  273.   /**
  274.    * @see #setLowercaseExpandedTerms(boolean)
  275.    */
  276.   public boolean getLowercaseExpandedTerms() {
  277.     return lowercaseExpandedTerms;
  278.   }
  279.   /**
  280.    * Set locale used by date range parsing.
  281.    */
  282.   public void setLocale(Locale locale) {
  283.     this.locale = locale;
  284.   }
  285.   /**
  286.    * Returns current locale, allowing access by subclasses.
  287.    */
  288.   public Locale getLocale() {
  289.     return locale;
  290.   }
  291.   protected void addClause(Vector clauses, int conj, int mods, Query q) {
  292.     boolean required, prohibited;
  293.     // If this term is introduced by AND, make the preceding term required,
  294.     // unless it's already prohibited
  295.     if (clauses.size() > 0 && conj == CONJ_AND) {
  296.       BooleanClause c = (BooleanClause) clauses.elementAt(clauses.size()-1);
  297.       if (!c.isProhibited())
  298.         c.setOccur(BooleanClause.Occur.MUST);
  299.     }
  300.     if (clauses.size() > 0 && operator == AND_OPERATOR && conj == CONJ_OR) {
  301.       // If this term is introduced by OR, make the preceding term optional,
  302.       // unless it's prohibited (that means we leave -a OR b but +a OR b-->a OR b)
  303.       // notice if the input is a OR b, first term is parsed as required; without
  304.       // this modification a OR b would parsed as +a OR b
  305.       BooleanClause c = (BooleanClause) clauses.elementAt(clauses.size()-1);
  306.       if (!c.isProhibited())
  307.         c.setOccur(BooleanClause.Occur.SHOULD);
  308.     }
  309.     // We might have been passed a null query; the term might have been
  310.     // filtered away by the analyzer.
  311.     if (q == null)
  312.       return;
  313.     if (operator == OR_OPERATOR) {
  314.       // We set REQUIRED if we're introduced by AND or +; PROHIBITED if
  315.       // introduced by NOT or -; make sure not to set both.
  316.       prohibited = (mods == MOD_NOT);
  317.       required = (mods == MOD_REQ);
  318.       if (conj == CONJ_AND && !prohibited) {
  319.         required = true;
  320.       }
  321.     } else {
  322.       // We set PROHIBITED if we're introduced by NOT or -; We set REQUIRED
  323.       // if not PROHIBITED and not introduced by OR
  324.       prohibited = (mods == MOD_NOT);
  325.       required   = (!prohibited && conj != CONJ_OR);
  326.     }
  327.     if (required && !prohibited)
  328.       clauses.addElement(new BooleanClause(q, BooleanClause.Occur.MUST));
  329.     else if (!required && !prohibited)
  330.       clauses.addElement(new BooleanClause(q, BooleanClause.Occur.SHOULD));
  331.     else if (!required && prohibited)
  332.       clauses.addElement(new BooleanClause(q, BooleanClause.Occur.MUST_NOT));
  333.     else
  334.       throw new RuntimeException("Clause cannot be both required and prohibited");
  335.   }
  336.   
  337.   /**
  338.    * Note that parameter analyzer is ignored. Calls inside the parser always
  339.    * use class member analyzer.
  340.    *
  341.    * @exception ParseException throw in overridden method to disallow
  342.    * @deprecated use {@link #getFieldQuery(String, String)}
  343.    */
  344.   protected Query getFieldQuery(String field,
  345.                                                     Analyzer analyzer,
  346.                                                     String queryText)  throws ParseException {
  347.     return getFieldQuery(field, queryText);
  348.   }
  349.   /**
  350.    * @exception ParseException throw in overridden method to disallow
  351.    */
  352.   protected Query getFieldQuery(String field, String queryText)  throws ParseException {
  353.     // Use the analyzer to get all the tokens, and then build a TermQuery,
  354.     // PhraseQuery, or nothing based on the term count
  355.     TokenStream source = analyzer.tokenStream(field, new StringReader(queryText));
  356.     Vector v = new Vector();
  357.     org.apache.lucene.analysis.Token t;
  358.     int positionCount = 0;
  359.     boolean severalTokensAtSamePosition = false;
  360.     while (true) {
  361.       try {
  362.         t = source.next();
  363.       }
  364.       catch (IOException e) {
  365.         t = null;
  366.       }
  367.       if (t == null)
  368.         break;
  369.       v.addElement(t);
  370.       if (t.getPositionIncrement() != 0)
  371.         positionCount += t.getPositionIncrement();
  372.       else
  373.         severalTokensAtSamePosition = true;
  374.     }
  375.     try {
  376.       source.close();
  377.     }
  378.     catch (IOException e) {
  379.       // ignore
  380.     }
  381.     if (v.size() == 0)
  382.       return null;
  383.     else if (v.size() == 1) {
  384.       t = (org.apache.lucene.analysis.Token) v.elementAt(0);
  385.       return new TermQuery(new Term(field, t.termText()));
  386.     } else {
  387.       if (severalTokensAtSamePosition) {
  388.         if (positionCount == 1) {
  389.           // no phrase query:
  390.           BooleanQuery q = new BooleanQuery(true);
  391.           for (int i = 0; i < v.size(); i++) {
  392.             t = (org.apache.lucene.analysis.Token) v.elementAt(i);
  393.             TermQuery currentQuery = new TermQuery(
  394.                 new Term(field, t.termText()));
  395.             q.add(currentQuery, BooleanClause.Occur.SHOULD);
  396.           }
  397.           return q;
  398.         }
  399.         else {
  400.           // phrase query:
  401.           MultiPhraseQuery mpq = new MultiPhraseQuery();
  402.           List multiTerms = new ArrayList();
  403.           for (int i = 0; i < v.size(); i++) {
  404.             t = (org.apache.lucene.analysis.Token) v.elementAt(i);
  405.             if (t.getPositionIncrement() == 1 && multiTerms.size() > 0) {
  406.               mpq.add((Term[])multiTerms.toArray(new Term[0]));
  407.               multiTerms.clear();
  408.             }
  409.             multiTerms.add(new Term(field, t.termText()));
  410.           }
  411.           mpq.add((Term[])multiTerms.toArray(new Term[0]));
  412.           return mpq;
  413.         }
  414.       }
  415.       else {
  416.         PhraseQuery q = new PhraseQuery();
  417.         q.setSlop(phraseSlop);
  418.         for (int i = 0; i < v.size(); i++) {
  419.           q.add(new Term(field, ((org.apache.lucene.analysis.Token) 
  420.               v.elementAt(i)).termText()));
  421.         }
  422.         return q;
  423.       }
  424.     }
  425.   }
  426.   
  427.   /**
  428.    * Note that parameter analyzer is ignored. Calls inside the parser always
  429.    * use class member analyzer.
  430.    *
  431.    * @exception ParseException throw in overridden method to disallow
  432.    * @deprecated use {@link #getFieldQuery(String, String, int)}
  433.    */
  434.   protected Query getFieldQuery(String field,
  435.                                                     Analyzer analyzer,
  436.                                                     String queryText,
  437.                                                     int slop) throws ParseException {
  438.     return getFieldQuery(field, queryText, slop);
  439.   }
  440.   /**
  441.    * Base implementation delegates to {@link #getFieldQuery(String,String)}.
  442.    * This method may be overridden, for example, to return
  443.    * a SpanNearQuery instead of a PhraseQuery.
  444.    *
  445.    * @exception ParseException throw in overridden method to disallow
  446.    */
  447.   protected Query getFieldQuery(String field, String queryText, int slop) 
  448.    throws ParseException {
  449.     Query query = getFieldQuery(field, queryText);
  450.     if (query instanceof PhraseQuery) {
  451.       ((PhraseQuery) query).setSlop(slop);
  452.     }
  453.     if (query instanceof MultiPhraseQuery) {
  454.       ((MultiPhraseQuery) query).setSlop(slop);
  455.     }
  456.     return query;
  457.   }
  458.   
  459.   /**
  460.    * Note that parameter analyzer is ignored. Calls inside the parser always
  461.    * use class member analyzer.
  462.    *
  463.    * @exception ParseException throw in overridden method to disallow
  464.    * @deprecated use {@link #getRangeQuery(String, String, String, boolean)}
  465.    */
  466.   protected Query getRangeQuery(String field,
  467.       Analyzer analyzer,
  468.       String part1,
  469.       String part2,
  470.       boolean inclusive) throws ParseException {
  471.     return getRangeQuery(field, part1, part2, inclusive);
  472.   }
  473.   /**
  474.    * @exception ParseException throw in overridden method to disallow
  475.    */
  476.   protected Query getRangeQuery(String field,
  477.                                 String part1,
  478.                                 String part2,
  479.                                 boolean inclusive) throws ParseException
  480.   {
  481.     if (lowercaseExpandedTerms) {
  482.       part1 = part1.toLowerCase();
  483.       part2 = part2.toLowerCase();
  484.     }
  485.     try {
  486.       DateFormat df = DateFormat.getDateInstance(DateFormat.SHORT, locale);
  487.       df.setLenient(true);
  488.       Date d1 = df.parse(part1);
  489.       Date d2 = df.parse(part2);
  490.       part1 = DateField.dateToString(d1);
  491.       part2 = DateField.dateToString(d2);
  492.     }
  493.     catch (Exception e) { }
  494.     return new RangeQuery(new Term(field, part1),
  495.                           new Term(field, part2),
  496.                           inclusive);
  497.   }
  498.   /**
  499.    * Factory method for generating query, given a set of clauses.
  500.    * By default creates a boolean query composed of clauses passed in.
  501.    *
  502.    * Can be overridden by extending classes, to modify query being
  503.    * returned.
  504.    *
  505.    * @param clauses Vector that contains {@link BooleanClause} instances
  506.    *    to join.
  507.    *
  508.    * @return Resulting {@link Query} object.
  509.    * @exception ParseException throw in overridden method to disallow
  510.    */
  511.   protected Query getBooleanQuery(Vector clauses) throws ParseException {
  512.     return getBooleanQuery(clauses, false);
  513.   }
  514.   /**
  515.    * Factory method for generating query, given a set of clauses.
  516.    * By default creates a boolean query composed of clauses passed in.
  517.    *
  518.    * Can be overridden by extending classes, to modify query being
  519.    * returned.
  520.    *
  521.    * @param clauses Vector that contains {@link BooleanClause} instances
  522.    *    to join.
  523.    * @param disableCoord true if coord scoring should be disabled.
  524.    *
  525.    * @return Resulting {@link Query} object.
  526.    * @exception ParseException throw in overridden method to disallow
  527.    */
  528.   protected Query getBooleanQuery(Vector clauses, boolean disableCoord)
  529.     throws ParseException
  530.   {
  531.     BooleanQuery query = new BooleanQuery(disableCoord);
  532.     for (int i = 0; i < clauses.size(); i++) {
  533.   query.add((BooleanClause)clauses.elementAt(i));
  534.     }
  535.     return query;
  536.   }
  537.   /**
  538.    * Factory method for generating a query. Called when parser
  539.    * parses an input term token that contains one or more wildcard
  540.    * characters (? and *), but is not a prefix term token (one
  541.    * that has just a single * character at the end)
  542.    *<p>
  543.    * Depending on settings, prefix term may be lower-cased
  544.    * automatically. It will not go through the default Analyzer,
  545.    * however, since normal Analyzers are unlikely to work properly
  546.    * with wildcard templates.
  547.    *<p>
  548.    * Can be overridden by extending classes, to provide custom handling for
  549.    * wildcard queries, which may be necessary due to missing analyzer calls.
  550.    *
  551.    * @param field Name of the field query will use.
  552.    * @param termStr Term token that contains one or more wild card
  553.    *   characters (? or *), but is not simple prefix term
  554.    *
  555.    * @return Resulting {@link Query} built for the term
  556.    * @exception ParseException throw in overridden method to disallow
  557.    */
  558.   protected Query getWildcardQuery(String field, String termStr) throws ParseException
  559.   {
  560.     if (lowercaseExpandedTerms) {
  561.       termStr = termStr.toLowerCase();
  562.     }
  563.     Term t = new Term(field, termStr);
  564.     return new WildcardQuery(t);
  565.   }
  566.   /**
  567.    * Factory method for generating a query (similar to
  568.    * {@link #getWildcardQuery}). Called when parser parses an input term
  569.    * token that uses prefix notation; that is, contains a single '*' wildcard
  570.    * character as its last character. Since this is a special case
  571.    * of generic wildcard term, and such a query can be optimized easily,
  572.    * this usually results in a different query object.
  573.    *<p>
  574.    * Depending on settings, a prefix term may be lower-cased
  575.    * automatically. It will not go through the default Analyzer,
  576.    * however, since normal Analyzers are unlikely to work properly
  577.    * with wildcard templates.
  578.    *<p>
  579.    * Can be overridden by extending classes, to provide custom handling for
  580.    * wild card queries, which may be necessary due to missing analyzer calls.
  581.    *
  582.    * @param field Name of the field query will use.
  583.    * @param termStr Term token to use for building term for the query
  584.    *    (<b>without</b> trailing '*' character!)
  585.    *
  586.    * @return Resulting {@link Query} built for the term
  587.    * @exception ParseException throw in overridden method to disallow
  588.    */
  589.   protected Query getPrefixQuery(String field, String termStr) throws ParseException
  590.   {
  591.     if (lowercaseExpandedTerms) {
  592.       termStr = termStr.toLowerCase();
  593.     }
  594.     Term t = new Term(field, termStr);
  595.     return new PrefixQuery(t);
  596.   }
  597.   
  598.  /**
  599.    * @deprecated use {@link #getFuzzyQuery(String, String, float)}
  600.    */
  601.   protected Query getFuzzyQuery(String field, String termStr) throws ParseException {
  602.     return getFuzzyQuery(field, termStr, fuzzyMinSim);
  603.   }
  604.   
  605.    /**
  606.    * Factory method for generating a query (similar to
  607.    * {@link #getWildcardQuery}). Called when parser parses
  608.    * an input term token that has the fuzzy suffix (~) appended.
  609.    *
  610.    * @param field Name of the field query will use.
  611.    * @param termStr Term token to use for building term for the query
  612.    *
  613.    * @return Resulting {@link Query} built for the term
  614.    * @exception ParseException throw in overridden method to disallow
  615.    */
  616.   protected Query getFuzzyQuery(String field, String termStr, float minSimilarity) throws ParseException
  617.   {
  618.     if (lowercaseExpandedTerms) {
  619.       termStr = termStr.toLowerCase();
  620.     }
  621.     Term t = new Term(field, termStr);
  622.     return new FuzzyQuery(t, minSimilarity, fuzzyPrefixLength);
  623.   }
  624.   /**
  625.    * Returns a String where the escape char has been
  626.    * removed, or kept only once if there was a double escape.
  627.    */
  628.   private String discardEscapeChar(String input) {
  629.     char[] caSource = input.toCharArray();
  630.     char[] caDest = new char[caSource.length];
  631.     int j = 0;
  632.     for (int i = 0; i < caSource.length; i++) {
  633.       if ((caSource[i] != '\') || (i > 0 && caSource[i-1] == '\')) {
  634.         caDest[j++]=caSource[i];
  635.       }
  636.     }
  637.     return new String(caDest, 0, j);
  638.   }
  639.   /**
  640.    * Returns a String where those characters that QueryParser
  641.    * expects to be escaped are escaped by a preceding <code></code>.
  642.    */
  643.   public static String escape(String s) {
  644.     StringBuffer sb = new StringBuffer();
  645.     for (int i = 0; i < s.length(); i++) {
  646.       char c = s.charAt(i);
  647.       // NOTE: keep this in sync with _ESCAPED_CHAR below!
  648.       if (c == '\' || c == '+' || c == '-' || c == '!' || c == '(' || c == ')' || c == ':'
  649.         || c == '^' || c == '[' || c == ']' || c == '"' || c == '{' || c == '}' || c == '~'
  650.         || c == '*' || c == '?') {
  651.         sb.append('\');
  652.       }
  653.       sb.append(c);
  654.     }
  655.     return sb.toString();
  656.   }
  657.   /**
  658.    * Command line tool to test QueryParser, using {@link org.apache.lucene.analysis.SimpleAnalyzer}.
  659.    * Usage:<br>
  660.    * <code>java org.apache.lucene.queryParser.QueryParser &lt;input&gt;</code>
  661.    */
  662.   public static void main(String[] args) throws Exception {
  663.     if (args.length == 0) {
  664.       System.out.println("Usage: java org.apache.lucene.queryParser.QueryParser <input>");
  665.       System.exit(0);
  666.     }
  667.     QueryParser qp = new QueryParser("field",
  668.                            new org.apache.lucene.analysis.SimpleAnalyzer());
  669.     Query q = qp.parse(args[0]);
  670.     System.out.println(q.toString("field"));
  671.   }
  672. }
  673. PARSER_END(QueryParser)
  674. /* ***************** */
  675. /* Token Definitions */
  676. /* ***************** */
  677. <*> TOKEN : {
  678.   <#_NUM_CHAR:   ["0"-"9"] >
  679. // NOTE: keep this in sync with escape(String) above!
  680. | <#_ESCAPED_CHAR: "\" [ "\", "+", "-", "!", "(", ")", ":", "^",
  681.                           "[", "]", """, "{", "}", "~", "*", "?" ] >
  682. | <#_TERM_START_CHAR: ( ~[ " ", "t", "n", "r", "+", "-", "!", "(", ")", ":", "^",
  683.                            "[", "]", """, "{", "}", "~", "*", "?" ]
  684.                        | <_ESCAPED_CHAR> ) >
  685. | <#_TERM_CHAR: ( <_TERM_START_CHAR> | <_ESCAPED_CHAR> | "-" | "+" ) >
  686. | <#_WHITESPACE: ( " " | "t" | "n" | "r") >
  687. }
  688. <DEFAULT, RangeIn, RangeEx> SKIP : {
  689.   <<_WHITESPACE>>
  690. }
  691. // OG: to support prefix queries:
  692. // http://issues.apache.org/bugzilla/show_bug.cgi?id=12137
  693. // Change from:
  694. //
  695. // | <WILDTERM:  <_TERM_START_CHAR>
  696. //              (<_TERM_CHAR> | ( [ "*", "?" ] ))* >
  697. // To:
  698. //
  699. // (<_TERM_START_CHAR> | [ "*", "?" ]) (<_TERM_CHAR> | ( [ "*", "?" ] ))* >
  700. <DEFAULT> TOKEN : {
  701.   <AND:       ("AND" | "&&") >
  702. | <OR:        ("OR" | "||") >
  703. | <NOT:       ("NOT" | "!") >
  704. | <PLUS:      "+" >
  705. | <MINUS:     "-" >
  706. | <LPAREN:    "(" >
  707. | <RPAREN:    ")" >
  708. | <COLON:     ":" >
  709. | <CARAT:     "^" > : Boost
  710. | <QUOTED:     """ (~["""])+ """>
  711. | <TERM:      <_TERM_START_CHAR> (<_TERM_CHAR>)*  >
  712. | <FUZZY_SLOP:     "~" ( (<_NUM_CHAR>)+ ( "." (<_NUM_CHAR>)+ )? )? >
  713. | <PREFIXTERM:  <_TERM_START_CHAR> (<_TERM_CHAR>)* "*" >
  714. | <WILDTERM:  <_TERM_START_CHAR>
  715.               (<_TERM_CHAR> | ( [ "*", "?" ] ))* >
  716. | <RANGEIN_START: "[" > : RangeIn
  717. | <RANGEEX_START: "{" > : RangeEx
  718. }
  719. <Boost> TOKEN : {
  720. <NUMBER:    (<_NUM_CHAR>)+ ( "." (<_NUM_CHAR>)+ )? > : DEFAULT
  721. }
  722. <RangeIn> TOKEN : {
  723. <RANGEIN_TO: "TO">
  724. | <RANGEIN_END: "]"> : DEFAULT
  725. | <RANGEIN_QUOTED: """ (~["""])+ """>
  726. | <RANGEIN_GOOP: (~[ " ", "]" ])+ >
  727. }
  728. <RangeEx> TOKEN : {
  729. <RANGEEX_TO: "TO">
  730. | <RANGEEX_END: "}"> : DEFAULT
  731. | <RANGEEX_QUOTED: """ (~["""])+ """>
  732. | <RANGEEX_GOOP: (~[ " ", "}" ])+ >
  733. }
  734. // *   Query  ::= ( Clause )*
  735. // *   Clause ::= ["+", "-"] [<TERM> ":"] ( <TERM> | "(" Query ")" )
  736. int Conjunction() : {
  737.   int ret = CONJ_NONE;
  738. }
  739. {
  740.   [
  741.     <AND> { ret = CONJ_AND; }
  742.     | <OR>  { ret = CONJ_OR; }
  743.   ]
  744.   { return ret; }
  745. }
  746. int Modifiers() : {
  747.   int ret = MOD_NONE;
  748. }
  749. {
  750.   [
  751.      <PLUS> { ret = MOD_REQ; }
  752.      | <MINUS> { ret = MOD_NOT; }
  753.      | <NOT> { ret = MOD_NOT; }
  754.   ]
  755.   { return ret; }
  756. }
  757. Query Query(String field) :
  758. {
  759.   Vector clauses = new Vector();
  760.   Query q, firstQuery=null;
  761.   int conj, mods;
  762. }
  763. {
  764.   mods=Modifiers() q=Clause(field)
  765.   {
  766.     addClause(clauses, CONJ_NONE, mods, q);
  767.     if (mods == MOD_NONE)
  768.         firstQuery=q;
  769.   }
  770.   (
  771.     conj=Conjunction() mods=Modifiers() q=Clause(field)
  772.     { addClause(clauses, conj, mods, q); }
  773.   )*
  774.     {
  775.       if (clauses.size() == 1 && firstQuery != null)
  776.         return firstQuery;
  777.       else {
  778.   return getBooleanQuery(clauses);
  779.       }
  780.     }
  781. }
  782. Query Clause(String field) : {
  783.   Query q;
  784.   Token fieldToken=null, boost=null;
  785. }
  786. {
  787.   [
  788.     LOOKAHEAD(2)
  789.     fieldToken=<TERM> <COLON> {
  790.       field=discardEscapeChar(fieldToken.image);
  791.     }
  792.   ]
  793.   (
  794.    q=Term(field)
  795.    | <LPAREN> q=Query(field) <RPAREN> (<CARAT> boost=<NUMBER>)?
  796.   )
  797.     {
  798.       if (boost != null) {
  799.         float f = (float)1.0;
  800.   try {
  801.     f = Float.valueOf(boost.image).floatValue();
  802.           q.setBoost(f);
  803.   } catch (Exception ignored) { }
  804.       }
  805.       return q;
  806.     }
  807. }
  808. Query Term(String field) : {
  809.   Token term, boost=null, fuzzySlop=null, goop1, goop2;
  810.   boolean prefix = false;
  811.   boolean wildcard = false;
  812.   boolean fuzzy = false;
  813.   boolean rangein = false;
  814.   Query q;
  815. }
  816. {
  817.   (
  818.      (
  819.        term=<TERM>
  820.        | term=<PREFIXTERM> { prefix=true; }
  821.        | term=<WILDTERM> { wildcard=true; }
  822.        | term=<NUMBER>
  823.      )
  824.      [ fuzzySlop=<FUZZY_SLOP> { fuzzy=true; } ]
  825.      [ <CARAT> boost=<NUMBER> [ fuzzySlop=<FUZZY_SLOP> { fuzzy=true; } ] ]
  826.      {
  827.        String termImage=discardEscapeChar(term.image);
  828.        if (wildcard) {
  829.        q = getWildcardQuery(field, termImage);
  830.        } else if (prefix) {
  831.          q = getPrefixQuery(field,
  832.            discardEscapeChar(term.image.substring
  833.           (0, term.image.length()-1)));
  834.        } else if (fuzzy) {
  835.           float fms = fuzzyMinSim;
  836.           try {
  837.             fms = Float.valueOf(fuzzySlop.image.substring(1)).floatValue();
  838.           } catch (Exception ignored) { }
  839.          if(fms < 0.0f || fms > 1.0f){
  840.            throw new ParseException("Minimum similarity for a FuzzyQuery has to be between 0.0f and 1.0f !");
  841.          }
  842.          if(fms == fuzzyMinSim)
  843.            q = getFuzzyQuery(field, termImage);
  844.          else
  845.            q = getFuzzyQuery(field, termImage, fms);
  846.        } else {
  847.          q = getFieldQuery(field, analyzer, termImage);
  848.        }
  849.      }
  850.      | ( <RANGEIN_START> ( goop1=<RANGEIN_GOOP>|goop1=<RANGEIN_QUOTED> )
  851.          [ <RANGEIN_TO> ] ( goop2=<RANGEIN_GOOP>|goop2=<RANGEIN_QUOTED> )
  852.          <RANGEIN_END> )
  853.        [ <CARAT> boost=<NUMBER> ]
  854.         {
  855.           if (goop1.kind == RANGEIN_QUOTED) {
  856.             goop1.image = goop1.image.substring(1, goop1.image.length()-1);
  857.           } else {
  858.             goop1.image = discardEscapeChar(goop1.image);
  859.           }
  860.           if (goop2.kind == RANGEIN_QUOTED) {
  861.             goop2.image = goop2.image.substring(1, goop2.image.length()-1);
  862.       } else {
  863.         goop2.image = discardEscapeChar(goop2.image);
  864.       }
  865.           q = getRangeQuery(field, analyzer, goop1.image, goop2.image, true);
  866.         }
  867.      | ( <RANGEEX_START> ( goop1=<RANGEEX_GOOP>|goop1=<RANGEEX_QUOTED> )
  868.          [ <RANGEEX_TO> ] ( goop2=<RANGEEX_GOOP>|goop2=<RANGEEX_QUOTED> )
  869.          <RANGEEX_END> )
  870.        [ <CARAT> boost=<NUMBER> ]
  871.         {
  872.           if (goop1.kind == RANGEEX_QUOTED) {
  873.             goop1.image = goop1.image.substring(1, goop1.image.length()-1);
  874.           } else {
  875.             goop1.image = discardEscapeChar(goop1.image);
  876.           }
  877.           if (goop2.kind == RANGEEX_QUOTED) {
  878.             goop2.image = goop2.image.substring(1, goop2.image.length()-1);
  879.       } else {
  880.         goop2.image = discardEscapeChar(goop2.image);
  881.       }
  882.           q = getRangeQuery(field, analyzer, goop1.image, goop2.image, false);
  883.         }
  884.      | term=<QUOTED>
  885.        [ fuzzySlop=<FUZZY_SLOP> ]
  886.        [ <CARAT> boost=<NUMBER> ]
  887.        {
  888.          int s = phraseSlop;
  889.          if (fuzzySlop != null) {
  890.            try {
  891.              s = Float.valueOf(fuzzySlop.image.substring(1)).intValue();
  892.            }
  893.            catch (Exception ignored) { }
  894.          }
  895.          q = getFieldQuery(field, analyzer, term.image.substring(1, term.image.length()-1), s);
  896.        }
  897.   )
  898.   {
  899.     if (boost != null) {
  900.       float f = (float) 1.0;
  901.       try {
  902.         f = Float.valueOf(boost.image).floatValue();
  903.       }
  904.       catch (Exception ignored) {
  905.     /* Should this be handled somehow? (defaults to "no boost", if
  906.      * boost number is invalid)
  907.      */
  908.       }
  909.       // avoid boosting null queries, such as those caused by stop words
  910.       if (q != null) {
  911.         q.setBoost(f);
  912.       }
  913.     }
  914.     return q;
  915.   }
  916. }