lucene-java-3.5.0/lucene/contrib/queryparser/src/java/org/apache/lucene/queryParser/core/processors/NoChildOptimizationQueryNodeProcessor.java

   1 package org.apache.lucene.queryParser.core.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.queryParser.core.QueryNodeException;
  23 import org.apache.lucene.queryParser.core.nodes.BooleanQueryNode;
  24 import org.apache.lucene.queryParser.core.nodes.BoostQueryNode;
  25 import org.apache.lucene.queryParser.core.nodes.DeletedQueryNode;
  26 import org.apache.lucene.queryParser.core.nodes.MatchNoDocsQueryNode;
  27 import org.apache.lucene.queryParser.core.nodes.ModifierQueryNode;
  28 import org.apache.lucene.queryParser.core.nodes.QueryNode;
  29 import org.apache.lucene.queryParser.core.nodes.TokenizedPhraseQueryNode;
  30
  31 /**
  32  * <p>
  33  * A {@link NoChildOptimizationQueryNodeProcessor} removes every
  34  * BooleanQueryNode, BoostQueryNode, TokenizedPhraseQueryNode or
  35  * ModifierQueryNode that do not have a valid children.
  36  * </p>
  37  * <p>
  38  * Example: When the children of these nodes are removed for any reason then the
  39  * nodes may become invalid.
  40  * </p>
  41  */
  42 public class NoChildOptimizationQueryNodeProcessor extends
  43     QueryNodeProcessorImpl {
  44
  45   public NoChildOptimizationQueryNodeProcessor() {
  46     // empty constructor
  47   }
  48
  49   @Override
  50   protected QueryNode postProcessNode(QueryNode node) throws QueryNodeException {
  51
  52     if (node instanceof BooleanQueryNode || node instanceof BoostQueryNode
  53         || node instanceof TokenizedPhraseQueryNode
  54         || node instanceof ModifierQueryNode) {
  55
  56       List<QueryNode> children = node.getChildren();
  57
  58       if (children != null && children.size() > 0) {
  59
  60         for (QueryNode child : children) {
  61
  62           if (!(child instanceof DeletedQueryNode)) {
  63             return node;
  64           }
  65
  66         }
  67
  68       }
  69
  70       return new MatchNoDocsQueryNode();
  71
  72     }
  73
  74     return node;
  75
  76   }
  77
  78   @Override
  79   protected QueryNode preProcessNode(QueryNode node) throws QueryNodeException {
  80
  81     return node;
  82
  83   }
  84
  85   @Override
  86   protected List<QueryNode> setChildrenOrder(List<QueryNode> children)
  87       throws QueryNodeException {
  88
  89     return children;
  90
  91   }
  92
  93 }