KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > db > api > sql > execute > SQLExecuteCookie


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.db.api.sql.execute;
21
22 import java.sql.SQLException JavaDoc;
23 import org.netbeans.api.db.explorer.DatabaseConnection;
24 import org.openide.nodes.Node;
25
26 /**
27  * Cookie for executing SQL files.
28  *
29  * <p>This interface allows a client to execute the SQL statement(s)
30  * contained in the implementing object (currently the
31  * DataObject for SQL files). Therefore calling
32  * the {@link #execute} method will execute the statement(s) contained
33  * in the respective file and display the results.</p>
34  *
35  * @author Andrei Badea
36  */
37 public interface SQLExecuteCookie extends Node.Cookie {
38
39     // XXX this should not be a cookie, just a plain interface;
40 // will be fixed when lookups are added to DataObjects
41
42     /**
43      * Call this set the current database connection for this cookie.
44      * The database connection will be used by the {@link #execute} method.
45      */
46     public void setDatabaseConnection(DatabaseConnection dbconn);
47
48     /**
49      * Call this to execute the statements in the object implementing the
50      * cookie and display them in the result window.
51      */
52     public void execute();
53 }
54
Popular Tags