001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.core.query.sql;
023
024import java.io.Reader;
025import java.io.StringReader;
026
027import org.nuxeo.common.utils.ExceptionUtils;
028import org.nuxeo.ecm.core.query.QueryParseException;
029import org.nuxeo.ecm.core.query.sql.model.SQLQuery;
030import org.nuxeo.ecm.core.query.sql.parser.Scanner;
031import org.nuxeo.ecm.core.query.sql.parser.parser;
032
033/**
034 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
035 */
036public final class SQLQueryParser {
037
038    // Utility class
039    private SQLQueryParser() {
040    }
041
042    public static SQLQuery parse(Reader reader) throws QueryParseException {
043        try {
044            Scanner scanner = new Scanner(reader);
045            parser parser = new parser(scanner);
046            return (SQLQuery) parser.parse().value;
047        } catch (QueryParseException e) {
048            throw e;
049        } catch (Exception e) { // stupid CUPS API throws Exception
050            throw new QueryParseException(ExceptionUtils.runtimeException(e));
051        }
052    }
053
054    public static SQLQuery parse(String string) throws QueryParseException {
055        SQLQuery query = parse(new StringReader(string));
056        query.setQueryString(string);
057        return query;
058    }
059
060    /**
061     * Returns the string literal in a form ready to embed in an NXQL statement.
062     *
063     * @deprecated since 5.7, 5.6.0-HF08 use {{@link NXQL#escapeString} instead
064     */
065    @Deprecated
066    public static String prepareStringLiteral(String s) {
067        return NXQL.escapeString(s);
068    }
069
070}