Home » lucene-3.0.1-src » org.apache.lucene.queryParser.core.parser » [javadoc | source]

    1   package org.apache.lucene.queryParser.core.parser;
    2   
    3   /**
    4    * Licensed to the Apache Software Foundation (ASF) under one or more
    5    * contributor license agreements.  See the NOTICE file distributed with
    6    * this work for additional information regarding copyright ownership.
    7    * The ASF licenses this file to You under the Apache License, Version 2.0
    8    * (the "License"); you may not use this file except in compliance with
    9    * the License.  You may obtain a copy of the License at
   10    *
   11    *     http://www.apache.org/licenses/LICENSE-2.0
   12    *
   13    * Unless required by applicable law or agreed to in writing, software
   14    * distributed under the License is distributed on an "AS IS" BASIS,
   15    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   16    * See the License for the specific language governing permissions and
   17    * limitations under the License.
   18    */
   19   
   20   import java.util.Locale;
   21   
   22   /**
   23    * A parser needs to implement {@link EscapeQuerySyntax} to allow the QueryNode
   24    * to escape the queries, when the toQueryString method is called.
   25    */
   26   public interface EscapeQuerySyntax {
   27     public enum Type {
   28       STRING, NORMAL;
   29     }
   30   
   31     /**
   32      * @param text
   33      *          - text to be escaped
   34      * @param locale
   35      *          - locale for the current query
   36      * @param type
   37      *          - select the type of escape operation to use
   38      * @return escaped text
   39      */
   40     CharSequence escape(CharSequence text, Locale locale, Type type);
   41   }

Home » lucene-3.0.1-src » org.apache.lucene.queryParser.core.parser » [javadoc | source]