trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryParser.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.
 */
package org.apache.jackrabbit.oak.query;

import java.text.ParseException;
import java.util.Set;

/**
 * Query parser interface.
 *
 * TODO: move to o.a.j.o.spi (figure out what to do with the Query class)
 */
public interface QueryParser {

    /**
     * Returns the set of query languages supported by this parser.
     *
     * @return supported query languages
     */
    Set<String> getSupportedLanguages();

    /**
     * Parses the given query string, expressed in the specified language.
     *
     * TODO: Include name mapping information
     *
     * @param query query string
     * @param language query language
     * @return parsed query
     * @throws ParseException if the query string could not be parsed
     */
    Query parse(String query, String language) throws ParseException;

}