KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > query > QueryExecutionPlan


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 package org.objectstyle.cayenne.query;
57
58 import java.io.Serializable JavaDoc;
59
60 import org.objectstyle.cayenne.access.QueryEngine;
61 import org.objectstyle.cayenne.map.EntityResolver;
62
63 /**
64  * Defines callback methods for query execution in Cayenne.
65  *
66  * @author Andrus Adamchik
67  * @since 1.2
68  */
69 public interface QueryExecutionPlan extends Serializable JavaDoc {
70
71     /**
72      * A callback method invoked by Cayenne during the first phase of query execution,
73      * allowing to resolve the actual query to be executed. For example a
74      * QueryExecutionPlan can be implemented to store a query stored by name in the
75      * DataMap. In this method such query would find the actual mapped query and return it
76      * to the caller for execution.
77      */
78     Query resolve(EntityResolver resolver);
79
80     /**
81      * A callback method invoked by Cayenne during the routing phase of the query run.
82      * Mapping of query engines is provided by QueryRouter. Query should use a
83      * {@link QueryRouter#useEngineForQuery(QueryEngine, Query)}callback method to route
84      * itself. At this point a query can create one or more substitute queries or even
85      * provide its own QueryEngine to execute itself.
86      */
87     void route(QueryRouter router, EntityResolver resolver);
88
89     /**
90      * A callback method invoked by Cayenne during the final execution phase of the query
91      * run. A concrete query implementation is given a chance to decide how it should be
92      * handled. Implementors can pick an appropriate method of the SQLActionVisitor to
93      * handle itself, create a custom SQLAction of its own, or substitute itself with
94      * another query that should be used for SQLAction construction.
95      */
96     SQLAction createSQLAction(SQLActionVisitor visitor);
97 }
98
Popular Tags