KickJava   Java API By Example, From Geeks To Geeks.

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


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.util.HashMap JavaDoc;
59 import java.util.Map JavaDoc;
60
61 import org.objectstyle.cayenne.exp.Expression;
62 import org.objectstyle.cayenne.map.ObjEntity;
63
64 /**
65  * Object encapsulating an UPDATE statement. Note that updated attributes are expressed in
66  * terms of DbAttribute names.
67  */
68 public class UpdateQuery extends QualifiedQuery {
69
70     protected Map JavaDoc updAttributes = new HashMap JavaDoc();
71
72     /** Creates empty UpdateQuery. */
73     public UpdateQuery() {
74     }
75
76     private void init(Object JavaDoc root, Expression qualifier) {
77         setRoot(root);
78         setQualifier(qualifier);
79     }
80
81     /**
82      * Creates a UpdateQuery with null qualifier, for the specifed ObjEntity
83      *
84      * @param root the ObjEntity this UpdateQuery is for.
85      */
86     public UpdateQuery(ObjEntity root) {
87         this(root, null);
88     }
89
90     /**
91      * Creates a UpdateQuery for the specifed ObjEntity with the given qualifier
92      *
93      * @param root the ObjEntity this UpdateQuery is for.
94      * @param qualifier an Expression indicating which objects will be updated
95      */
96     public UpdateQuery(ObjEntity root, Expression qualifier) {
97         init(root, qualifier);
98     }
99
100     /**
101      * Creates a UpdateQuery with null qualifier, for the entity which uses the given
102      * class.
103      *
104      * @param rootClass the Class of objects this UpdateQuery is for.
105      */
106     public UpdateQuery(Class JavaDoc rootClass) {
107         this(rootClass, null);
108     }
109
110     /**
111      * Creates a UpdateQuery for the entity which uses the given class, with the given
112      * qualifier.
113      *
114      * @param rootClass the Class of objects this UpdateQuery is for.
115      * @param qualifier an Expression indicating which objects will be updated
116      */
117     public UpdateQuery(Class JavaDoc rootClass, Expression qualifier) {
118         init(rootClass, qualifier);
119     }
120
121     /** Creates UpdateQuery with <code>objEntityName</code> parameter. */
122     public UpdateQuery(String JavaDoc objEntityName) {
123         this(objEntityName, null);
124     }
125
126     /**
127      * Creates UpdateQuery with <code>objEntityName</code> and <code>qualifier</code>
128      * parameters.
129      */
130     public UpdateQuery(String JavaDoc objEntityName, Expression qualifier) {
131         init(objEntityName, qualifier);
132     }
133
134     /**
135      * Calls "makeUpdate" on the visitor.
136      *
137      * @since 1.2
138      */
139     public SQLAction createSQLAction(SQLActionVisitor visitor) {
140         return visitor.updateAction(this);
141     }
142
143     public void addUpdAttribute(String JavaDoc attrName, Object JavaDoc updatedValue) {
144         updAttributes.put(attrName, updatedValue);
145     }
146
147     /** Returns a map of updated attributes */
148     public Map JavaDoc getUpdAttributes() {
149         return updAttributes;
150     }
151 }
152
Popular Tags