KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > access > OptimisticLockException


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.access;
57
58 import java.util.Collections JavaDoc;
59 import java.util.Iterator JavaDoc;
60 import java.util.List JavaDoc;
61 import java.util.Map JavaDoc;
62
63 import org.objectstyle.cayenne.CayenneRuntimeException;
64 import org.objectstyle.cayenne.access.util.SelectObserver;
65 import org.objectstyle.cayenne.exp.Expression;
66 import org.objectstyle.cayenne.exp.ExpressionFactory;
67 import org.objectstyle.cayenne.map.DbAttribute;
68 import org.objectstyle.cayenne.map.DbEntity;
69 import org.objectstyle.cayenne.query.SelectQuery;
70
71 /**
72  * An exception thrown on optimistic lock failure.
73  *
74  * @since 1.1
75  * @author Andrei Adamchik
76  */

77 public class OptimisticLockException extends CayenneRuntimeException {
78     protected String JavaDoc querySQL;
79     protected DbEntity rootEntity;
80     protected Map JavaDoc qualifierSnapshot;
81
82     public OptimisticLockException(
83         DbEntity rootEntity,
84         String JavaDoc querySQL,
85         Map JavaDoc qualifierSnapshot) {
86         super("Optimistic Lock Failure");
87
88         this.rootEntity = rootEntity;
89         this.querySQL = querySQL;
90         this.qualifierSnapshot =
91             (qualifierSnapshot != null) ? qualifierSnapshot : Collections.EMPTY_MAP;
92     }
93
94     public Map JavaDoc getQualifierSnapshot() {
95         return qualifierSnapshot;
96     }
97
98     public String JavaDoc getQuerySQL() {
99         return querySQL;
100     }
101
102     /**
103      * Retrieves fresh snapshot for the failed row.
104      * Null row indicates that it was deleted.
105      */

106     public Map JavaDoc getFreshSnapshot(QueryEngine engine) {
107         // extract PK from the qualifierSnapshot and fetch a row
108
// for PK, ignoring other locking attributes...
109

110         Expression qualifier = null;
111         Iterator JavaDoc it = rootEntity.getPrimaryKey().iterator();
112         while (it.hasNext()) {
113             DbAttribute attribute = (DbAttribute) it.next();
114             Expression attributeQualifier =
115                 ExpressionFactory.matchDbExp(
116                     attribute.getName(),
117                     qualifierSnapshot.get(attribute.getName()));
118
119             qualifier =
120                 (qualifier != null)
121                     ? qualifier.andExp(attributeQualifier)
122                     : attributeQualifier;
123         }
124
125         SelectQuery query = new SelectQuery(rootEntity, qualifier);
126         query.setFetchingDataRows(true);
127         SelectObserver observer = new SelectObserver();
128         engine.performQueries(Collections.singletonList(query), observer);
129         List JavaDoc results = observer.getResults(query);
130
131         if (results == null || results.isEmpty()) {
132             return null;
133         }
134         else if (results.size() > 1) {
135             throw new CayenneRuntimeException("More than one row for ObjectId.");
136         }
137         else {
138             return (Map JavaDoc) results.get(0);
139         }
140     }
141
142     /**
143      * Returns descriptive message for this exception.
144      */

145     public String JavaDoc getMessage() {
146         StringBuffer JavaDoc buffer = new StringBuffer JavaDoc(super.getMessage());
147
148         if (querySQL != null) {
149             buffer.append(", SQL: [").append(querySQL.trim()).append("]");
150         }
151
152         if (!qualifierSnapshot.isEmpty()) {
153             buffer.append(", WHERE clause bindings: [");
154             Iterator JavaDoc it = qualifierSnapshot.entrySet().iterator();
155             while (it.hasNext()) {
156                 Map.Entry JavaDoc entry = (Map.Entry JavaDoc) it.next();
157                 buffer.append(entry.getKey()).append("=");
158                 QueryLogger.sqlLiteralForObject(buffer, entry.getValue());
159
160                 if (it.hasNext()) {
161                     buffer.append(", ");
162                 }
163             }
164             buffer.append("]");
165         }
166
167         return buffer.toString();
168     }
169 }
170
Popular Tags