Java Doc for ISession.java in » Database-Client » squirrel-sql-2.6.5a » net » sourceforge » squirrel_sql » client » session » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database Client » squirrel sql 2.6.5a » net.sourceforge.squirrel_sql.client.session

Source Cross Reference Class Diagram Java Document (Java Doc)

net.sourceforge.squirrel_sql.client.session .ISession

All known Subclasses:   net.sourceforge.squirrel_sql.client.session .MockSession,  net.sourceforge.squirrel_sql.client.session .Session,
ISession
public interface ISession extends IHasIdentifier(Code)
The current session.

Inner Class :public interface IMainPanelTabIndexes extends MainPanel.ITabIndexes

Method Summary
int addMainTab(IMainPanelTab tab)
     Add a tab to the main tabbed panel.
Parameters:
  tab - The tab to be added.
public void addSeparatorToToolbar()

void addToStatusBar(JComponent comp)
     Add component to the session sheets status bar.
void addToToolbar(Action action)
     Add the passed action to the toolbar of the sessions main window.
void close()
     Close this session.
throws:
  SQLException - Thrown if an error closing the SQL connection.
void closeSQLConnection()
     Close the current connection to the database.
void commit()
     Commit the current SQL session.
public boolean confirmClose()
     Determine from the session whether or not it is ok to close it.
String formatException(Throwable t)

BaseSessionInternalFrame getActiveSessionWindow()
     Hint for plugins: When ISessionPlugin.sessionStarted is called the active session window is always the SessionInternalFrame which provides an SQLPanelAPI.
ISQLAliasExt getAlias()
     Return the alias used to connect to the database.
IApplication getApplication()
     Return the Application API object.
ISQLDriver getDriver()
     Return the driver used to connect to the database.
ExceptionFormatter getExceptionFormatter()
     Returns the exception formatter to use when handling messages.
ISQLDatabaseMetaData getMetaData()
     Return the current SQL connection database metadata.
IObjectTreeAPI getObjectTreeAPIOfActiveSessionWindow()
     Hint for plugins: When ISessionPlugin.sessionStarted is called the active session window is always the SessionInternalFrame which provides an SQLPanelAPI.
IParserEventsProcessor getParserEventsProcessor(IIdentifier sqlEntryPanelIdentifier)
     The code in any SQLEditor is parsed in the background.
Object getPluginObject(IPlugin plugin, String key)

SessionProperties getProperties()
     Return the properties for this session.
IQueryTokenizer getQueryTokenizer()
     Returns the IQueryTokenizer implementation to use for tokenizing scripts statements that should be sent to the server.
ISQLConnection getSQLConnection()
     Return the current SQL connection object.
ISQLPanelAPI getSQLPanelAPIOfActiveSessionWindow()
     Hint for plugins: When ISessionPlugin.sessionStarted is called the active session window is always the SessionInternalFrame which provides an SQLPanelAPI.
net.sourceforge.squirrel_sql.client.session.schemainfo.SchemaInfo getSchemaInfo()
     Retrieve the schema information object for this session.
SessionInternalFrame getSessionInternalFrame()

SessionPanel getSessionSheet()

String getTitle()
     Retrieve the descriptive title of this session.
boolean isClosed()
     Retrieve whether this session has been closed.
public boolean isfinishedLoading()

Object putPluginObject(IPlugin plugin, String key, Object obj)

void reconnect()
     Reconnect to the database.
void removeFromStatusBar(JComponent comp)
     Remove component to the session sheets status bar.
void removePluginObject(IPlugin plugin, String key)

void rollback()
     Rollback the current SQL session.
void selectMainTab(int tabIndex)
     Select a tab in the main tabbed pane.
Parameters:
  tabIndex - The tab to select.
void setActiveSessionWindow(BaseSessionInternalFrame activeActiveSessionWindow)

void setExceptionFormatter(ExceptionFormatter formatter)
     Sets the exception formatter to use when handling messages.
void setMessageHandler(IMessageHandler handler)

public void setPluginsfinishedLoading(boolean _finishedLoading)

