DatabaseConnector (Commons)

java.lang.Object
- com.lf.commons.db.DatabaseConnector

Direct Known Subclasses:

JavaDBClientConnector, JavaDBEmbeddedConnector, MySQLConnector, OracleConnector, PostgreSQLConnector, SQLServerConnector
```
public abstract class DatabaseConnector
extends java.lang.Object
```
Abstract class for configuring special database systems like Java DB (aka Derby).
Subclasses should configure the base class first by setting the database name and description, the driver name and display name. All other properties should be set by using the setter methods. Then the application should call connect() with the desired JDBC URL which may cause an admin or user connection be created. This depends on the connector implementation, so please see the documentation for details on how to setup the various connectors. Once the connect() method created a valid connection to the database, the connector can be used until the connection breaks or times out or if the disconnect() method is called explicitely
Instances should not be recycled e.g. by overriding the parameter container values since this is may cause errors e.g. by re-using undesired admin connections for normal users. Always create new connectors for new sessions.

Since:

1.6

Version:

$Revision: 1.40 $, $Date: 2013/02/28 17:44:25 $

Author:

Axel Schwolow

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Hashtable<java.lang.String,java.lang.String>`	`cacheSchemaByTable` Remembers the table-schema mappings.
`static int`	`CONNECT_AUTH_REQUIRED` Status for `connect()` method.
`static int`	`CONNECT_FAILED` Status for `connect()` method.
`static int`	`CONNECT_SUCCESS` Status for `connect()` method.
`protected java.lang.String`	`databaseDescription` The description of the represented database management system.
`protected java.lang.String`	`databaseName` The name of the represented database management system.
`protected DatabaseManager`	`dbManager` The database manager for getting connections etc.
`protected java.sql.Connection`	`defaultConn` The default connection to the database.
`protected java.lang.String`	`defaultConnURL` The JSBC URL for the default connection to the database.
`protected java.lang.String`	`driverDisplayName` The name of the underlying JDBC driver to be displayed.
`protected java.lang.String`	`driverName` Fully qualified class name of the underlying JDBC driver.
`protected java.lang.String`	`driverProductName` The name of the database product provided by the underlying JDBC driver.
`protected java.lang.String`	`driverProductVersion` The version of the database product provided by the underlying JDBC driver.
`protected java.util.Properties`	`params` The collection of parameters to use for the database.
`protected ConnectionPool`	`pool` The cache for re-used connections (optional).
`protected java.util.Hashtable<java.lang.String,java.lang.String>`	`schemaMappings` Cache for mappings of default schemas and the used schema names.
`protected JDBCConfiguration`	`typeConfig` Provides handlers for the popular JDBC data types (serialization).

Constructor Summary

Constructors
Constructor and Description
`DatabaseConnector()` Constructor method for i18n purposes only.
`DatabaseConnector(java.util.Properties params, DatabaseManager manager)` Constructor method for the connector.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSchemaMapping(java.lang.String defaultschema, java.lang.String usedschema)` Adds a mapping of a default schema and the corresponding used schema.
`boolean`	`checkAndCreateSchemas()` Makes sure that the required schemas do exist in the target database.
`abstract boolean`	`checkSequenceExists(java.lang.String schema, java.lang.String table)` Checks whether a sequence for the given target table does exist.
`abstract int`	`connect(java.lang.String jdbcurl)` Connects to the configured database.
`abstract boolean`	`createSequence(java.lang.String schema, java.lang.String table, int initval)` Creates a new sequence for the given target table.
`abstract javax.swing.tree.TreeNode[]`	`createSubTree(java.lang.String[] jdbcurls)` Creates a connector specific sub-tree from a set of JDBC URLs handled by the connector.
`boolean`	`disconnect()` Disconnects from the configured database.
`protected void`	`finalize()` Clean-up method to help the gc.
`java.io.InputStream`	`getBytes(int columnIndex, java.sql.ResultSet rs)` Provides the binary value from the certain column.
`byte[]`	`getBytes(java.sql.ResultSet rs, int columnIndex)` Provides the binary value from the certain column.
`byte[]`	`getBytes(java.sql.ResultSet rs, java.lang.String columnLabel)` Provides the binary value from the certain column.
`java.io.InputStream`	`getBytes(java.lang.String columnLabel, java.sql.ResultSet rs)` Provides the binary value from the certain column.
`ConnectionPool`	`getConnectionPool()` Provides the connection pool for doing statistics etc.
`java.lang.String`	`getDatabaseDescription()` Provides the description of the represented database management system.
`DatabaseManager`	`getDatabaseManager()` Provides the application specific database manager instance.
`java.lang.String`	`getDatabaseName()` Provides the display name of the represented database management system.
`java.lang.String`	`getDatabaseProductName()` Provides the product name provided by the underlying JDBC driver.
`java.lang.String`	`getDatabaseProductVersion()` Provides the product version provided by the underlying JDBC driver.
`java.sql.Connection`	`getDefaultConnection()` Creates a fresh connection for the given JDBC URL (never taken from the pool).
`abstract java.lang.String`	`getDefaultConnectionURL()` Provides the JDBC URL for the default conenction (normally a user connection).
`java.lang.String`	`getDefaultSchema(java.lang.String usedschema)` Provides the default schema name for the given used schema name.
`abstract java.lang.String`	`getDisplayURL(java.lang.String jdbcurl)` Makes sure that the given JDBC URL does not contain any passwords.
`java.sql.Driver`	`getDriver()` Returns the JDBC driver instance.
`java.lang.String`	`getDriverDisplayName()` Returns the display JDBC driver name (e.g.
`java.lang.String`	`getDriverName()` Returns the fully qualified JDBC driver (e.g.
`abstract javax.swing.ImageIcon`	`getIcon()` Provides the connector specific icon to represent it by GUI components.
`java.sql.Connection`	`getNewConnection(java.lang.String jdbcurl)` Creates a fresh connection for the given JDBC URL (never taken from the pool).
`java.lang.String`	`getParamDatabaseHost()` Provides the name of the database server used for JDBC.
`java.lang.String`	`getParamDatabaseName()` Provides the name of the target database used for JDBC.
`java.lang.String`	`getParamDatabasePort()` Provides the database server port used for JDBC.
`java.util.Properties`	`getParams()` Provides the current parameters used for the connector.
`java.sql.Connection`	`getPooledConnection(java.lang.String jdbcurl)` Provides an open connection for the given JDBC URL (re-used if possible).
`java.lang.String`	`getSchema(java.lang.String table)` Provides the schema of the given table.
`java.util.Hashtable<java.lang.String,java.lang.String>`	`getSchemaMappings()` Provides the internal cache with schema mappings.
`java.lang.String`	`getSchemaSeparator()` Provides the character sequence needed to separate schema and tables.
`abstract int`	`getSequenceCurrentValue(java.lang.String schema, java.lang.String table)` Reads the current (last generated) value from a sequence.
`abstract int`	`getSequenceNextValue(java.lang.String schema, java.lang.String table)` Reads the next value from a sequence.
`java.lang.String[]`	`getSerializedField(java.sql.ResultSet rs, java.lang.String colname)` Provides the serialized representation of a given database field value.
`java.lang.String`	`getTableFQN(java.lang.String table)` Convenience method to get the fully qualified table name including schema.
`java.lang.String`	`getTypeTable()` Provides the database specific type for regular tables (often "TABLE").
`java.lang.String`	`getUsedSchema(java.lang.String defaultschema)` Provides the used schema name for the given default schema name.
`abstract java.lang.String`	`getUserName()` Provides the name of the default user.
`abstract java.lang.String`	`getUserPassword()` Provides the password for the default user.
`boolean`	`isAvailable()` Is the JDBC driver available on the classpath?
`boolean`	`isBinary(int metadatatype)` Checks if the given JDBC type is binary to serialize native database types properly.
`boolean`	`isConnected()` Provides the info if this connector is currently connected to the database.
`boolean`	`isEmbedded()` Is this connector designed for an embedded database like Java DB?
`java.lang.Class`	`mapToJavaType(int metadatatype)` Provides the appropriate Java type to serialize native database types.
`boolean`	`releasePooledConnection(java.sql.Connection conn, java.lang.String jdbcurl)` Releases an occupied connection from the pool if not longer needed.
`java.lang.String`	`replaceParams(java.lang.String rawtext)` Replace placeholder variables with the current parameters settings of this connector.
`java.lang.String`	`replaceTableFQN(java.lang.String text, java.lang.String table)` Convenience method to replace table variables like %AGREEMENT% by table FQN (including schema).
`abstract boolean`	`resetSequence(java.lang.String schema, java.lang.String table, int nextval)` Resets an existing sequence for the given target table.
`void`	`setParams(java.util.Properties params)` Sets the current parameters used for the connector (only when disconnected).
`void`	`updateBytes(java.sql.ResultSet rs, int columnIndex, byte[] x)` Updates the designated column with a binary value.
`void`	`updateBytes(java.sql.ResultSet rs, int columnIndex, java.io.InputStream inputStream)` Updates the designated column with a binary value.
`void`	`updateBytes(java.sql.ResultSet rs, java.lang.String columnLabel, byte[] x)` Updates the designated column with a binary value.
`void`	`updateBytes(java.sql.ResultSet rs, java.lang.String columnLabel, java.io.InputStream inputStream)` Updates the designated column with a binary value.
`void`	`updateSchemaTables(java.lang.String[] schemas)` Updates the cache with tables found in the given schemas.
`boolean`	`updateSerializedField(java.sql.ResultSet rs, java.lang.String colname, java.lang.String value)` Updates a database field based on the given serialized value and column type.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONNECT_SUCCESS
```
public static final int CONNECT_SUCCESS
```
    Status for connect() method.
    
    See Also:
    Constant Field Values
  - CONNECT_FAILED
```
public static final int CONNECT_FAILED
```
    Status for connect() method.
    
    See Also:
    Constant Field Values
  - CONNECT_AUTH_REQUIRED
```
public static final int CONNECT_AUTH_REQUIRED
```
    Status for connect() method.
    
    See Also:
    Constant Field Values
  - databaseName
```
protected java.lang.String databaseName
```
    The name of the represented database management system.
  - databaseDescription
```
protected java.lang.String databaseDescription
```
    The description of the represented database management system.
  - driverName
```
protected java.lang.String driverName
```
    Fully qualified class name of the underlying JDBC driver.
  - driverDisplayName
```
protected java.lang.String driverDisplayName
```
    The name of the underlying JDBC driver to be displayed.
  - driverProductName
```
protected java.lang.String driverProductName
```
    The name of the database product provided by the underlying JDBC driver.
  - driverProductVersion
```
protected java.lang.String driverProductVersion
```
    The version of the database product provided by the underlying JDBC driver.
  - dbManager
```
protected DatabaseManager dbManager
```
    The database manager for getting connections etc.
  - params
```
protected java.util.Properties params
```
    The collection of parameters to use for the database.
  - defaultConn
```
protected java.sql.Connection defaultConn
```
    The default connection to the database.
  - defaultConnURL
```
protected java.lang.String defaultConnURL
```
    The JSBC URL for the default connection to the database.
  - pool
```
protected ConnectionPool pool
```
    The cache for re-used connections (optional).
  - typeConfig
```
protected JDBCConfiguration typeConfig
```
    Provides handlers for the popular JDBC data types (serialization).
  - schemaMappings
```
protected java.util.Hashtable<java.lang.String,java.lang.String> schemaMappings
```
    Cache for mappings of default schemas and the used schema names.
  - cacheSchemaByTable
```
protected java.util.Hashtable<java.lang.String,java.lang.String> cacheSchemaByTable
```
    Remembers the table-schema mappings.
- Constructor Detail
  - DatabaseConnector
```
public DatabaseConnector()
                  throws java.lang.InstantiationException
```
    Constructor method for i18n purposes only.
    Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).
    
    Throws:
    
    java.lang.InstantiationException - Error indication
    Since:
    
    1.6
  - DatabaseConnector
```
public DatabaseConnector(java.util.Properties params,
                 DatabaseManager manager)
```
    Constructor method for the connector.
    The sub class constructors must call super() to get the protected variables installed. After that the name sould be set. Configurations specific for the database system like setting initialization procedures must be handled by implementations.
    
    Parameters:
    params - The database configuration
    manager - The database manager
    
    Throws:
    
    java.lang.NullPointerException - If parameters are invalid
    Since:
    
    1.6
- Method Detail
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Clean-up method to help the gc.
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable - Error indication
    Since:
    
    1.6
  - getParams
```
public java.util.Properties getParams()
```
    Provides the current parameters used for the connector.
    
    Returns:
    Connector parameters, may be empty
    Since:
    
    1.6
  - setParams
```
public void setParams(java.util.Properties params)
```
    Sets the current parameters used for the connector (only when disconnected).
    
    Parameters:
    params - The new parameters
    
    Throws:
    
    java.lang.NullPointerException - If parameters are invalid
    Since:
    
    1.6
  - getDatabaseName
```
public java.lang.String getDatabaseName()
```
    Provides the display name of the represented database management system.
    
    Returns:
    Database handled by the implementation
    Since:
    
    1.6
  - getDatabaseDescription
```
public java.lang.String getDatabaseDescription()
```
    Provides the description of the represented database management system.
    
    Returns:
    Description of the database
    Since:
    
    1.6
  - getDriverName
```
public java.lang.String getDriverName()
```
    Returns the fully qualified JDBC driver (e.g. org.apache.derby.jdbc.ClientDriver) supported by the implementation.
    
    Returns:
    JDBC driver handled by the implementation
    Since:
    
    1.6
  - getDriverDisplayName
```
public java.lang.String getDriverDisplayName()
```
    Returns the display JDBC driver name (e.g. Apache Derby).
    
    Returns:
    Simple JDBC driver name, fully qualified in error case
    Since:
    
    1.6
  - getDriver
```
public java.sql.Driver getDriver()
```
    Returns the JDBC driver instance.
    
    Returns:
    JDBC driver instance, null if not available
    Since:
    
    1.6
  - isAvailable
```
public boolean isAvailable()
```
    Is the JDBC driver available on the classpath?
    
    Returns:
    Driver available?
    Since:
    
    1.6
  - connect
```
public abstract int connect(java.lang.String jdbcurl)
```
    Connects to the configured database.
    This method creates the default connection while the pool connections are created on demand. The default connection can be used as failsafe, for instance if the maximum number of active connections in the pool has been reached.
    
    Parameters:
    jdbcurl - The URL for the default connection
    
    Returns:
    CONNECT_SUCCESS | ...
    Since:
    
    1.6
  - disconnect
```
public boolean disconnect()
```
    Disconnects from the configured database.
    
    Returns:
    Successfully disconnected?
    Since:
    
    1.6
  - isConnected
```
public boolean isConnected()
```
    Provides the info if this connector is currently connected to the database.
    The connection is present if the default connection is alive. If this method returns false then none of the connection types should be used any more. Some drivers like PostgreSQL do not support the isValid() method yet.
    
    Returns:
    Currently connected?
    Since:
    
    1.6
  - getDefaultConnection
```
public java.sql.Connection getDefaultConnection()
```
    Creates a fresh connection for the given JDBC URL (never taken from the pool).
    Typical JDBC URLs look like "jdbc:derby://localhost:1527/lima". It's up to the application to properly close the connection if not need any longer. This kind of connections are useful if new databases are to be created. Whenever possible, already existing connections from the pool should be preferred.
    
    Returns:
    The default connection, null if not available
    Since:
    
    1.6
  - getDefaultConnectionURL
```
public abstract java.lang.String getDefaultConnectionURL()
```
    Provides the JDBC URL for the default conenction (normally a user connection).
    Typical JDBC URLs look like "jdbc:derby://localhost:1527/lima".
    
    Returns:
    The JDBC URL for the default connection, null if an error occurs
    Since:
    
    1.6
  - getNewConnection
```
public java.sql.Connection getNewConnection(java.lang.String jdbcurl)
                                     throws java.sql.SQLException
```
    Creates a fresh connection for the given JDBC URL (never taken from the pool).
    Typical JDBC URLs look like "jdbc:derby://localhost:1527/lima". It's up to the application to properly close the connection if not need any longer. This kind of connections are useful if new databases are to be created. Whenever possible, already existing connections from the pool should be preferred.
    
    Parameters:
    jdbcurl - The desired connector class in FQN
    
    Returns:
    The open connection, null if an error occurs
    
    Throws:
    
    java.sql.SQLException - If something goes wrong
    
    java.lang.IllegalStateException - If the connector is not connected
    Since:
    
    1.6
  - getDisplayURL
```
public abstract java.lang.String getDisplayURL(java.lang.String jdbcurl)
```
    Makes sure that the given JDBC URL does not contain any passwords.
    Use this method if a JDBC URL shall be be displayed for the users of your application and if you do not like passwords being exposed.
    
    Parameters:
    jdbcurl - The original URL including passwords
    
    Returns:
    The JDBC URL without passwords
    
    Throws:
    
    java.lang.NullPointerException - If parameters are invalid
    Since:
    
    1.6
  - createSubTree
```
public abstract javax.swing.tree.TreeNode[] createSubTree(java.lang.String[] jdbcurls)
```
    Creates a connector specific sub-tree from a set of JDBC URLs handled by the connector.
    This method creates tree nodes to be displayed by the StatusDialog class. The JDBC URLs directly reflect the database system capabilities which must be decoded by the connector implementations. The JDBC URLs can be structured into servers, databases, schemas etc. as is is useful for the underlying database system. Also user names and passwords are passed in different ways via the JDBC URLs for available databases.
    
    Parameters:
    jdbcurls - The JDBC URLs to be processed
    
    Returns:
    The array of tree nodes to be displayed
    
    Throws:
    
    java.lang.NullPointerException - If parameters are invalid
    Since:
    
    1.6
  - getPooledConnection
```
public java.sql.Connection getPooledConnection(java.lang.String jdbcurl)
                                        throws java.sql.SQLException
```
    Provides an open connection for the given JDBC URL (re-used if possible).
    Created freshly if no free connection is available. Don't forget to release such connections if not longer needed. Normally, applications garbage-collect free connections that have not been used for a certain period of time to save memory resources.
    
    Parameters:
    jdbcurl - The desired connector class in FQN
    
    Returns:
    The open connection, null if an error occurs
    
    Throws:
    
    java.sql.SQLException - If something goes wrong
    
    java.lang.IllegalStateException - If the connector is not connected
    Since:
    
    1.6
  - releasePooledConnection
```
public boolean releasePooledConnection(java.sql.Connection conn,
                              java.lang.String jdbcurl)
                                throws java.sql.SQLException
```
    Releases an occupied connection from the pool if not longer needed.
    
    Parameters:
    conn - The occupied connection
    jdbcurl - The desired connector class in FQN
    
    Returns:
    Successfully released?
    
    Throws:
    
    java.sql.SQLException - If something goes wrong
    
    java.lang.IllegalStateException - If the connector is not connected
    Since:
    
    1.6
  - getConnectionPool
```
public ConnectionPool getConnectionPool()
```
    Provides the connection pool for doing statistics etc.
    
    Returns:
    The connection pool
    Since:
    
    1.6
  - getUserName
```
public abstract java.lang.String getUserName()
```
    Provides the name of the default user.
    
    Returns:
    The user name, may be empty, but never null
    Since:
    
    1.6
  - getUserPassword
```
public abstract java.lang.String getUserPassword()
```
    Provides the password for the default user.
    
    Returns:
    The user password, may be empty, but never null
    Since:
    
    1.6
  - getDatabaseManager
```
public DatabaseManager getDatabaseManager()
```
    Provides the application specific database manager instance.
    
    Returns:
    The database manager
    Since:
    
    1.6
  - getDatabaseProductName
```
public java.lang.String getDatabaseProductName()
```
    Provides the product name provided by the underlying JDBC driver.
    
    Returns:
    The product name, may be null
    
    Throws:
    
    java.lang.IllegalStateException - If the connector is not connected
    Since:
    
    1.6
  - getDatabaseProductVersion
```
public java.lang.String getDatabaseProductVersion()
```
    Provides the product version provided by the underlying JDBC driver.
    
    Returns:
    The product version, may be null
    
    Throws:
    
    java.lang.IllegalStateException - If the connector is not connected
    Since:
    
    1.6
  - getParamDatabaseName
```
public java.lang.String getParamDatabaseName()
```
    Provides the name of the target database used for JDBC.
    
    Returns:
    The database name, may be null
    Since:
    
    1.6
  - getParamDatabaseHost
```
public java.lang.String getParamDatabaseHost()
```
    Provides the name of the database server used for JDBC.
    
    Returns:
    The database server, may be null
    Since:
    
    1.6
  - getParamDatabasePort
```
public java.lang.String getParamDatabasePort()
```
    Provides the database server port used for JDBC.
    
    Returns:
    The database server port, may be null
    Since:
    
    1.6
  - checkSequenceExists
```
public abstract boolean checkSequenceExists(java.lang.String schema,
                          java.lang.String table)
```
    Checks whether a sequence for the given target table does exist.
    
    Parameters:
    schema - The target schema (optional)
    table - The name of the target table
    
    Returns:
    Exists?
    Since:
    
    1.6
  - createSequence
```
public abstract boolean createSequence(java.lang.String schema,
                     java.lang.String table,
                     int initval)
```
    Creates a new sequence for the given target table.
    
    Parameters:
    schema - The target schema (optional)
    table - The name of the target table
    initval - The initial value from sequence
    
    Returns:
    Successful?
    Since:
    
    1.6
  - getSequenceCurrentValue
```
public abstract int getSequenceCurrentValue(java.lang.String schema,
                          java.lang.String table)
```
    Reads the current (last generated) value from a sequence.
    
    Parameters:
    schema - The target schema (optional)
    table - The name of the target table
    
    Returns:
    The current value, -1 otherwise
    Since:
    
    1.6
  - getSequenceNextValue
```
public abstract int getSequenceNextValue(java.lang.String schema,
                       java.lang.String table)
```
    Reads the next value from a sequence.
    
    Parameters:
    schema - The target schema (optional)
    table - The name of the target table
    
    Returns:
    The next value, -1 otherwise
    Since:
    
    1.6
  - resetSequence
```
public abstract boolean resetSequence(java.lang.String schema,
                    java.lang.String table,
                    int nextval)
```
    Resets an existing sequence for the given target table.
    
    Parameters:
    schema - The target schema (optional)
    table - The name of the target table
    nextval - The next value from sequence
    
    Returns:
    Successful?
    Since:
    
    1.6
  - getIcon
```
public abstract javax.swing.ImageIcon getIcon()
```
    Provides the connector specific icon to represent it by GUI components.
    Variants of the provided image (24|32|48|128) should be made accessible to the GUIUtils.getIconVariant() method.
    
    Returns:
    The connector icon 16 x 16 pixels
    Since:
    
    1.6
  - replaceParams
```
public java.lang.String replaceParams(java.lang.String rawtext)
```
    Replace placeholder variables with the current parameters settings of this connector.
    Placeholders needs to be the official parameter names surrounded by the & character like %PARAM_DB_NAME%.
    
    Parameters:
    rawtext - The text with placeholders
    
    Returns:
    The result string, replaced with '' if parameter was not available
    Since:
    
    1.6
  - getSerializedField
```
public java.lang.String[] getSerializedField(java.sql.ResultSet rs,
                                    java.lang.String colname)
```
    Provides the serialized representation of a given database field value.
    The result set must be open and updatable and the column must exist. Remember that only the JDBC types supported by the JDBCConfiguration class may be used here.
    
    Parameters:
    rs - The result set to get the native value
    colname - The column name to process
    
    Returns:
    Index 0 is the serialized value, index 1 = Java type in FQN, null indicates error
    
    Throws:
    
    java.lang.IllegalArgumentException - If a parameter is invalid
    Since:
    
    1.6
  - updateSerializedField
```
public boolean updateSerializedField(java.sql.ResultSet rs,
                            java.lang.String colname,
                            java.lang.String value)
```
    Updates a database field based on the given serialized value and column type.
    The result set must be open and updatable and the column must exist. Remember that only the JDBC types supported by the JDBCConfiguration class may be used here.
    
    Parameters:
    rs - The result set to update the field
    colname - The column name to update
    value - The serialized field value
    
    Returns:
    Successful?
    
    Throws:
    
    java.lang.IllegalArgumentException - If a parameter is invalid
    Since:
    
    1.6
  - mapToJavaType
```
public java.lang.Class mapToJavaType(int metadatatype)
```
    Provides the appropriate Java type to serialize native database types.
    Here, the allowed data type conversions of a database system is implemented so that table data may be transferred from one system to another. Remember that only the JDBC types supported by the JDBCConfiguration class may be used here.
    
    Parameters:
    metadatatype - The original JDBC type to be mapped
    
    Returns:
    The Java class type that fits, null if not supported
    Since:
    
    1.6
  - isBinary
```
public boolean isBinary(int metadatatype)
```
    Checks if the given JDBC type is binary to serialize native database types properly.
    
    Parameters:
    metadatatype - The original JDBC type to be mapped
    
    Returns:
    Binary type?
    Since:
    
    1.6
  - getTypeTable
```
public java.lang.String getTypeTable()
```
    Provides the database specific type for regular tables (often "TABLE").
    This value is needed to get the list of tables within a schema provided by the DatabaseMetaData class. Other tyoes are "VIEW", "SYSTEM_TABLE" etc. Sub-classes must override this method if the database uses a different type identifier.
    
    Returns:
    The type name for regular tables
    Since:
    
    1.6
  - getSchemaSeparator
```
public java.lang.String getSchemaSeparator()
```
    Provides the character sequence needed to separate schema and tables.
    Most database use "." as separator, the DB2 DBMS uses the '/' character as separator.
    
    Returns:
    The separator (default is ".")
    Since:
    
    1.6
  - addSchemaMapping
```
public void addSchemaMapping(java.lang.String defaultschema,
                    java.lang.String usedschema)
```
    Adds a mapping of a default schema and the corresponding used schema.
    Connectors may override the default schema names based on the user desires. Especially for external database like Oracle it is useful not to limit the schema names.
    
    Parameters:
    defaultschema - The default schema name
    usedschema - The used schema name
    
    Throws:
    
    java.lang.NullPointerException - If parameters are null
    Since:
    
    1.6
  - getSchemaMappings
```
public java.util.Hashtable<java.lang.String,java.lang.String> getSchemaMappings()
```
    Provides the internal cache with schema mappings.
    
    Returns:
    The mappings cache
    Since:
    
    1.6
  - getUsedSchema
```
public java.lang.String getUsedSchema(java.lang.String defaultschema)
```
    Provides the used schema name for the given default schema name.
    
    Parameters:
    defaultschema - The default name of the schema
    
    Returns:
    The schema mapping, may be null
    
    Throws:
    
    java.lang.NullPointerException - If parameters are null
    Since:
    
    1.6
  - getDefaultSchema
```
public java.lang.String getDefaultSchema(java.lang.String usedschema)
```
    Provides the default schema name for the given used schema name.
    
    Parameters:
    usedschema - The used name of the schema
    
    Returns:
    The schema mapping, may be null
    
    Throws:
    
    java.lang.NullPointerException - If parameters are null
    Since:
    
    1.6
  - checkAndCreateSchemas
```
public boolean checkAndCreateSchemas()
```
    Makes sure that the required schemas do exist in the target database.
    
    Returns:
    Successful?
    
    Throws:
    
    java.lang.IllegalStateException - If the connector is not connected
    
    java.lang.NullPointerException - If parameters are null
    Since:
    
    1.6
  - updateSchemaTables
```
public void updateSchemaTables(java.lang.String[] schemas)
```
    Updates the cache with tables found in the given schemas.
    
    Parameters:
    schemas - The schema list
    
    Throws:
    
    java.lang.NullPointerException - If parameters are null
    Since:
    
    1.6
  - getSchema
```
public java.lang.String getSchema(java.lang.String table)
```
    Provides the schema of the given table.
    
    Parameters:
    table - The table
    
    Returns:
    The schema, may be null
    
    Throws:
    
    java.lang.NullPointerException - If parameters are null
    Since:
    
    1.6
  - getTableFQN
```
public java.lang.String getTableFQN(java.lang.String table)
```
    Convenience method to get the fully qualified table name including schema.
    
    Parameters:
    table - The table
    
    Returns:
    The table in FQN, may be null
    
    Throws:
    
    java.lang.NullPointerException - If parameters are null
    Since:
    
    1.6
  - replaceTableFQN
```
public java.lang.String replaceTableFQN(java.lang.String text,
                               java.lang.String table)
```
    Convenience method to replace table variables like %AGREEMENT% by table FQN (including schema).
    
    Parameters:
    text - The SQL query etc.
    table - The table
    
    Returns:
    The table in FQN, may be null
    
    Throws:
    
    java.lang.NullPointerException - If parameters are null
    Since:
    
    1.6
  - updateBytes
```
public void updateBytes(java.sql.ResultSet rs,
               java.lang.String columnLabel,
               byte[] x)
                 throws java.sql.SQLException
```
    Updates the designated column with a binary value.
    This method must be used to be able to deal with BLOB implementations provided by the various database systems. For PostgreSQL the updateBlob(String,InputStream) method does not work, but updateBytes(String,byte[]) does.
    By default the updateBlob(String,InputStream) method is called here.
    
    Parameters:
    rs - The result set to be updated
    columnLabel - The label for the column specified with the SQL AS clause
    x - The new column value
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.sql.SQLException - If an SQL error occurs
    Since:
    
    1.6
  - updateBytes
```
public void updateBytes(java.sql.ResultSet rs,
               int columnIndex,
               byte[] x)
                 throws java.sql.SQLException
```
    Updates the designated column with a binary value.
    This method must be used to be able to deal with BLOB implementations provided by the various database systems. For PostgreSQL the updateBlob(int,InputStream) method does not work, but updateBytes(int,byte[]) does.
    By default the updateBlob(int,InputStream) method is called here.
    
    Parameters:
    rs - The result set to be updated
    columnIndex - The index of the column specified with the SQL AS clause (1-based)
    x - The new column value
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.sql.SQLException - If an SQL error occurs
    Since:
    
    1.6
  - updateBytes
```
public void updateBytes(java.sql.ResultSet rs,
               java.lang.String columnLabel,
               java.io.InputStream inputStream)
                 throws java.sql.SQLException
```
    Updates the designated column with a binary value.
    This method must be used to be able to deal with BLOB implementations provided by the various database systems. For PostgreSQL the updateBlob(String,InputStream) method does not work, but updateBytes(String,byte[]) does.
    By default the updateBlob(String,InputStream) method is called here.
    
    Parameters:
    rs - The result set to be updated
    columnLabel - The label for the column specified with the SQL AS clause
    inputStream - The new column value
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.sql.SQLException - If an SQL error occurs
    Since:
    
    1.6
  - updateBytes
```
public void updateBytes(java.sql.ResultSet rs,
               int columnIndex,
               java.io.InputStream inputStream)
                 throws java.sql.SQLException
```
    Updates the designated column with a binary value.
    This method must be used to be able to deal with BLOB implementations provided by the various database systems. For PostgreSQL the updateBlob(int,InputStream) method does not work, but updateBytes(int,byte[]) does.
    By default the updateBlob(int,InputStream) method is called here.
    
    Parameters:
    rs - The result set to be updated
    columnIndex - The index of the column specified with the SQL AS clause (1-based)
    inputStream - The new column value
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.sql.SQLException - If an SQL error occurs
    Since:
    
    1.6
  - getBytes
```
public byte[] getBytes(java.sql.ResultSet rs,
              java.lang.String columnLabel)
                throws java.sql.SQLException
```
    Provides the binary value from the certain column.
    This method must be used to be able to deal with BLOB implementations provided by the various database systems. For PostgreSQL the updateBlob(String,InputStream) method does not work, but updateBytes(String,byte[]) does.
    By default the getBlob(String) method is called here.
    
    Parameters:
    rs - The result set to be updated
    columnLabel - The label for the column specified with the SQL AS clause
    
    Returns:
    The binary data, null indicates error
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.sql.SQLException - If an SQL error occurs
    Since:
    
    1.6
  - getBytes
```
public byte[] getBytes(java.sql.ResultSet rs,
              int columnIndex)
                throws java.sql.SQLException
```
    Provides the binary value from the certain column.
    This method must be used to be able to deal with BLOB implementations provided by the various database systems. For PostgreSQL the updateBlob(String,InputStream) method does not work, but updateBytes(String,byte[]) does.
    By default the getBlob(String) method is called here.
    
    Parameters:
    rs - The result set to be updated
    columnIndex - The index of the column specified with the SQL AS clause (1-based)
    
    Returns:
    The binary data, null indicates error
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.sql.SQLException - If an SQL error occurs
    Since:
    
    1.6
  - getBytes
```
public java.io.InputStream getBytes(java.lang.String columnLabel,
                           java.sql.ResultSet rs)
                             throws java.sql.SQLException
```
    Provides the binary value from the certain column.
    This method must be used to be able to deal with BLOB implementations provided by the various database systems. For PostgreSQL the updateBlob(String,InputStream) method does not work, but updateBytes(String,byte[]) does.
    By default the getBlob(String) method is called here.
    
    Parameters:
    columnLabel - The label for the column specified with the SQL AS clause
    rs - The result set to be updated
    
    Returns:
    The binary data stream, null indicates error
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.sql.SQLException - If an SQL error occurs
    Since:
    
    1.6
  - getBytes
```
public java.io.InputStream getBytes(int columnIndex,
                           java.sql.ResultSet rs)
                             throws java.sql.SQLException
```
    Provides the binary value from the certain column.
    This method must be used to be able to deal with BLOB implementations provided by the various database systems. For PostgreSQL the updateBlob(String,InputStream) method does not work, but updateBytes(String,byte[]) does.
    By default the getBlob(String) method is called here.
    
    Parameters:
    columnIndex - The index of the column specified with the SQL AS clause (1-based)
    rs - The result set to be updated
    
    Returns:
    The binary data, null indicates error
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.sql.SQLException - If an SQL error occurs
    Since:
    
    1.6
  - isEmbedded
```
public boolean isEmbedded()
```
    Is this connector designed for an embedded database like Java DB?
    
    Returns:
    Embedded database?
    Since:
    
    1.6

Class DatabaseConnector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONNECT_SUCCESS

CONNECT_FAILED

CONNECT_AUTH_REQUIRED

databaseName

databaseDescription

driverName

driverDisplayName

driverProductName

driverProductVersion

dbManager

params

defaultConn

defaultConnURL

pool

typeConfig

schemaMappings

cacheSchemaByTable

Constructor Detail

DatabaseConnector

DatabaseConnector

Method Detail

finalize

getParams

setParams

getDatabaseName

getDatabaseDescription

getDriverName

getDriverDisplayName

getDriver

isAvailable

connect

disconnect

isConnected

getDefaultConnection

getDefaultConnectionURL

getNewConnection

getDisplayURL

createSubTree

getPooledConnection

releasePooledConnection

getConnectionPool

getUserName

getUserPassword

getDatabaseManager

getDatabaseProductName

getDatabaseProductVersion

getParamDatabaseName

getParamDatabaseHost

getParamDatabasePort

checkSequenceExists

createSequence

getSequenceCurrentValue

getSequenceNextValue

resetSequence

getIcon

replaceParams

getSerializedField

updateSerializedField

mapToJavaType

isBinary

getTypeTable

getSchemaSeparator

addSchemaMapping

getSchemaMappings

getUsedSchema

getDefaultSchema

checkAndCreateSchemas

updateSchemaTables

getSchema

getTableFQN

replaceTableFQN

updateBytes

updateBytes

updateBytes