1 /* 2 * ModeShape (http://www.modeshape.org) 3 * See the COPYRIGHT.txt file distributed with this work for information 4 * regarding copyright ownership. Some portions may be licensed 5 * to Red Hat, Inc. under one or more contributor license agreements. 6 * See the AUTHORS.txt file in the distribution for a full listing of 7 * individual contributors. 8 * 9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape 10 * is licensed to you under the terms of the GNU Lesser General Public License as 11 * published by the Free Software Foundation; either version 2.1 of 12 * the License, or (at your option) any later version. 13 * 14 * ModeShape is distributed in the hope that it will be useful, 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 * Lesser General Public License for more details. 18 * 19 * You should have received a copy of the GNU Lesser General Public 20 * License along with this software; if not, write to the Free 21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org. 23 */ 24 package org.modeshape.graph.query.parse; 25 26 import net.jcip.annotations.Immutable; 27 import org.modeshape.common.text.ParsingException; 28 import org.modeshape.graph.query.model.QueryCommand; 29 import org.modeshape.graph.query.model.TypeSystem; 30 31 /** 32 * The basic interface defining a component that is able to parse a string query into a {@link QueryCommand}. 33 */ 34 @Immutable 35 public interface QueryParser { 36 37 /** 38 * Get the name of the language that this parser is able to understand. 39 * 40 * @return the language name; never null 41 */ 42 String getLanguage(); 43 44 /** 45 * Parse the supplied query from a string representation into a {@link QueryCommand}. 46 * 47 * @param query the query in string form; may not be null 48 * @param typeSystem the type system used by the query; may not be null 49 * @return the query command 50 * @throws ParsingException if there is an error parsing the supplied query 51 * @throws InvalidQueryException if the supplied query can be parsed but is invalid 52 */ 53 QueryCommand parseQuery( String query, 54 TypeSystem typeSystem ) throws InvalidQueryException; 55 56 }