lucene-java-3.4.0/lucene/contrib/queryparser/src/java/org/apache/lucene/queryParser/core/nodes/FieldableNode.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 /**
  21  * A query node implements {@link FieldableNode} interface to indicate that its
  22  * children and itself are associated to a specific field.
  23  *
  24  * If it has any children which also implements this interface, it must ensure
  25  * the children are associated to the same field.
  26  *
  27  */
  28 public interface FieldableNode extends QueryNode {
  29
  30   /**
  31    * Returns the field associated to the node and every node under it.
  32    *
  33    * @return the field name
  34    */
  35   CharSequence getField();
  36
  37   /**
  38    * Associates the node to a field.
  39    *
  40    * @param fieldName
  41    *          the field name
  42    */
  43   void setField(CharSequence fieldName);
  44
  45 }