lucene-java-3.5.0/lucene/contrib/queryparser/src/java/org/apache/lucene/queryParser/core/nodes/GroupQueryNode.java

   1 package org.apache.lucene.queryParser.core.nodes;
   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.ArrayList;
  21 import java.util.List;
  22
  23 import org.apache.lucene.messages.MessageImpl;
  24 import org.apache.lucene.queryParser.core.QueryNodeError;
  25 import org.apache.lucene.queryParser.core.messages.QueryParserMessages;
  26 import org.apache.lucene.queryParser.core.parser.EscapeQuerySyntax;
  27
  28 /**
  29  * A {@link GroupQueryNode} represents a location where the original user typed
  30  * real parenthesis on the query string. This class is useful for queries like:
  31  * a) a AND b OR c b) ( a AND b) OR c
  32  *
  33  * Parenthesis might be used to define the boolean operation precedence.
  34  */
  35 public class GroupQueryNode extends QueryNodeImpl {
  36
  37   private static final long serialVersionUID = -9204673493869114999L;
  38
  39   /**
  40    * This QueryNode is used to identify parenthesis on the original query string
  41    */
  42   public GroupQueryNode(QueryNode query) {
  43     if (query == null) {
  44       throw new QueryNodeError(new MessageImpl(
  45           QueryParserMessages.PARAMETER_VALUE_NOT_SUPPORTED, "query", "null"));
  46     }
  47
  48     allocate();
  49     setLeaf(false);
  50     add(query);
  51   }
  52
  53   public QueryNode getChild() {
  54     return getChildren().get(0);
  55   }
  56
  57   @Override
  58   public String toString() {
  59     return "<group>" + "\n" + getChild().toString() + "\n</group>";
  60   }
  61
  62   public CharSequence toQueryString(EscapeQuerySyntax escapeSyntaxParser) {
  63     if (getChild() == null)
  64       return "";
  65
  66     return "( " + getChild().toQueryString(escapeSyntaxParser) + " )";
  67   }
  68
  69   @Override
  70   public QueryNode cloneTree() throws CloneNotSupportedException {
  71     GroupQueryNode clone = (GroupQueryNode) super.cloneTree();
  72
  73     return clone;
  74   }
  75
  76   /**
  77    * @param child
  78    */
  79   public void setChild(QueryNode child) {
  80     List<QueryNode> list = new ArrayList<QueryNode>();
  81     list.add(child);
  82     this.set(list);
  83   }
  84
  85 }