KickJava   Java API By Example, From Geeks To Geeks.

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


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.access;
57
58 import java.sql.Connection JavaDoc;
59 import java.sql.PreparedStatement JavaDoc;
60
61 import org.apache.log4j.Level;
62 import org.objectstyle.cayenne.dba.DbAdapter;
63 import org.objectstyle.cayenne.map.DbEntity;
64 import org.objectstyle.cayenne.map.EntityInheritanceTree;
65 import org.objectstyle.cayenne.map.EntityResolver;
66 import org.objectstyle.cayenne.map.ObjEntity;
67 import org.objectstyle.cayenne.query.Query;
68
69 /**
70  * Defines API for translation Cayenne queries to JDBC PreparedStatements.
71  * <p>
72  * <i>For more information see <a HREF="../../../../../../userguide/index.html"
73  * target="_top">Cayenne User Guide. </a> </i>
74  * </p>
75  *
76  * @author Andrei Adamchik
77  */
78 public abstract class QueryTranslator {
79
80     /** Query being translated. */
81     protected Query query;
82
83     /**
84      * JDBC database connection needed to create PreparedStatement.
85      * Prior to 1.2 this property was called "con".
86      */
87     protected Connection JavaDoc connection;
88
89     /**
90      * Used mainly for name resolution.
91      *
92      * @deprecated Since 1.2 entityResolver property is used.
93      */
94     protected QueryEngine engine;
95
96     /** Adapter helping to do SQL literal conversions, etc. */
97     protected DbAdapter adapter;
98     
99     /**
100      * Provides access to Cayenne mapping info.
101      *
102      * @since 1.2
103      */
104     protected EntityResolver entityResolver;
105
106     /**
107      * Creates PreparedStatement. <code>logLevel</code>
108      * parameter is supplied to allow
109      * control of logging of produced SQL.
110      */
111     public abstract PreparedStatement JavaDoc createStatement(Level logLevel) throws Exception JavaDoc;
112
113     /** Returns query object being processed. */
114     public Query getQuery() {
115         return query;
116     }
117
118     public void setQuery(Query query) {
119         this.query = query;
120     }
121
122     /**
123      * Returns Connection object used by this translator.
124      *
125      * @since 1.2
126      */
127     public Connection JavaDoc getConnection() {
128         return connection;
129     }
130
131     /**
132      * @since 1.2
133      */
134     public void setConnection(Connection JavaDoc connection) {
135         this.connection = connection;
136     }
137     
138     /**
139      * @deprecated Since 1.2 use getConnection().
140      */
141     public Connection JavaDoc getCon() {
142         return getConnection();
143     }
144
145     /**
146      * @deprecated since 1.2 use setConnection().
147      */
148     public void setCon(Connection JavaDoc con) {
149         setConnection(con);
150     }
151
152     /**
153      * Returns QueryEngine used by this translator.
154      *
155      * @deprecated Since 1.2 use "getEntityResolver()"
156      */
157     public QueryEngine getEngine() {
158         return engine;
159     }
160
161     /**
162      * @deprecated Since 1.2 use "setEntityResolver()"
163      */
164     public void setEngine(QueryEngine engine) {
165         this.engine = engine;
166     }
167
168     public DbAdapter getAdapter() {
169         return adapter;
170     }
171
172     public void setAdapter(DbAdapter adapter) {
173         this.adapter = adapter;
174     }
175
176     /**
177      * Returns an EntityInheritanceTree for the root entity.
178      *
179      * @since 1.1
180      */
181     public EntityInheritanceTree getRootInheritanceTree() {
182         return getEntityResolver().lookupInheritanceTree(getRootEntity());
183     }
184
185     public ObjEntity getRootEntity() {
186         if (query.getRoot() instanceof DbEntity) {
187             return null;
188         }
189
190         return getEntityResolver().lookupObjEntity(query);
191     }
192
193     public DbEntity getRootDbEntity() {
194         return getEntityResolver().lookupDbEntity(query);
195     }
196     
197     /**
198      * @since 1.2
199      */
200     public EntityResolver getEntityResolver() {
201         return entityResolver;
202     }
203     
204     /**
205      * @since 1.2
206      */
207     public void setEntityResolver(EntityResolver entityResolver) {
208         this.entityResolver = entityResolver;
209     }
210 }
Popular Tags