lucene/queryparser/src/java/org/apache/lucene/queryparser/flexible/core/parser/package-info.java

/*
 * 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.
 */

/**
 * Necessary interfaces to implement text parsers.
 *
 * <h2>Parser</h2>
 *
 * <p>The package <code>org.apache.lucene.queryparser.flexible.parser</code> contains interfaces
 * that should be implemented by the parsers.
 *
 * <p>Parsers produce QueryNode Trees from a string object. These package still needs some work to
 * add support to for multiple parsers.
 *
 * <p>Features that should be supported for the future, related with the parser:
 *
 * <ul>
 *   <li>QueryNode tree should be able convertible to any parser syntax.
 *   <li>The query syntax should support calling other parsers.
 *   <li>QueryNode tree created by multiple parsers.
 * </ul>
 */
package org.apache.lucene.queryparser.flexible.core.parser;