KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > db > spi > sql > editor > SQLEditorProvider


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.spi.sql.editor;
21
22 import org.netbeans.api.db.explorer.DatabaseConnection;
23 import org.openide.loaders.DataObject;
24
25 /**
26  * This interface provides an SQL editor. It is used every time the Database
27  * Explorer needs to open an SQL editor, such as from the Execute Command or
28  * View Data actions. The implementation should be placed in the default lookup.
29  *
30  * @author Andrei Badea
31  */
32 public interface SQLEditorProvider {
33
34     /**
35      * Opens a new SQL editor for the specified connection and containing the
36      * specified SQL statments and possibly executes them.
37      *
38      * @param dbconn the databaseconnection set as active in the SQL editor. The
39      * statements are also executed against this connection.
40      * @param sql the SQL statements to be put in the editor
41      * @param execute whether to execute the SQL statements.
42      */
43     public void openSQLEditor(DatabaseConnection dbconn, String JavaDoc sql, boolean execute);
44 }
45
Popular Tags