KickJava   Java API By Example, From Geeks To Geeks.

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


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.Map JavaDoc;
59
60 import org.objectstyle.cayenne.ObjectId;
61 import org.objectstyle.cayenne.map.ObjEntity;
62
63 /**
64  * Describes insert database operation. InsertQuery is initialized with object values
65  * snapshot and ObjectId.
66  *
67  * @deprecated since 1.2 Object InsertQuery is not needed anymore. It shouldn't be used
68  * directly anyway, but in cases where one might want to have access to it,
69  * InsertBatchQuery is a reasonable substitute.
70  */
71 public class InsertQuery extends AbstractQuery {
72
73     protected ObjectId objectId;
74     protected Map JavaDoc objectSnapshot;
75
76     /** Creates empty InsertQuery. */
77     public InsertQuery() {
78     }
79
80     /** Creates InsertQuery with the <code>rootEntity</code> as the root object */
81     public InsertQuery(ObjEntity rootEntity) {
82         this.setRoot(rootEntity);
83     }
84
85     /** Creates InsertQuery with the <code>rootClass</code> as the root object */
86     public InsertQuery(Class JavaDoc rootClass) {
87         this.setRoot(rootClass);
88     }
89
90     /** Creates InsertQuery with the <code>rootClass</code> as the root object */
91     public InsertQuery(Class JavaDoc rootClass, Map JavaDoc dataRow) {
92         this.setRoot(rootClass);
93         this.setObjectSnapshot(dataRow);
94     }
95
96     /** Creates InsertQuery with <code>objEntityName</code> parameter. */
97     public InsertQuery(String JavaDoc objEntityName) {
98         this.setRoot(objEntityName);
99     }
100
101     /**
102      * Calls "makeUpdate" on the visitor.
103      *
104      * @since 1.2
105      */
106     public SQLAction createSQLAction(SQLActionVisitor visitor) {
107         return visitor.updateAction(this);
108     }
109
110     public Map JavaDoc getObjectSnapshot() {
111         return objectSnapshot;
112     }
113
114     public void setObjectSnapshot(Map JavaDoc objectSnapshot) {
115         this.objectSnapshot = objectSnapshot;
116     }
117
118     public ObjectId getObjectId() {
119         return objectId;
120     }
121
122     public void setObjectId(ObjectId objectId) {
123         this.objectId = objectId;
124     }
125 }
Popular Tags