net.sourceforge.squirrel_sql.plugins.mysql
Class MysqlPlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.mysql.MysqlPlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class MysqlPlugin
extends DefaultSessionPlugin

MySQL plugin class.

Author:

Colin Bell

Nested Class Summary

static interface	MysqlPlugin.IKeys
static interface	MysqlPlugin.IMenuResourceKeys

Field Summary

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

_app, applicationFiles, fileWrapperFactory

Constructor Summary

MysqlPlugin()

Method Summary

boolean	allowsSessionStartedInBackground()
String	getAuthor() Returns the authors name.
String	getChangeLogFileName()
String	getDescriptiveName() Return the descriptive name of this plugin.
IGlobalPreferencesPanel[]	getGlobalPreferencePanels() Create panel for the Global Properties dialog.
String	getHelpFileName() Retrieve the name of the help file.
String	getInternalName() Return the internal name of this plugin.
String	getLicenceFileName() Retrieve the name of the licence file.
String	getVersion() Returns the current version of this plugin.
void	initialize() Initialize this plugin.
protected boolean	isPluginSession(ISession session) Returns true for any version of MySQL.
void	load(IApplication app) Load this plugin.
PluginSessionCallback	sessionStarted(ISession session) Session has been started.
void	setResourcesFactory(IPluginResourcesFactory resourcesFactory)
void	unload() Application is shutting down so save preferences.

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

getDefaultNodeExpander, getObjectTypes, getSessionPropertiesPanels, registerSessionMenu, sessionCreated, sessionEnding

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

aliasCopied, aliasRemoved, getAliasPropertiesPanelControllers, getApplication, getContributors, getExternalService, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, 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, setApplicationFiles, setFileWrapperFactory

Constructor Detail

MysqlPlugin

public MysqlPlugin()

Method Detail

setResourcesFactory

public void setResourcesFactory(IPluginResourcesFactory resourcesFactory)

Parameters:

resourcesFactory - the resourcesFactory to set

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.

See Also:

IPlugin.getDescriptiveName()

getVersion

public String getVersion()

Returns the current version of this plugin.

Returns:

the current version of this plugin.

getAuthor

public String getAuthor()

Returns the authors name.

Returns:

the authors name.

load

public void load(IApplication app)
          throws PluginException

Load this plugin.

Specified by:

load in interface IPlugin

Overrides:

load in class DefaultPlugin

Parameters:

app - Application API.

Throws:

PluginException

getChangeLogFileName

public String getChangeLogFileName()

Specified by:

getChangeLogFileName in interface IPlugin

Overrides:

getChangeLogFileName in class DefaultPlugin

See Also:

DefaultPlugin.getChangeLogFileName()

getHelpFileName

public String getHelpFileName()

Retrieve the name of the help file.

Specified by:

getHelpFileName in interface IPlugin

Overrides:

getHelpFileName in class DefaultPlugin

Returns:

The nane of the help file.

getLicenceFileName

public String getLicenceFileName()

Retrieve the name of the licence file.

Specified by:

getLicenceFileName in interface IPlugin

Overrides:

getLicenceFileName in class DefaultPlugin

Returns:

The nane of the licence file.

getGlobalPreferencePanels

public IGlobalPreferencesPanel[] getGlobalPreferencePanels()

Create panel for the Global Properties dialog.

Specified by:

getGlobalPreferencePanels in interface IPlugin

Overrides:

getGlobalPreferencePanels in class DefaultPlugin

Returns:

properties panel.

initialize

public void initialize()
                throws PluginException

Initialize this plugin.

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class DefaultPlugin

Throws:

PluginException

unload

public void unload()

Application is shutting down so save preferences.

Specified by:

unload in interface IPlugin

Overrides:

unload in class DefaultPlugin

See Also:

DefaultPlugin.unload()

allowsSessionStartedInBackground

public boolean allowsSessionStartedInBackground()

Specified by:

allowsSessionStartedInBackground in interface ISessionPlugin

Overrides:

allowsSessionStartedInBackground in class DefaultSessionPlugin

See Also:

DefaultSessionPlugin.allowsSessionStartedInBackground()

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)

Session has been started. If this is a MySQL session then setup MySQL tabs etc.

Parameters:

session - Session that has started.

Returns:

true if session is MySQL in which case this plugin is interested in it.

isPluginSession

protected boolean isPluginSession(ISession session)

Returns true for any version of MySQL.

Overrides:

isPluginSession in class DefaultSessionPlugin

See Also:

isPluginSession(net.sourceforge.squirrel_sql.client.session.ISession)