net.sourceforge.squirrel_sql.plugins.dbdiff
Class DBDiffPlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.dbdiff.DBDiffPlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin, SessionInfoProvider

public class DBDiffPlugin
extends DefaultSessionPlugin
implements SessionInfoProvider

The class that sets up the various resources required by SQuirreL to implement a plugin. This plugin implements the ability to diff tables and various other table-related objects from one database to another.

Field Summary

static String

BUNDLE_BASE_NAME

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

_app

Constructor Summary

DBDiffPlugin()

Method Summary

protected void	addMenuItemsToContextMenu(ISession session)
String	getAuthor()
String	getChangeLogFileName() Returns the name of the change log for the plugin.
String	getContributors()
String	getDescriptiveName()
IDatabaseObjectInfo[]	getDestSelectedDatabaseObjects()
ISession	getDiffDestSession()
ISession	getDiffSourceSession()
IGlobalPreferencesPanel[]	getGlobalPreferencePanels() Create panel for the Global Properties dialog.
String	getHelpFileName() Returns the name of the Help file for the plugin.
String	getInternalName()
String	getLicenceFileName()
IDatabaseObjectInfo[]	getSourceSelectedDatabaseObjects()
String	getVersion()
void	initialize()
PluginSessionCallback	sessionStarted(ISession session)
void	setCompareMenuEnabled(boolean enabled)
void	setDestDiffSession(ISession session)
void	setDestSelectedDatabaseObjects(IDatabaseObjectInfo[] info)
void	setDiffSourceSession(ISession session)
void	setSelectedDatabaseObjects(IDatabaseObjectInfo[] dbObjArr)
void	unload()

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

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

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

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

Field Detail

BUNDLE_BASE_NAME

public static final String BUNDLE_BASE_NAME

See Also:

Constant Field Values

Constructor Detail

DBDiffPlugin

public DBDiffPlugin()

Method Detail

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)

Specified by:

sessionStarted in interface ISessionPlugin

getInternalName

public String getInternalName()

Specified by:

getInternalName in interface IPlugin

getDescriptiveName

public String getDescriptiveName()

Specified by:

getDescriptiveName in interface IPlugin

getAuthor

public String getAuthor()

Specified by:

getAuthor in interface IPlugin

getContributors

public String getContributors()

Specified by:

getContributors in interface IPlugin

Overrides:

getContributors in class DefaultPlugin

getVersion

public String getVersion()

Specified by:

getVersion in interface IPlugin

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.

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.

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

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class DefaultPlugin

Throws:

PluginException

unload

public void unload()

Specified by:

unload in interface IPlugin

Overrides:

unload in class DefaultPlugin

setSelectedDatabaseObjects

public void setSelectedDatabaseObjects(IDatabaseObjectInfo[] dbObjArr)

Parameters:

selectedDatabaseObjects - The selectedDatabaseObjects to set.

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.

addMenuItemsToContextMenu

protected void addMenuItemsToContextMenu(ISession session)

Parameters:

coll -

api -

setCompareMenuEnabled

public void setCompareMenuEnabled(boolean enabled)

getDiffSourceSession

public ISession getDiffSourceSession()

Specified by:

getDiffSourceSession in interface SessionInfoProvider

setDiffSourceSession

public void setDiffSourceSession(ISession session)

Specified by:

setDiffSourceSession in interface SessionInfoProvider

getSourceSelectedDatabaseObjects

public IDatabaseObjectInfo[] getSourceSelectedDatabaseObjects()

Specified by:

getSourceSelectedDatabaseObjects in interface SessionInfoProvider

getDiffDestSession

public ISession getDiffDestSession()

Specified by:

getDiffDestSession in interface SessionInfoProvider

setDestDiffSession

public void setDestDiffSession(ISession session)

Specified by:

setDestDiffSession in interface SessionInfoProvider

getDestSelectedDatabaseObjects

public IDatabaseObjectInfo[] getDestSelectedDatabaseObjects()

Specified by:

getDestSelectedDatabaseObjects in interface SessionInfoProvider

setDestSelectedDatabaseObjects

public void setDestSelectedDatabaseObjects(IDatabaseObjectInfo[] info)

Specified by:

setDestSelectedDatabaseObjects in interface SessionInfoProvider