net.sourceforge.squirrel_sql.plugins.graph
Class GraphPlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.graph.GraphPlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class GraphPlugin
extends DefaultSessionPlugin

The SQL Script plugin class.

Field Summary

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

_app

Constructor Summary

GraphPlugin()

Method Summary

GraphController	createNewGraphControllerForSession(ISession session)
java.lang.String	getAuthor() Returns the authors name.
java.lang.String	getChangeLogFileName() Returns the name of the change log for the plugin.
java.lang.String	getDescriptiveName() Return the descriptive name of this plugin.
GraphController[]	getGraphControllers(ISession session)
java.lang.String	getHelpFileName() Returns the name of the Help file for the plugin.
java.lang.String	getInternalName() Return the internal name of this plugin.
java.lang.String	getLicenceFileName() Returns the name of the Licence file for the plugin.
java.lang.String	getVersion() Returns the current version of this plugin.
void	initialize() Initialize this plugin.
java.lang.String	patchName(java.lang.String name, ISession session)
void	removeGraphController(GraphController toRemove, ISession session)
void	sessionEnding(ISession session)
PluginSessionCallback	sessionStarted(ISession session) Called when a session started.
void	unload() Application is shutting down so save data.

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

allowsSessionStartedInBackground, getDefaultNodeExpander, getObjectTypes, getSessionPropertiesPanels, isPluginSession, registerSessionMenu, sessionCreated

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

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

Constructor Detail

GraphPlugin

public GraphPlugin()

Method Detail

getInternalName

public java.lang.String getInternalName()

Return the internal name of this plugin.

Returns:

the internal name of this plugin.

getDescriptiveName

public java.lang.String getDescriptiveName()

Return the descriptive name of this plugin.

Returns:

the descriptive name of this plugin.

getVersion

public java.lang.String getVersion()

Returns the current version of this plugin.

Returns:

the current version of this plugin.

getAuthor

public java.lang.String getAuthor()

Returns the authors name.

Returns:

the authors name.

getChangeLogFileName

public java.lang.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 java.lang.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 java.lang.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

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 data.

Specified by:

unload in interface IPlugin

Overrides:

unload in class DefaultPlugin

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)

Called when a session started. Add commands to popup menu in object tree.

Parameters:

session - The session that is starting.

Returns:

true to indicate that this plugin is applicable to passed session.

sessionEnding

public void sessionEnding(ISession session)

Specified by:

sessionEnding in interface ISessionPlugin

Overrides:

sessionEnding in class DefaultSessionPlugin

getGraphControllers

public GraphController[] getGraphControllers(ISession session)

patchName

public java.lang.String patchName(java.lang.String name,
                                  ISession session)

createNewGraphControllerForSession

public GraphController createNewGraphControllerForSession(ISession session)

removeGraphController

public void removeGraphController(GraphController toRemove,
                                  ISession session)