KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cayenne > jpa > CayenneEntityManager


1 /*****************************************************************
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  ****************************************************************/
19 package org.apache.cayenne.jpa;
20
21 import javax.persistence.EntityManager;
22
23 import org.apache.cayenne.DataChannel;
24
25 /**
26  * An interface that allows to access Cayenne runtime hidden behind standard JPA classes.
27  * To do that, simply cast an EntityManager returned by Cayenne provider to
28  * "CayenneEntityManager". Note that a regular JPA application shouldn't normally attempt
29  * to do that. Otherwise it will not be portable across JPA providers.
30  *
31  * @author Andrus Adamchik
32  */
33 public interface CayenneEntityManager extends EntityManager {
34
35     /**
36      * Returns a Cayenne {@link DataChannel} that is used to link EntityManager with
37      * Cayenne runtime. DataChannel can be used for instance to obtain Cayenne metadata or
38      * add listeners.
39      */
40     DataChannel getChannel();
41 }
42
Popular Tags