KickJava   Java API By Example, From Geeks To Geeks.

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


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
61 import org.objectstyle.cayenne.map.DbEntity;
62
63 /**
64  * BatchQuery and its descendants allow to group similar data for the batch database
65  * modifications, including inserts, updates and deletes. Single BatchQuery corresponds to
66  * a parameterized PreparedStatement and a matrix of values.
67  *
68  * @author Andriy Shapochka
69  */
70 public abstract class BatchQuery extends AbstractQuery {
71
72     public BatchQuery(DbEntity dbEntity) {
73         setRoot(dbEntity);
74     }
75
76     /**
77      * Calls "makeBatchUpdate" on the visitor.
78      *
79      * @since 1.2
80      */
81     public SQLAction createSQLAction(SQLActionVisitor visitor) {
82         return visitor.batchAction(this);
83     }
84
85     /**
86      * Returns true if the batch query uses optimistic locking.
87      *
88      * @since 1.1
89      */
90     public boolean isUsingOptimisticLocking() {
91         return false;
92     }
93
94     /**
95      * Returns a DbEntity associated with this batch.
96      */
97     public DbEntity getDbEntity() {
98         return (DbEntity) getRoot();
99     }
100
101     /**
102      * Returns a List of values for the current batch iteration, in the order they are
103      * bound to the query. Used mainly for logging.
104      *
105      * @param includeNullValues A <code>true</code> value indicates that the
106      * returned list should include <code>null</code> values and
107      * <code>false</code> indicates they should not be included.
108      *
109      * @deprecated Since 1.2 use BatchQueryBuilder.getParameterValues(), as this allows
110      * better control over which attributes are logged.
111      */
112     public List JavaDoc getValuesForUpdateParameters(boolean includeNullValues) {
113         int len = getDbAttributes().size();
114         List JavaDoc values = new ArrayList JavaDoc(len);
115         for (int i = 0; i < len; i++) {
116             Object JavaDoc value = getObject(i);
117             if (includeNullValues || value != null) {
118                 values.add(value);
119             }
120         }
121         return values;
122     }
123
124     /**
125      * Returns <code>true</code> if this batch query has no parameter rows.
126      */
127     public boolean isEmpty() {
128         return size() == 0;
129     }
130
131     /**
132      * Returns a list of DbAttributes describing batch parameters.
133      */
134     public abstract List JavaDoc getDbAttributes();
135
136     /**
137      * Rewinds batch to the first parameter row.
138      */
139     public abstract void reset();
140
141     /**
142      * Repositions batch to the next object, so that subsequent calls to getObject(int)
143      * would return the values of the next batch object. Returns <code>true</code> if
144      * batch has more objects to iterate over, <code>false</code> otherwise.
145      */
146     public abstract boolean next();
147
148     /**
149      * @deprecated Since 1.2 renamed to "getValue()"
150      */
151     public Object JavaDoc getObject(int valueIndex) {
152         return getValue(valueIndex);
153     }
154
155     /**
156      * Returns a value at a given index for the current batch iteration.
157      *
158      * @since 1.2
159      */
160     public abstract Object JavaDoc getValue(int valueIndex);
161
162     /**
163      * Returns the number of parameter rows in a batch.
164      */
165     public abstract int size();
166 }
167
Popular Tags