QueryBuilder.java

package org.apache.lucene.queryParser.core.builders;

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import org.apache.lucene.queryParser.core.QueryNodeException;
import org.apache.lucene.queryParser.core.nodes.QueryNode;

/**
 * This interface is used by implementors classes that builds some kind of
 * object from a query tree.
 * 
 * @see QueryTreeBuilder
 */
public interface QueryBuilder {

  /**
   * Builds some kind of object from a query tree.
   * 
   * @param queryNode
   *          the query tree root node
   * 
   * @return some object generated from the query tree
   * 
   * @throws QueryNodeException
   */
  Object build(QueryNode queryNode) throws QueryNodeException;

}