KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > access > QueryEngine


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */

56
57 package org.objectstyle.cayenne.access;
58
59 import java.util.Collection JavaDoc;
60
61 import org.objectstyle.cayenne.map.DataMap;
62 import org.objectstyle.cayenne.map.EntityResolver;
63
64 /**
65  * Defines methods used to run Cayenne queries.
66  * <p>
67  * <i>For more information see <a HREF="../../../../../../userguide/index.html"
68  * target="_top">Cayenne User Guide. </a> </i>
69  * </p>
70  *
71  * @author Andrei Adamchik
72  */

73 public interface QueryEngine {
74
75     /**
76      * Executes queries in the transactional context provided by the caller. It is
77      * caller's responsibility to commit or rollback the Transaction and close any
78      * connections that were added to it.
79      *
80      * @since 1.1
81      * @see OperationObserver
82      * @see Transaction
83      */

84     public void performQueries(
85             Collection JavaDoc queries,
86             OperationObserver resultConsumer,
87             Transaction transaction);
88
89     /**
90      * Executes a list of queries wrapping them in its own transaction. Results of
91      * execution are passed to {@link OperationObserver}object via its callback methods.
92      *
93      * @since 1.1 The signiture has changed from List to Collection.
94      */

95     public void performQueries(Collection JavaDoc queries, OperationObserver resultConsumer);
96
97     /**
98      * Returns a DataNode that should handle queries for all DataMap components.
99      *
100      * @since 1.1
101      */

102     // TODO: since 1.2 this method is not used for routing (its original intention),
103
// however many classes in Cayenne use it to pick at the DataNode... eventually we
104
// should clean this up and deprecate this method.
105
public DataNode lookupDataNode(DataMap dataMap);
106
107     /**
108      * Returns a resolver for this query engine that is capable of resolving between
109      * classes, entity names, and obj/db entities
110      */

111     public EntityResolver getEntityResolver();
112
113     /**
114      * Returns a collection of DataMaps associated with this QueryEngine.
115      */

116     public Collection JavaDoc getDataMaps();
117 }
118
Popular Tags