net.sourceforge.squirrel_sql.plugins.sqlreplace
Class SQLReplacePlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.sqlreplace.SQLReplacePlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class SQLReplacePlugin
extends DefaultSessionPlugin

Main entry into the SQL Replace plugin.

This plugin allows you to maintain a set of frequently used SQL scripts for easy playback. There is also a parameter replacement syntax available for the SQL files.

Author:

Dieter

Field Summary

static String

RESOURCE_PATH

Fields inherited from class net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin

_app, applicationFiles, fileWrapperFactory

Constructor Summary

SQLReplacePlugin()

Method Summary

boolean	allowsSessionStartedInBackground()
String	getAuthor()
String	getChangeLogFileName()
String	getDescriptiveName()
IGlobalPreferencesPanel[]	getGlobalPreferencePanels() Create and return a preferences object.
String	getHelpFileName()
String	getInternalName()
String	getLicenceFileName()
protected String	getResourceString(String name) Get and return a string from the plugin resources.
String	getVersion()
void	initialize() Initialize this plugin.
void	sessionCreated(ISession session) Called on session creating by callback.
void	sessionEnding(ISession session) This method is called on session closing an needs to free resources.
PluginSessionCallback	sessionStarted(ISession session)
void	unload() Called on plugin unloading.

Methods inherited from class net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin

getDefaultNodeExpander, getObjectTypes, getSessionPropertiesPanels, isPluginSession, registerSessionMenu

Methods inherited from class net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin

aliasCopied, aliasRemoved, getAliasPropertiesPanelControllers, getApplication, getContributors, getExternalService, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load, setApplicationFiles, setFileWrapperFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sourceforge.squirrel_sql.client.plugin.IPlugin

aliasCopied, aliasRemoved, getAliasPropertiesPanelControllers, getContributors, getExternalService, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load, setApplicationFiles, setFileWrapperFactory

Field Detail

RESOURCE_PATH

public static final String RESOURCE_PATH

See Also:

Constant Field Values

Constructor Detail

SQLReplacePlugin

public SQLReplacePlugin()

Method Detail

getAuthor

public String getAuthor()

See Also:

IPlugin.getAuthor()

getDescriptiveName

public String getDescriptiveName()

See Also:

IPlugin.getDescriptiveName()

getInternalName

public String getInternalName()

See Also:

IPlugin.getInternalName()

getVersion

public String getVersion()

See Also:

IPlugin.getVersion()

getChangeLogFileName

public String getChangeLogFileName()

Specified by:

getChangeLogFileName in interface IPlugin

Overrides:

getChangeLogFileName in class DefaultPlugin

See Also:

DefaultPlugin.getChangeLogFileName()

getHelpFileName

public String getHelpFileName()

Specified by:

getHelpFileName in interface IPlugin

Overrides:

getHelpFileName in class DefaultPlugin

See Also:

DefaultPlugin.getHelpFileName()

getLicenceFileName

public String getLicenceFileName()

Specified by:

getLicenceFileName in interface IPlugin

Overrides:

getLicenceFileName in class DefaultPlugin

See Also:

DefaultPlugin.getLicenceFileName()

initialize

public void initialize()
                throws PluginException

Initialize this plugin.

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class DefaultPlugin

Throws:

PluginException

getResourceString

protected String getResourceString(String name)

Get and return a string from the plugin resources.

Parameters:

name - name of the resource string to return.

Returns:

resource string.

getGlobalPreferencePanels

public IGlobalPreferencesPanel[] getGlobalPreferencePanels()

Create and return a preferences object.

Specified by:

getGlobalPreferencePanels in interface IPlugin

Overrides:

getGlobalPreferencePanels in class DefaultPlugin

Returns:

The global preferences object.

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)

See Also:

ISessionPlugin.sessionStarted(net.sourceforge.squirrel_sql.client.session.ISession)

unload

public void unload()

Called on plugin unloading.

Specified by:

unload in interface IPlugin

Overrides:

unload in class DefaultPlugin

allowsSessionStartedInBackground

public boolean allowsSessionStartedInBackground()

Specified by:

allowsSessionStartedInBackground in interface ISessionPlugin

Overrides:

allowsSessionStartedInBackground in class DefaultSessionPlugin

See Also:

DefaultSessionPlugin.allowsSessionStartedInBackground()

sessionCreated

public void sessionCreated(ISession session)

Called on session creating by callback.

Specified by:

sessionCreated in interface ISessionPlugin

Overrides:

sessionCreated in class DefaultSessionPlugin

Parameters:

session - The session

sessionEnding

public void sessionEnding(ISession session)

This method is called on session closing an needs to free resources.

Specified by:

sessionEnding in interface ISessionPlugin

Overrides:

sessionEnding in class DefaultSessionPlugin

Parameters:

session - the session to be closed