| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.datatools.sqltools.sqleditor.SQLEditorConnectionInfo
public class SQLEditorConnectionInfo
This class provides the default implementation for ISQLEditorConnectionInfo.
| Field Summary | |
|---|---|
| static ISQLEditorConnectionInfo | DEFAULT_SQLEDITOR_CONNECTION_INFO | 
| Constructor Summary | |
|---|---|
| SQLEditorConnectionInfo(org.eclipse.datatools.sqltools.core.DatabaseVendorDefinitionId dbVendorId)Constructs a SQLEditorConnectionInfobyDatabaseVendorDefinitionId. | |
| SQLEditorConnectionInfo(org.eclipse.datatools.sqltools.core.DatabaseVendorDefinitionId dbVendorId,
                        java.lang.String profileName,
                        java.lang.String dbName)Constructs a SQLEditorConnectionInfo. | |
| SQLEditorConnectionInfo(org.eclipse.datatools.sqltools.core.DatabaseVendorDefinitionId dbVendorId,
                        java.lang.String profileName,
                        java.lang.String dbName,
                        java.lang.String schemaName)Constructs a SQLEditorConnectionInfo. | |
| Method Summary | |
|---|---|
| static ISQLEditorConnectionInfo | decode(java.lang.String code)Decodes a SQLEditorConnectionInfofrom an encoded String | 
|  java.lang.String | encode()Encodes the given SQLEditorConnectionInfoobject for persistency. | 
|  IConnectionProfile | getConnectionProfile()Gets the IConnectionProfileobject associated with this input. | 
|  java.lang.String | getConnectionProfileName()Gets the IConnectionProfilename associated with this input. | 
|  Database | getDatabase()Gets the Databaseobject associated with this input. | 
|  java.lang.String | getDatabaseName()Gets the database name associated with this input. | 
|  org.eclipse.datatools.modelbase.dbdefinition.DatabaseVendorDefinition | getDatabaseVendorDefinition()Gets the DatabaseVendorDefinitionobject associated with this input. | 
|  org.eclipse.datatools.sqltools.core.DatabaseVendorDefinitionId | getDatabaseVendorDefinitionId()Gets the DatabaseVendorDefinitionIdobject associated with this input. | 
|  java.lang.String | getDefaultSchemaName()Gets the default schema name to use with the connection or database associated with this input. | 
|  java.lang.String | getName()Gets a String representing this object. | 
|  int | getProfileStatus() | 
|  java.sql.Connection | getSharedConnection()Retrieves the sharable connection from IControlConnection, which in turn delegates to the connectivity layer. | 
|  boolean | isConnected() | 
|  void | setConnectionProfileName(java.lang.String profileName)Sets the IConnectionProfilename associated with this input to the given 
 object. | 
|  void | setDatabase(Database database)Sets the Databaseobject associated with this input to the
 given object. | 
|  void | setDatabaseName(java.lang.String dbName) | 
|  void | setDatabaseVendorDefinitionId(org.eclipse.datatools.sqltools.core.DatabaseVendorDefinitionId dbVendorDefId)Sets the DatabaseVendorDefinitionIdassociated with this input to the given 
 object. | 
|  void | setDefaultSchemaName(java.lang.String schemaName)Sets the default schema name to use with the connection or database associated with this input. | 
|  void | setProfileStatus(int status) | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static ISQLEditorConnectionInfo DEFAULT_SQLEDITOR_CONNECTION_INFO
| Constructor Detail | 
|---|
public SQLEditorConnectionInfo(org.eclipse.datatools.sqltools.core.DatabaseVendorDefinitionId dbVendorId)
SQLEditorConnectionInfo by
 DatabaseVendorDefinitionId. This is used when connction
 profile information is not available.
dbVendorId - DatabaseVendorDefinitionIdDefaultDBFactory.getDefaultInstance().getDatabaseVendorDefinitionId()
public SQLEditorConnectionInfo(org.eclipse.datatools.sqltools.core.DatabaseVendorDefinitionId dbVendorId,
                               java.lang.String profileName,
                               java.lang.String dbName)
SQLEditorConnectionInfo.
dbVendorId - DatabaseVendorDefinitionId, can be null if clients want it to be created from profileNameprofileName - connection profile namedbName - database name
public SQLEditorConnectionInfo(org.eclipse.datatools.sqltools.core.DatabaseVendorDefinitionId dbVendorId,
                               java.lang.String profileName,
                               java.lang.String dbName,
                               java.lang.String schemaName)
