001/*
002 * Copyright 2006-2008 the original author or authors.
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 *      https://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
017package org.springframework.batch.item.database.orm;
018
019import javax.persistence.EntityManager;
020import javax.persistence.Query;
021
022import org.springframework.batch.item.ItemReader;
023
024/**
025 * <p>Interface defining the functionality to be provided for generating queries 
026 * for use with JPA {@link ItemReader}s or other custom built artifacts.</p>
027 * 
028 * @author Anatoly Polinsky
029 * @author Dave Syer
030 * @since 2.1
031 * 
032 */
033public interface JpaQueryProvider {
034
035    /**
036     * <p>Create the query object.</p>
037     * 
038     * @return created query
039     */
040        public Query createQuery();
041        
042    /**
043     * Provide an {@link EntityManager} for the query to be built.
044     * 
045     * @param entityManager to be used by the {@link JpaQueryProvider}.
046     */
047    void setEntityManager(EntityManager entityManager);
048
049}