KickJava   Java API By Example, From Geeks To Geeks.

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


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.ArrayList JavaDoc;
59 import java.util.List JavaDoc;
60 import java.util.Map JavaDoc;
61
62 import org.apache.commons.collections.Factory;
63 import org.objectstyle.cayenne.CayenneRuntimeException;
64 import org.objectstyle.cayenne.ObjectId;
65 import org.objectstyle.cayenne.map.DbAttribute;
66 import org.objectstyle.cayenne.map.DbEntity;
67
68 /**
69  * Batched INSERT query. Allows inserting multiple object snapshots (DataRows) for a given
70  * DbEntity in a single query. InsertBatchQuery normally is not used directly. Rather
71  * DataContext creates one internally when committing DataObjects.
72  *
73  * @author Andriy Shapochka
74  */
75 public class InsertBatchQuery extends BatchQuery {
76
77     /**
78      * @since 1.2
79      */
80     protected List JavaDoc objectIds;
81
82     protected List JavaDoc objectSnapshots;
83     protected List JavaDoc dbAttributes;
84
85     /**
86      * @since 1.2
87      */
88     protected int batchIndex;
89
90     /**
91      * Creates new InsertBatchQuery for a given DbEntity and estimated capacity.
92      */
93     public InsertBatchQuery(DbEntity entity, int batchCapacity) {
94         super(entity);
95
96         this.objectSnapshots = new ArrayList JavaDoc(batchCapacity);
97         this.objectIds = new ArrayList JavaDoc(batchCapacity);
98         this.dbAttributes = new ArrayList JavaDoc(getDbEntity().getAttributes());
99         this.batchIndex = -1;
100     }
101
102     /**
103      * Resets InsertBatchQuery so that a following call to "next" would start from the
104      * beginning of the batch.
105      */
106     public void reset() {
107         batchIndex = -1;
108     }
109
110     public boolean next() {
111         batchIndex++;
112         return size() > batchIndex;
113     }
114
115     public Object JavaDoc getValue(int dbAttributeIndex) {
116         DbAttribute attribute = (DbAttribute) dbAttributes.get(dbAttributeIndex);
117         Map JavaDoc currentSnapshot = (Map JavaDoc) objectSnapshots.get(batchIndex);
118         Object JavaDoc value = currentSnapshot.get(attribute.getName());
119
120         // if a value is a Factory, resolve it here...
121 // slight chance that a normal value will implement Factory interface???
122 if (value instanceof Factory) {
123             value = ((Factory) value).create();
124
125             // update replacement id
126 if (attribute.isPrimaryKey()) {
127                 // sanity check
128 if (value == null) {
129                     String JavaDoc name = attribute.getEntity() != null ? attribute
130                             .getEntity()
131                             .getName() : "<null>";
132                     throw new CayenneRuntimeException("Failed to generate PK: "
133                             + name
134                             + "."
135                             + attribute.getName());
136                 }
137
138                 ObjectId id = getObjectId();
139                 if (id != null) {
140                     // always override with fresh value as this is what's in the DB
141 id.getReplacementIdMap().put(attribute.getName(), value);
142                 }
143             }
144
145             // update snapshot
146 currentSnapshot.put(attribute.getName(), value);
147         }
148
149         return value;
150     }
151
152     /**
153      * Adds a snapshot to batch. A shortcut for "add(snapshot, null)".
154      */
155     public void add(Map JavaDoc snapshot) {
156         add(snapshot, null);
157     }
158
159     /**
160      * Adds a snapshot to batch. Optionally stores the object id for the snapshot. Note
161      * that snapshot can hold either the real values or the instances of
162      * org.apache.commons.collections.Factory that will be resolved to the actual value on
163      * the spot, thus allowing deferred propagated keys resolution.
164      *
165      * @since 1.2
166      */
167     public void add(Map JavaDoc snapshot, ObjectId id) {
168         objectSnapshots.add(snapshot);
169         objectIds.add(id);
170     }
171
172     public int size() {
173         return objectSnapshots.size();
174     }
175
176     public List JavaDoc getDbAttributes() {
177         return dbAttributes;
178     }
179
180     /**
181      * Returns an ObjectId associated with the current batch iteration.
182      *
183      * @since 1.2
184      */
185     public ObjectId getObjectId() {
186         return (ObjectId) objectIds.get(batchIndex);
187     }
188 }
Popular Tags