KickJava   Java API By Example, From Geeks To Geeks.

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


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
57 package org.objectstyle.cayenne.access;
58
59 import java.util.List JavaDoc;
60
61 import org.objectstyle.cayenne.query.Query;
62
63 /**
64  * Defines a set of callback methods that allow QueryEngine to pass back query results and
65  * notify caller about exceptions.
66  *
67  * @see org.objectstyle.cayenne.access.QueryEngine
68  * @author Andrei Adamchik
69  */
70 // TODO: need a name that better reflects the functionality,
71 // e.g. OperationContext or QueryContext
72 public interface OperationObserver extends OperationHints {
73
74     /**
75      * Callback method invoked after an updating query is executed.
76      */
77     public void nextCount(Query query, int resultCount);
78
79     /**
80      * Callback method invoked after a batch update is executed.
81      */
82     public void nextBatchCount(Query query, int[] resultCount);
83
84     /**
85      * Callback method invoked for each processed ResultSet.
86      */
87     public void nextDataRows(Query query, List JavaDoc dataRows);
88
89     /**
90      * Callback method invoked for each opened ResultIterator. If this observer requested
91      * results to be returned as a ResultIterator, this method is invoked instead of
92      * "nextDataRows(Query,List)". OperationObserver is responsible for closing the
93      * ResultIterators passed via this method.
94      */
95     public void nextDataRows(Query q, ResultIterator it);
96
97     /**
98      * Callback method invoked after each batch of generated values is read durring an
99      * update.
100      *
101      * @since 1.2
102      */
103     public void nextGeneratedDataRows(Query query, ResultIterator keysIterator);
104
105     /**
106      * Callback method invoked on exceptions that happen during an execution of a specific
107      * query.
108      */
109     public void nextQueryException(Query query, Exception JavaDoc ex);
110
111     /**
112      * Callback method invoked on exceptions that are not tied to a specific query
113      * execution, such as JDBC connection exceptions, etc.
114      */
115     public void nextGlobalException(Exception JavaDoc ex);
116 }
117
Popular Tags