/* * Copyright 2008 Udai Gupta, Ralf Joachim * * Licensed 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.castor.cpa.query; import java.io.UnsupportedEncodingException; /** * Interface for parsers of OQL query strings. * * @author <a href="mailto:mailtoud AT gmail DOT com">Udai Gupta</a> * @author <a href="mailto:ralf DOT joachim AT syscon DOT eu">Ralf Joachim</a> * @version $Revision: 7121 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $ * @since 1.3 */ public interface Parser { //-------------------------------------------------------------------------- /** * Parse the given OQL query string and return a tree of query objects that represent it. * * @param oql OQL query string passed to the parser generator. * @return Tree of query objects that represent the query. * * @throws UnsupportedEncodingException If encoding of the query string is not supported. * @throws ParseException If query is invalid. */ QueryObject parse(String oql) throws UnsupportedEncodingException, ParseException; //-------------------------------------------------------------------------- }