public void setQueryTokenizer(IQueryTokenizer tokenizer)
     Sets the IQueryTokenizer implementation to use for this session.
void setSessionInternalFrame(SessionInternalFrame sif)

void showErrorMessage(Throwable th)
     Show an error message describing the passed exception.
void showErrorMessage(String msg)
     Show an error message.
void showMessage(Throwable th)
     Show a message describing the passed exception.
void showMessage(String msg)
     Show a message.
void showWarningMessage(String msg)


Method Detail
addMainTab
int addMainTab(IMainPanelTab tab)(Code)
Add a tab to the main tabbed panel.
Parameters:
  tab - The tab to be added. the index of the new tab that was added.
throws:
  IllegalArgumentException - Thrown if a null IMainPanelTab passed.

addSeparatorToToolbar
public void addSeparatorToToolbar()(Code)

addToStatusBar
void addToStatusBar(JComponent comp)(Code)
Add component to the session sheets status bar.
Parameters:
  comp - Component to add.

addToToolbar
void addToToolbar(Action action)(Code)
Add the passed action to the toolbar of the sessions main window.
Parameters:
  action - Action to be added.

close
void close() throws SQLException(Code)
Close this session.
throws:
  SQLException - Thrown if an error closing the SQL connection. The sessionwill still be closed even though the connection may not havebeen.

closeSQLConnection
void closeSQLConnection() throws SQLException(Code)
Close the current connection to the database.
throws:
  SQLException - if an SQL error occurs.

commit
void commit()(Code)
Commit the current SQL session.

confirmClose
public boolean confirmClose()(Code)
Determine from the session whether or not it is ok to close it. It might be the case that the session's SQLPanel has unsaved edits that require the user's approval to discard. true if it's ok to close the session; false otherwise.

formatException
String formatException(Throwable t)(Code)
Facade method for ExceptionFormatter to allow callers to safely get a formatted exception without forcing them to wrap it in a try/catch block
Parameters:
  t - the exception to format the context of the exception, in default or custom format, depending on whether or not a custom ExceptionFormatter was installed.

getActiveSessionWindow
BaseSessionInternalFrame getActiveSessionWindow()(Code)
Hint for plugins: When ISessionPlugin.sessionStarted is called the active session window is always the SessionInternalFrame which provides an SQLPanelAPI. This might help to simplyfy the code in the sessionStarted() method of a plugin.

getAlias
ISQLAliasExt getAlias()(Code)
Return the alias used to connect to the database. the alias used to connect to the database.

getApplication
IApplication getApplication()(Code)
Return the Application API object. the Application API object.

getDriver
ISQLDriver getDriver()(Code)
Return the driver used to connect to the database. the driver used to connect to the database.

getExceptionFormatter
ExceptionFormatter getExceptionFormatter()(Code)
Returns the exception formatter to use when handling messages.

getMetaData
ISQLDatabaseMetaData getMetaData()(Code)
Return the current SQL connection database metadata. the current SQL connection database metadata.

getObjectTreeAPIOfActiveSessionWindow
IObjectTreeAPI getObjectTreeAPIOfActiveSessionWindow()(Code)
Hint for plugins: When ISessionPlugin.sessionStarted is called the active session window is always the SessionInternalFrame which provides an SQLPanelAPI. This might help to simplyfy the code in the sessionStarted() method of a plugin.
throws:
  IllegalStateException - if ActiveSessionWindow doesn't provide an IObjectTreeAPIfor example if it is an SQLInternalFrame

getParserEventsProcessor
IParserEventsProcessor getParserEventsProcessor(IIdentifier sqlEntryPanelIdentifier)(Code)
The code in any SQLEditor is parsed in the background. You may attach a listener to the ParserEventsProcessor to get to know about the results of parsing. The events are passed synchron with the event queue (via SwingUtils.invokeLater()). At the moment events are produced for errors in the SQLScript which are highlighted in the syntax plugin and for aliases of table names which are used in the code completion plugin.
If you want the ParserEventsProcessor to produce further events feel free to contact gerdwagner@users.sourceforge.net.

getPluginObject
Object getPluginObject(IPlugin plugin, String key)(Code)

