OpenJPAQueryBuilder.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.openjpa.persistence.query;

import org.apache.openjpa.kernel.Query;

/**
 * Builds dynamic query  
 *  
 * @author Pinaki Poddar
 *
 */
public interface OpenJPAQueryBuilder extends QueryBuilder {

	/**
	 * Create a QueryDefinition from the given JPQL String.
	 */
	public QueryDefinition createQueryDefinition(String jpql);
	
	/**
	 * Create a QueryDefinition from the given OpenJPA Query instance.
	 */
	public QueryDefinition createQueryDefinition(Query jpql);
	
	/**
	 * Gets equivalent JPQL String for the given QueryDefinition.
	 */
	public String toJPQL(QueryDefinition qdef);
}