lucene-java-3.5.0/lucene/contrib/queryparser/src/java/org/apache/lucene/queryParser/standard/processors/AllowLeadingWildcardProcessor.java

   1 package org.apache.lucene.queryParser.standard.processors;
   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.List;
  21
  22 import org.apache.lucene.messages.MessageImpl;
  23 import org.apache.lucene.queryParser.core.QueryNodeException;
  24 import org.apache.lucene.queryParser.core.config.QueryConfigHandler;
  25 import org.apache.lucene.queryParser.core.messages.QueryParserMessages;
  26 import org.apache.lucene.queryParser.core.nodes.QueryNode;
  27 import org.apache.lucene.queryParser.core.processors.QueryNodeProcessorImpl;
  28 import org.apache.lucene.queryParser.core.util.UnescapedCharSequence;
  29 import org.apache.lucene.queryParser.standard.config.StandardQueryConfigHandler.ConfigurationKeys;
  30 import org.apache.lucene.queryParser.standard.nodes.WildcardQueryNode;
  31 import org.apache.lucene.queryParser.standard.parser.EscapeQuerySyntaxImpl;
  32
  33 /**
  34  * This processor verifies if
  35  * {@link ConfigurationKeys#ALLOW_LEADING_WILDCARD} is defined in the
  36  * {@link QueryConfigHandler}. If it is and leading wildcard is not allowed, it
  37  * looks for every {@link WildcardQueryNode} contained in the query node tree
  38  * and throws an exception if any of them has a leading wildcard ('*' or '?'). <br/>
  39  *
  40  * @see ConfigurationKeys#ALLOW_LEADING_WILDCARD
  41  */
  42 public class AllowLeadingWildcardProcessor extends QueryNodeProcessorImpl {
  43
  44   public AllowLeadingWildcardProcessor() {
  45     // empty constructor
  46   }
  47
  48   @Override
  49   public QueryNode process(QueryNode queryTree) throws QueryNodeException {
  50     Boolean allowsLeadingWildcard = getQueryConfigHandler().get(ConfigurationKeys.ALLOW_LEADING_WILDCARD);
  51
  52     if (allowsLeadingWildcard != null) {
  53
  54       if (!allowsLeadingWildcard) {
  55         return super.process(queryTree);
  56       }
  57
  58     }
  59
  60     return queryTree;
  61   }
  62
  63   @Override
  64   protected QueryNode postProcessNode(QueryNode node) throws QueryNodeException {
  65
  66     if (node instanceof WildcardQueryNode) {
  67       WildcardQueryNode wildcardNode = (WildcardQueryNode) node;
  68
  69       if (wildcardNode.getText().length() > 0) {
  70
  71         // Validate if the wildcard was escaped
  72         if (UnescapedCharSequence.wasEscaped(wildcardNode.getText(), 0))
  73           return node;
  74
  75         switch (wildcardNode.getText().charAt(0)) {
  76           case '*':
  77           case '?':
  78             throw new QueryNodeException(new MessageImpl(
  79                 QueryParserMessages.LEADING_WILDCARD_NOT_ALLOWED, node
  80                     .toQueryString(new EscapeQuerySyntaxImpl())));
  81         }
  82       }
  83
  84     }
  85
  86     return node;
  87
  88   }
  89
  90   @Override
  91   protected QueryNode preProcessNode(QueryNode node) throws QueryNodeException {
  92
  93     return node;
  94
  95   }
  96
  97   @Override
  98   protected List<QueryNode> setChildrenOrder(List<QueryNode> children)
  99       throws QueryNodeException {
 100
 101     return children;
 102
 103   }
 104
 105 }