SQLEditorConnectionInfo.
dbVendorId - DatabaseVendorDefinitionId, can be null if clients want it to be created from profileNameprofileName - connection profile namedbName - database nameschemaName - default schema name| Method Detail | 
|---|
public org.eclipse.datatools.sqltools.core.DatabaseVendorDefinitionId getDatabaseVendorDefinitionId()
ISQLEditorConnectionInfoDatabaseVendorDefinitionId object associated with this input.
 The DatabaseVendorDefinitionId object identifies a DatabaseVendorDefinition object
getDatabaseVendorDefinitionId in interface ISQLEditorConnectionInfoDatabaseVendorDefinitionId object associated with this input, can never be null.
 A default DatabaseVendorDefinitionId object will be return if not specified.public org.eclipse.datatools.modelbase.dbdefinition.DatabaseVendorDefinition getDatabaseVendorDefinition()
ISQLEditorConnectionInfoDatabaseVendorDefinition object associated with this input.
 The DatabaseVendorDefinition object contains the information needed
 to do parsing, syntax highlighting, and syntax validation.
getDatabaseVendorDefinition in interface ISQLEditorConnectionInfoDatabaseVendorDefinition object associated with this input, can never be null.
 A default DatabaseVendorDefinition object will be return if not specified.public IConnectionProfile getConnectionProfile()
ISQLEditorConnectionInfoIConnectionProfile object associated with this input.
 The IConnectionProfile object contains the information needed
 to connect to a database.
getConnectionProfile in interface ISQLEditorConnectionInfoIConnectionProfile object associated with this input
 or null if none or profile name is invalidpublic java.lang.String getConnectionProfileName()
ISQLEditorConnectionInfoIConnectionProfile name associated with this input.
 The IConnectionProfile object contains the information needed
 to connect to a database.
getConnectionProfileName in interface ISQLEditorConnectionInfoIConnectionProfile name associated with this input
 or null if nonepublic Database getDatabase()
ISQLEditorConnectionInfoDatabase object associated with this input.  The
 Database object provides access to database metadata (catalog)
 information.
getDatabase in interface ISQLEditorConnectionInfoDatabase object associated with this input, or
 null if nonepublic java.lang.String getDatabaseName()
ISQLEditorConnectionInfo
getDatabaseName in interface ISQLEditorConnectionInfonull if noneISQLEditorConnectionInfo.getDatabase()public void setDatabaseName(java.lang.String dbName)
public java.lang.String getDefaultSchemaName()
ISQLEditorConnectionInfo
getDefaultSchemaName in interface ISQLEditorConnectionInfopublic void setConnectionProfileName(java.lang.String profileName)
ISQLEditorConnectionInfoIConnectionProfile name associated with this input to the given 
 object.
setConnectionProfileName in interface ISQLEditorConnectionInfoprofileName - the IConnectionProfile name to setpublic void setDatabase(Database database)
ISQLEditorConnectionInfoDatabase object associated with this input to the
 given object.
setDatabase in interface ISQLEditorConnectionInfodatabase - the Database object to setpublic void setDefaultSchemaName(java.lang.String schemaName)
ISQLEditorConnectionInfo
setDefaultSchemaName in interface ISQLEditorConnectionInfopublic void setDatabaseVendorDefinitionId(org.eclipse.datatools.sqltools.core.DatabaseVendorDefinitionId dbVendorDefId)
ISQLEditorConnectionInfoDatabaseVendorDefinitionId associated with this input to the given 
 object.
setDatabaseVendorDefinitionId in interface ISQLEditorConnectionInfodbVendorDefId - the DatabaseVendorDefinitionId object to setpublic java.lang.String encode()
SQLEditorConnectionInfo object for persistency.
encode in interface ISQLEditorConnectionInfoinfo - 
decode()public static ISQLEditorConnectionInfo decode(java.lang.String code)
SQLEditorConnectionInfo from an encoded String
code - 
SQLEditorConnectionInfo objectencode()public java.lang.String getName()
ISQLEditorConnectionInfo
getName in interface ISQLEditorConnectionInfopublic java.sql.Connection getSharedConnection()
getSharedConnection in interface ISQLEditorConnectionInfopublic int getProfileStatus()
getProfileStatus in interface ISQLEditorConnectionInfopublic void setProfileStatus(int status)
setProfileStatus in interface ISQLEditorConnectionInfopublic boolean isConnected()
isConnected in interface ISQLEditorConnectionInfo| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||