net.sourceforge.squirrel_sql.plugins.sqlparam
Class SQLParamPlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.sqlparam.SQLParamPlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class SQLParamPlugin
extends DefaultSessionPlugin

The plugin class.

Author:

Thorsten Mürell

Field Summary

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

_app

Constructor Summary

SQLParamPlugin()

Method Summary

boolean	allowsSessionStartedInBackground()
String	getAuthor() Returns the authors name.
Map<String,String>	getCache() Returns the value cache.
String	getChangeLogFileName() Returns the name of the change log for the plugin.
String	getContributors() Returns a comma separated list of other contributors.
String	getDescriptiveName() Return the descriptive name of this plugin.
String	getHelpFileName() Returns the name of the Help file for the plugin.
String	getInternalName() Return the internal name of this plugin.
String	getLicenceFileName() Returns the name of the Licence file for the plugin.
PluginResources	getResources() Retrieve plugins resources.
String	getVersion() Returns the current version of this plugin.
void	initialize() Called on application startup after application started.
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) Session has been started.
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, getExternalService, getGlobalPreferencePanels, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load

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, getExternalService, getGlobalPreferencePanels, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, load

Constructor Detail

SQLParamPlugin

public SQLParamPlugin()

Method Detail

getInternalName

public String getInternalName()

Return the internal name of this plugin.

Returns:

the internal name of this plugin.

getDescriptiveName

public String getDescriptiveName()

Return the descriptive name of this plugin.

Returns:

the descriptive name of this plugin.

getVersion

public String getVersion()

Returns the current version of this plugin.

Returns:

the current version of this plugin.

getContributors

public String getContributors()

Returns a comma separated list of other contributors.

Specified by:

getContributors in interface IPlugin

Overrides:

getContributors in class DefaultPlugin

Returns:

Contributors names.

getAuthor

public String getAuthor()

Returns the authors name.

Returns:

the authors name.

getChangeLogFileName

public String getChangeLogFileName()

Returns the name of the change log for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory.

Specified by:

getChangeLogFileName in interface IPlugin

Overrides:

getChangeLogFileName in class DefaultPlugin

Returns:

the changelog file name or null if plugin doesn't have a change log.

getHelpFileName

public String getHelpFileName()

Returns the name of the Help file for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory.

Specified by:

getHelpFileName in interface IPlugin

Overrides:

getHelpFileName in class DefaultPlugin

Returns:

the Help file name or null if plugin doesn't have a help file.

getLicenceFileName

public String getLicenceFileName()

Returns the name of the Licence file for the plugin. This should be a text or HTML file residing in the getPluginAppSettingsFolder directory.

Specified by:

getLicenceFileName in interface IPlugin

Overrides:

getLicenceFileName in class DefaultPlugin

Returns:

the Licence file name or null if plugin doesn't have a licence file.

initialize

public void initialize()
                throws PluginException

Called on application startup after application started.

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class DefaultPlugin

Throws:

PluginException

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

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

getCache

public Map<String,String> getCache()

Returns the value cache.

Returns:

A map caching parameters to old values

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)

Session has been started.

Parameters:

session - Session that has started.

Returns:

The callback to start on session events.

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

getResources

public PluginResources getResources()

Retrieve plugins resources.

Returns:

Plugins resources.