plugins/org.eclipse.datatools.sqltools.sqleditor/src/org/eclipse/datatools/sqltools/sqleditor/internal/actions/SQLConnectAction.java

/*******************************************************************************
 * Copyright (c) 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Eclipse Public License v1.0
 * which is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.datatools.sqltools.sqleditor.internal.actions;

import java.util.ResourceBundle;

import org.eclipse.datatools.connectivity.internal.core.connection.ConnectionInfo;
import org.eclipse.datatools.sqltools.sqleditor.internal.SQLEditor;
import org.eclipse.ui.texteditor.ResourceAction;

/**
 * This class implements the "Connect" action for the SQL Editor.
 * 
 * @see org.eclipse.datatools.sqltools.sqleditor.internal.SQLEditorActionContributor
 * @see org.eclipse.ui.texteditor.ResourceAction
 */
public class SQLConnectAction extends ResourceAction {
    public static final String CONNECTION = "Connection"; //$NON-NLS-1$
    
    private ConnectionInfo fConnInfo;
    private SQLEditor fSQLEditor;
    
    /**
     * Creates an instance of this class using the given resource bundle
     * and prefix of a set of resources within the bundle.
     * 
     * @param bundle the resource bundle to use
     * @param prefix the resource prefix to use
     */
    public SQLConnectAction( ResourceBundle bundle, String prefix ) {
        super( bundle, prefix );
    }

    /**
     * Gets the current <code>ConnectionInfo</code> object associated with this
     * action.
     * 
     * @return the current <code>ConnectionInfo</code> object
     */
    public ConnectionInfo getConnectionInfo() {
        return fConnInfo;
    }
    
    /**
     * Gets the SQLEditor instance associated with this action.
     * 
     * @return the SQLEditor instance for this action
     */
    public SQLEditor getSQLEditor() {
        return fSQLEditor;
    }

    /**
     * Runs this action.  Prompts the user to specify a database connection
     * to use with this editor.
     * 
     * @see org.eclipse.jface.action.IAction#run()
     */
    public void run() {
        SQLEditor editor = getSQLEditor();
        if (editor != null) {
            ConnectionInfo newConnInfo = editor.requestConnectionFromUser();
            if (newConnInfo != null) {
               firePropertyChange( CONNECTION, getConnectionInfo(), newConnInfo );
               setConnectionInfo( newConnInfo );
            }
        }
    }

    /**
     * Sets the current <code>ConnectionInfo</code> object to the given object.
     * 
     * @param connInfo the <code>ConnectionInfo</code> object to set
     */
    public void setConnectionInfo( ConnectionInfo connInfo ) {
        fConnInfo = connInfo;
    }

    /**
     * Sets the SQLEditor instance associated with this action to the given object.
     * 
     * @param sqlEditor the SQLEditor instance for this action
     */
    public void setSQLEditor( SQLEditor sqlEditor ) {
        fSQLEditor = sqlEditor;
    }

} // end class