View Javadoc

1   /*
2    * Copyright 2006-2008 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.batch.item.database.orm;
18  
19  import javax.persistence.EntityManager;
20  import javax.persistence.Query;
21  
22  import org.springframework.batch.item.ItemReader;
23  
24  /**
25   * <p>Interface defining the functionality to be provided for generating queries 
26   * for use with JPA {@link ItemReader}s or other custom built artifacts.</p>
27   * 
28   * @author Anatoly Polinsky
29   * @author Dave Syer
30   * @since 2.1
31   * 
32   */
33  public interface JpaQueryProvider {
34  
35      /**
36       * <p>Create the query object.</p>
37       * 
38       * @return created query
39       */
40  	public Query createQuery();
41  	
42      /**
43       * Provide an {@link EntityManager} for the query to be built.
44       * 
45       * @param entityManager
46       */
47      void setEntityManager(EntityManager entityManager);
48  
49  }