KickJava   Java API By Example, From Geeks To Geeks.

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


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.query;
58
59 import org.apache.commons.lang.builder.ToStringBuilder;
60 import org.apache.log4j.Level;
61 import org.objectstyle.cayenne.CayenneRuntimeException;
62 import org.objectstyle.cayenne.map.DataMap;
63 import org.objectstyle.cayenne.map.DbEntity;
64 import org.objectstyle.cayenne.map.EntityResolver;
65 import org.objectstyle.cayenne.map.ObjEntity;
66 import org.objectstyle.cayenne.map.Procedure;
67
68 /**
69  * Superclass of Cayenne queries.
70  *
71  * @author Andrei Adamchik
72  */
73 public abstract class AbstractQuery implements Query {
74
75     /**
76      * The root object this query. May be an entity name, Java class, ObjEntity or
77      * DbEntity, depending on the specific query and how it was constructed.
78      */
79     protected Object JavaDoc root;
80     protected String JavaDoc name;
81
82     protected Level logLevel = DEFAULT_LOG_LEVEL;
83
84     /**
85      * Returns a symbolic name of the query.
86      *
87      * @since 1.1
88      */
89     public String JavaDoc getName() {
90         return name;
91     }
92
93     /**
94      * Sets a symbolic name of the query.
95      *
96      * @since 1.1
97      */
98     public void setName(String JavaDoc name) {
99         this.name = name;
100     }
101
102     /**
103      * Returns the <code>logLevel</code> property of this query. Log level is a hint to
104      * QueryEngine that performs this query to log execution with a certain priority.
105      */
106     public Level getLoggingLevel() {
107         return logLevel;
108     }
109
110     /**
111      * Sets the <code>logLevel</code> property.
112      */
113     public void setLoggingLevel(Level logLevel) {
114         this.logLevel = logLevel;
115     }
116
117     /**
118      * Returns the root of this query
119      *
120      * @return Object
121      */
122     public Object JavaDoc getRoot() {
123         return root;
124     }
125
126     /**
127      * Sets the root of the query
128      *
129      * @param value The new root
130      * @throws IllegalArgumentException if value is not a String, ObjEntity, DbEntity,
131      * Procedure, DataMap, Class or null.
132      */
133     public void setRoot(Object JavaDoc value) {
134         if (value == null) {
135             this.root = null;
136         }
137
138         // sanity check
139 if (!((value instanceof String JavaDoc)
140                 || (value instanceof ObjEntity)
141                 || (value instanceof DbEntity)
142                 || (value instanceof Class JavaDoc)
143                 || (value instanceof Procedure) || (value instanceof DataMap))) {
144
145             String JavaDoc rootClass = (value != null) ? value.getClass().getName() : "null";
146
147             throw new IllegalArgumentException JavaDoc(
148                     getClass().getName()
149                             + ": \"setRoot(..)\" takes a DataMap, String, ObjEntity, DbEntity, Procedure, "
150                             + "or Class. It was passed a "
151                             + rootClass);
152         }
153
154         this.root = value;
155     }
156
157     public String JavaDoc toString() {
158         return new ToStringBuilder(this).append("root", getRoot()).append(
159                 "name",
160                 getName()).toString();
161     }
162
163     /**
164      * @since 1.2
165      */
166     public abstract SQLAction createSQLAction(SQLActionVisitor visitor);
167
168     /**
169      * Implements default resolution mechanism - simply returns this query.
170      *
171      * @since 1.2
172      */
173     public Query resolve(EntityResolver resolver) {
174         return this;
175     }
176
177     /**
178      * Implements default routing mechanism relying on the EntityResolver to find DataMap
179      * based on the query root. This mechanism should be sufficient for most queries that
180      * "know" their root.
181      *
182      * @since 1.2
183      */
184     public void route(QueryRouter router, EntityResolver resolver) {
185         DataMap map = resolver.lookupDataMap(this);
186
187         if (map == null) {
188             throw new CayenneRuntimeException("No DataMap found, can't route query "
189                     + this);
190         }
191
192         router.useEngineForQuery(router.engineForDataMap(map), this);
193     }
194 }
195
Popular Tags