net.sourceforge.squirrel_sql.plugins.oracle
Class OraclePlugin

java.lang.Object
  net.sourceforge.squirrel_sql.client.plugin.DefaultPlugin
      net.sourceforge.squirrel_sql.client.plugin.DefaultSessionPlugin
          net.sourceforge.squirrel_sql.plugins.oracle.OraclePlugin

All Implemented Interfaces:

IPlugin, ISessionPlugin

public class OraclePlugin
extends DefaultSessionPlugin

Oracle plugin class.

Author:

Colin Bell

Field Summary

static String

BUNDLE_BASE_NAME

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

_app, applicationFiles, fileWrapperFactory

Constructor Summary

OraclePlugin()

Method Summary

void	aliasCopied(SQLAlias source, SQLAlias target)
void	aliasRemoved(SQLAlias alias)
static boolean	checkObjectAccessible(ISession session, String query) Check if we can run query.
IAliasPropertiesPanelController[]	getAliasPropertiesPanelControllers(SQLAlias alias) Create Alias prefs panel.
String	getAuthor() Returns the authors name.
String	getChangeLogFileName()
String	getContributors() Returns a comma separated list of other contributors.
INodeExpander	getDefaultNodeExpander(ISession session, DatabaseObjectType type) Return a node expander for the object tree for a particular default node type.
String	getDescriptiveName() Return the descriptive name of this plugin.
IGlobalPreferencesPanel[]	getGlobalPreferencePanels() Create panel for the Global Properties dialog.
String	getHelpFileName()
String	getInternalName() Return the internal name of this plugin.
String	getLicenceFileName()
String	getVersion() Returns the current version of this plugin.
void	initialize()
protected boolean	isPluginSession(ISession session)
void	load(IApplication app)
void	sessionEnding(ISession session) Called when a session shutdown.
PluginSessionCallback	sessionStarted(ISession session)
void	unload()

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

allowsSessionStartedInBackground, getObjectTypes, getSessionPropertiesPanels, registerSessionMenu, sessionCreated

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

getApplication, 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

getExternalService, getNewSessionPropertiesPanels, getPluginAppSettingsFolder, getPluginJarFilePath, getPluginUserSettingsFolder, getWebSite, setApplicationFiles, setFileWrapperFactory

Field Detail

BUNDLE_BASE_NAME

public static final String BUNDLE_BASE_NAME

See Also:

Constant Field Values

Constructor Detail

OraclePlugin

public OraclePlugin()

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.

getAuthor

public String getAuthor()

Returns the authors name.

Returns:

the authors name.

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.

getChangeLogFileName

public String getChangeLogFileName()

Specified by:

getChangeLogFileName in interface IPlugin

Overrides:

getChangeLogFileName in class DefaultPlugin

See Also:

IPlugin.getChangeLogFileName()

getHelpFileName

public String getHelpFileName()

Specified by:

getHelpFileName in interface IPlugin

Overrides:

getHelpFileName in class DefaultPlugin

See Also:

IPlugin.getHelpFileName()

getLicenceFileName

public String getLicenceFileName()

Specified by:

getLicenceFileName in interface IPlugin

Overrides:

getLicenceFileName in class DefaultPlugin

See Also:

IPlugin.getLicenceFileName()

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

Specified by:

initialize in interface IPlugin

Overrides:

initialize in class DefaultPlugin

Throws:

PluginException

load

public void load(IApplication app)
          throws PluginException

Specified by:

load in interface IPlugin

Overrides:

load in class DefaultPlugin

Throws:

PluginException

unload

public void unload()

Specified by:

unload in interface IPlugin

Overrides:

unload in class DefaultPlugin

getAliasPropertiesPanelControllers

public IAliasPropertiesPanelController[] getAliasPropertiesPanelControllers(SQLAlias alias)

Create Alias prefs panel.

Specified by:

getAliasPropertiesPanelControllers in interface IPlugin

Overrides:

getAliasPropertiesPanelControllers in class DefaultPlugin

aliasCopied

public void aliasCopied(SQLAlias source,
                        SQLAlias target)

Specified by:

aliasCopied in interface IPlugin

Overrides:

aliasCopied in class DefaultPlugin

aliasRemoved

public void aliasRemoved(SQLAlias alias)

Specified by:

aliasRemoved in interface IPlugin

Overrides:

aliasRemoved in class DefaultPlugin

sessionEnding

public void sessionEnding(ISession session)

Called when a session shutdown.

Specified by:

sessionEnding in interface ISessionPlugin

Overrides:

sessionEnding in class DefaultSessionPlugin

Parameters:

session - The session that is ending.

sessionStarted

public PluginSessionCallback sessionStarted(ISession session)

isPluginSession

protected boolean isPluginSession(ISession session)

Overrides:

isPluginSession in class DefaultSessionPlugin

See Also:

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

getDefaultNodeExpander

public INodeExpander getDefaultNodeExpander(ISession session,
                                            DatabaseObjectType type)

Return a node expander for the object tree for a particular default node type.

A plugin could return non null here if they wish to override the default node expander bahaviour. Most plugins should return null here.

Specified by:

getDefaultNodeExpander in interface ISessionPlugin

Overrides:

getDefaultNodeExpander in class DefaultSessionPlugin

checkObjectAccessible

public static boolean checkObjectAccessible(ISession session,
                                            String query)

Check if we can run query.

Parameters:

session - session

query - query text

Returns:

true if query works fine