getProperties
SessionProperties getProperties()(Code)
Return the properties for this session. the properties for this session.

getQueryTokenizer
IQueryTokenizer getQueryTokenizer()(Code)
Returns the IQueryTokenizer implementation to use for tokenizing scripts statements that should be sent to the server. an implementation of IQueryTokenizer

getSQLConnection
ISQLConnection getSQLConnection()(Code)
Return the current SQL connection object. the current SQL connection object.

getSQLPanelAPIOfActiveSessionWindow
ISQLPanelAPI getSQLPanelAPIOfActiveSessionWindow()(Code)
Hint for plugins: When ISessionPlugin.sessionStarted is called the active session window is always the SessionInternalFrame which provides an SQLPanelAPI. This might help to simplyfy the code in the sessionStarted() method of a plugin.
throws:
  IllegalStateException - if ActiveSessionWindow doesn't provide an SQLPanelAPIfor example if it is an ObjectTreeInternalFrame

getSchemaInfo
net.sourceforge.squirrel_sql.client.session.schemainfo.SchemaInfo getSchemaInfo()(Code)
Retrieve the schema information object for this session.

getSessionInternalFrame
SessionInternalFrame getSessionInternalFrame()(Code)

getSessionSheet
SessionPanel getSessionSheet()(Code)

getTitle
String getTitle()(Code)
Retrieve the descriptive title of this session. The descriptive title of this session.

isClosed
boolean isClosed()(Code)
Retrieve whether this session has been closed. true if session closed else false.

isfinishedLoading
public boolean isfinishedLoading()(Code)
Returns the _finishedLoading.

putPluginObject
Object putPluginObject(IPlugin plugin, String key, Object obj)(Code)

reconnect
void reconnect()(Code)
Reconnect to the database.

removeFromStatusBar
void removeFromStatusBar(JComponent comp)(Code)
Remove component to the session sheets status bar.
Parameters:
  comp - Component to remove.

removePluginObject
void removePluginObject(IPlugin plugin, String key)(Code)

rollback
void rollback()(Code)
Rollback the current SQL session.

selectMainTab
void selectMainTab(int tabIndex) throws IllegalArgumentException(Code)
Select a tab in the main tabbed pane.
Parameters:
  tabIndex - The tab to select. @see #IMainTabIndexes
throws:
  IllegalArgumentException - Thrown if an invalid tabIndex passed.

setActiveSessionWindow
void setActiveSessionWindow(BaseSessionInternalFrame activeActiveSessionWindow)(Code)

setExceptionFormatter
void setExceptionFormatter(ExceptionFormatter formatter)(Code)
Sets the exception formatter to use when handling messages.
Parameters:
  formatter - the ExceptionFormatter
Parameters:
  session - TODO

setMessageHandler
void setMessageHandler(IMessageHandler handler)(Code)

setPluginsfinishedLoading
public void setPluginsfinishedLoading(boolean _finishedLoading)(Code)

Parameters:
  _finishedLoading - The _finishedLoading to set.

setQueryTokenizer
public void setQueryTokenizer(IQueryTokenizer tokenizer)(Code)
Sets the IQueryTokenizer implementation to use for this session.
Parameters:
  tokenizer -

setSessionInternalFrame
void setSessionInternalFrame(SessionInternalFrame sif)(Code)

showErrorMessage
void showErrorMessage(Throwable th)(Code)
Show an error message describing the passed exception. This will apply any custom formatting if an ExceptionFormatter has been set.
Parameters:
  th - the exception to be shown

showErrorMessage
void showErrorMessage(String msg)(Code)
Show an error message. The implementation of IMessageHandler may or may not treat this differently to showMessage(String).
Parameters:
  session - the session that generated the exception.
Parameters:
  th - Exception.

showMessage
void showMessage(Throwable th)(Code)
Show a message describing the passed exception. This will apply any custom formatting if an ExceptionFormatter has been set.
Parameters:
  th - the exception to be shown

showMessage
void showMessage(String msg)(Code)
Show a message.
Parameters:
  msg - The message.

showWarningMessage
void showWarningMessage(String msg)(Code)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.