Copyright 2009,2010, Lapetus Systems Ltd. (All rights reserved)

com.lapetus_ltd.api.db.control
Class TLptsConnection

java.lang.Object
  extended by com.lapetus_ltd._2009.xml.types.XLptsDBConnectionType
      extended by com.lapetus_ltd.api.db.control.TLptsConnection
All Implemented Interfaces:
java.sql.Connection, java.sql.Wrapper

public class TLptsConnection
extends XLptsDBConnectionType
implements java.sql.Connection

Class Description : This is the connection class that implements the java.sql.Connection interface.


This class extends the XML data class XLptsDBConnectionType, which stores all connection information for transmission or file storage.
TLptsConnection is never instantiated by the application, but is generated by TLptsFactoryConnection.initiateConnection(com.lapetus_ltd._2009.xml.types.XLptsDBConnectionType) after supplying an object of type
XLptsDBConnectionType, with all the necessary information for a connection. This includes the driver information from TLptsDriverLoader.
Ok, that is understood, but how exactly is this done? Well, apart from the code examples in the functions below, please look at the
ExampleConnectionUsage and ExampleConnectionDialogUsage for exact details on how to perform a connection and process database information.
There is also more advanced code available in the TestDatabase and TestDatabaseAdvancedXxx files.

As mentioned earlier this class is not instantiated, it is generated with every new connection. This object can therefore be retrieved throught the listener ILptsFactoryConnectionListener.newConnectionCreated(com.lapetus_ltd.api.db.control.TLptsConnection).
Once this object is retrieved, it can be used to get information about all tables and columns in the database that was just connected.
This is exactly what TLptsStatement does when it is instantiated with this connection as a parameter.
As seen in the examples and tests, the connection, together with XLptsDBStatementType, are used to generate a new statement with TLptsFactoryStatement.createNewStatement(com.lapetus_ltd.api.db.control.TLptsConnection, com.lapetus_ltd._2009.xml.types.XLptsDBStatementType).
The new statement TLptsStatement then provides all the tables and columns to the application so that it may select which ones are required for the SELECT statement.
Once the selections are made (through the functions getColumnItem.. and getTableItem...) the statement will automatically create the SQL string for processing with all its correct database formatting (like quotes).
The SQL string can also be entered manually like in ExampleConnectionUsage.

A word about security: All credentials supplied to XLptsDBConnectionType should be encrypted with the default RSA cipher, as they are decrypted at connection time with the default RSA cipher.
Storage and transportation of the credential is always done as encrypted data. Decryption is performed when required and the decrypted credentials are discarded thereafter.
As an example use something like this : connectionType.setCredentials(TLptsCryptoUtil.defaultEncryptCredentialsRSA("username","password"));

$LastChangedRevision: 1190 $
$LastChangedDate:: 2010-11-17 13:21:35#$


Field Summary
 
Fields inherited from class com.lapetus_ltd._2009.xml.types.XLptsDBConnectionType
charset, connectionString, credentials, dataFileUrl, driverType, holdabilityCode, holdabilityString, id, properties, timestamp, title, version
 
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
 
Constructor Summary
TLptsConnection(java.sql.Connection connection, XLptsDBConnectionType connectionType)
           This constructor is utilised during the connection process by TLptsFactoryConnection.
 
Method Summary
 void clearCachedTablesAndColumns()
          Clear the cached tables and columns.
 void clearWarnings()
          JavaDoc from the Connection Interface: Clears all warnings reported for this Connection object.
 void close()
          JavaDoc from the Connection Interface: Releases this Connection object's database and JDBC resources immediately instead of waiting for them to be automatically released.
 void closeWE()
          This is close() without the exception (WE) for coding convenience.
 void commit()
          JavaDoc from the Connection Interface: Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this Connection object.
 java.sql.Array createArrayOf(java.lang.String typeName, java.lang.Object[] elements)
          JavaDoc from the Connection Interface: Factory method for creating Array objects.
 java.sql.Blob createBlob()
          JavaDoc from the Connection Interface: Constructs an object that implements the Blob interface.
 java.sql.Clob createClob()
          JavaDoc from the Connection Interface: Constructs an object that implements the Clob interface.
 java.sql.NClob createNClob()
          JavaDoc from the Connection Interface: Constructs an object that implements the NClob interface.
 java.sql.SQLXML createSQLXML()
          JavaDoc from the Connection Interface: Constructs an object that implements the SQLXML interface.
 java.sql.Statement createStatement()
          JavaDoc from the Connection Interface: Creates a Statement object for sending SQL statements to the database.
 java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency)
          JavaDoc from the Connection Interface: Creates a Statement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          JavaDoc from the Connection Interface: Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.
 java.sql.Struct createStruct(java.lang.String typeName, java.lang.Object[] attributes)
          JavaDoc from the Connection Interface: Factory method for creating Struct objects.
 boolean equals(java.lang.Object o)
           This checks if one connection is equal to another, mainly used in the pooling process.
 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAllTableNames()
           Gets a map of all tables and their types, from the connected Database.
 boolean getAutoCommit()
          JavaDoc from the Connection Interface: Retrieves the current auto-commit mode for this Connection object.
 java.lang.String getCatalog()
          JavaDoc from the Connection Interface: Retrieves this Connection object's current catalog name.
 java.util.Properties getClientInfo()
          JavaDoc from the Connection Interface: Returns a list containing the name and current value of each client info property supported by the driver.
 java.lang.String getClientInfo(java.lang.String name)
          JavaDoc from the Connection Interface: Returns the value of the client info property specified by name.
 java.util.List<java.lang.String> getColumnNames(java.lang.String tableName)
          Gets the Column names from a given table.
 java.util.List<java.lang.Integer> getColumnTypes(java.lang.String tableName)
          Gets the Column SQL Types for a given table.
 java.sql.DatabaseMetaData getConnectionMetaData()
           Get the DataBase MetaData object.
 int getHoldability()
          JavaDoc from the Connection Interface: Retrieves the current holdability of ResultSet objects created using this Connection object.
 java.sql.DatabaseMetaData getMetaData()
          JavaDoc from the Connection Interface: Retrieves a DatabaseMetaData object that contains metadata about the database to which this Connection object represents a connection.
 int getNumberOfConnectedStatements()
           Gets the Number of Statements for this Connection.
 java.util.List<java.lang.String> getStoredProcedureNames()
           Gets a list of the DataBase Stored Procedure names.
 java.util.List<java.lang.String> getTableListForType(java.lang.String tableType)
          Gets the list of table names from a connection, based on its type.
 int getTransactionIsolation()
          JavaDoc from the Connection Interface: Retrieves this Connection object's current transaction isolation level.
 java.util.Map<java.lang.String,java.lang.Class<?>> getTypeMap()
          JavaDoc from the Connection Interface: Retrieves the Map object associated with this Connection object.
 java.sql.SQLWarning getWarnings()
          JavaDoc from the Connection Interface: Retrieves the first warning reported by calls on this Connection object.
 boolean isClosed()
          JavaDoc from the Connection Interface: Retrieves whether this Connection object has been closed.
 boolean isReadOnly()
          JavaDoc from the Connection Interface: Retrieves whether this Connection object is in read-only mode.
 boolean isValid(int timeout)
          JavaDoc from the Connection Interface: Returns true if the connection has not been closed and is still valid.
 boolean isWrapperFor(java.lang.Class<?> iface)
          JavaDoc from the Connection Interface: Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
 java.lang.String nativeSQL(java.lang.String sql)
          JavaDoc from the Connection Interface: Converts the given SQL statement into the system's native SQL grammar.
 java.sql.CallableStatement prepareCall(java.lang.String sql)
          JavaDoc from the Connection Interface: Creates a CallableStatement object for calling database stored procedures.
 java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency)
          JavaDoc from the Connection Interface: Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          JavaDoc from the Connection Interface: Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql)
          JavaDoc from the Connection Interface: Creates a PreparedStatement object for sending parameterized SQL statements to the database.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int autoGeneratedKeys)
          JavaDoc from the Connection Interface: Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int[] columnIndexes)
          JavaDoc from the Connection Interface: Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency)
          JavaDoc from the Connection Interface: Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          JavaDoc from the Connection Interface: Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, java.lang.String[] columnNames)
          JavaDoc from the Connection Interface: Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
 void releaseSavepoint(java.sql.Savepoint savepoint)
          JavaDoc from the Connection Interface: Removes the specified Savepoint and subsequent Savepoint objects from the current transaction.
 void rollback()
          JavaDoc from the Connection Interface: Undoes all changes made in the current transaction and releases any database locks currently held by this Connection object.
 void rollback(java.sql.Savepoint savepoint)
          JavaDoc from the Connection Interface: Undoes all changes made after the given Savepoint object was set.
 void setAutoCommit(boolean autoCommit)
          JavaDoc from the Connection Interface: Sets this connection's auto-commit mode to the given state.
 void setCatalog(java.lang.String catalog)
          JavaDoc from the Connection Interface: Sets the given catalog name in order to select a subspace of this Connection object's database in which to work.
 void setClientInfo(java.util.Properties properties)
          JavaDoc from the Connection Interface: Sets the value of the connection's client info properties.
 void setClientInfo(java.lang.String name, java.lang.String value)
          JavaDoc from the Connection Interface: Sets the value of the client info property specified by name to the value specified by value.
 void setHoldability(int holdability)
          JavaDoc from the Connection Interface: Changes the default holdability of ResultSet objects created using this Connection object to the given holdability.
 void setReadOnly(boolean readOnly)
          JavaDoc from the Connection Interface: Puts this connection in read-only mode as a hint to the driver to enable database optimizations.
 java.sql.Savepoint setSavepoint()
          JavaDoc from the Connection Interface: Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.
 java.sql.Savepoint setSavepoint(java.lang.String name)
          JavaDoc from the Connection Interface: Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.
 void setTransactionIsolation(int level)
          JavaDoc from the Connection Interface: Attempts to change the transaction isolation level for this Connection object to the one given.
 void setTypeMap(java.util.Map<java.lang.String,java.lang.Class<?>> map)
          JavaDoc from the Connection Interface: Installs the given TypeMap object as the type map for this Connection object.
<T> T
unwrap(java.lang.Class<T> iface)
          JavaDoc from the Connection Interface: Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
 void zsNCS(int ncs)
          Obfuscated, as it is not required by the application.
 
Methods inherited from class com.lapetus_ltd._2009.xml.types.XLptsDBConnectionType
getCharset, getConnectionString, getCredentials, getDataFileUrl, getDriverType, getHoldabilityCode, getHoldabilityString, getId, getProperties, getTimestamp, getTitle, getVersion, setCharset, setConnectionString, setCredentials, setDataFileUrl, setDriverType, setHoldabilityCode, setHoldabilityString, setId, setProperties, setTimestamp, setTitle, setVersion
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TLptsConnection

TLptsConnection(java.sql.Connection connection,
                XLptsDBConnectionType connectionType)

This constructor is utilised during the connection process by TLptsFactoryConnection.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : N/A

Notes :
This constructor is not meant to be used by an application and therefore is generated internally by dbJAPI.
The resulting TLptsConnection can be used by the application and is retrieved from ILptsFactoryConnectionListener.newConnectionCreated(com.lapetus_ltd.api.db.control.TLptsConnection).
The most best usage of this class is achieved when it is passed to TLptsFactoryStatement.createNewStatement(TLptsConnection, com.lapetus_ltd._2009.xml.types.XLptsDBStatementType), which then generates a TLptsStatement.

Example :

 private void connectToDB(String title, String driverClassName, String dbName, String username, String password)
 {
   TLptsDBConnectionType connectionType = new TLptsDBConnectionType();
   connectionType.setTitle(title);
 

XLptsDriverType driverType = TLptsDriverLoader.getDriverTypeByClassName(driverClassName);

if (driverType==null) { System.out.println("Could not find driver for class : " + driverClassName); return; }

TLptsDriverType dt = new TLptsDriverType(driverType);

// changing values that are default in the driver.loader.xml file. // the DB is now set correctly and will filter through to the Datasource interface execution if(dbName!=null) dt.setValueForInterfaceFunctionParameter("setDatabaseName","Database Name",dbName); connectionType.setDriverType(dt);

if(username==null || password==null) connectionType.setCredentials(TLptsCryptoUtil.defaultEncryptCredentialsRSA(driverType.getGuestUser(),driverType.getGuestPassword())); else connectionType.setCredentials(TLptsCryptoUtil.defaultEncryptCredentialsRSA(username,password));

TLptsFactoryConnection.initiateConnection(connectionType) // The TLptsConnection object will come through the listener ILptsFactoryConnectionListener.newConnectionCreated(TLptsConnection). }

Parameters:
connection - the new Connection
connectionType - Parameter for connection
Method Detail

clearCachedTablesAndColumns

public void clearCachedTablesAndColumns()
Clear the cached tables and columns.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL :

Notes : All tables and columns are cashed after the connection.
When new tables and columns are added then this needs to be called before another statement is created.

Example :

 

private class StatementListener implements ILptsFactoryStatementListener { public void newStatementProcessStarted(TLptsConnection connection) { } public void newStatementCreated(TLptsConnection connection, TLptsStatement statement) { if (statement.getTypeOfStatement() == XLptsDBTypeOfStatementType.CREATE) { TLptsFactoryStatement.executeOtherStatement(statement); // New Table created connection.clearCachedTablesAndColumns(); // now we can perform operations on the new TABLE createInsertStatementForNewTable(); } } public void newStatementFailed(TLptsConnection connection) { } public void removedAndClosedStatement(TLptsConnection connection, TLptsStatement statement) { } }


clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException
JavaDoc from the Connection Interface: Clears all warnings reported for this Connection object. After a call to this method, the method getWarnings returns null until a new warning is reported for this Connection object.

Specified by:
clearWarnings in interface java.sql.Connection
Throws:
java.sql.SQLException - SQLException if a database access error occurs or this method is called on a closed connection

close

public void close()
           throws java.sql.SQLException
JavaDoc from the Connection Interface: Releases this Connection object's database and JDBC resources immediately instead of waiting for them to be automatically released.

Calling the method close on a Connection object that is already closed is a no-op.

It is strongly recommended that an application explicitly commits or rolls back an active transaction prior to calling the close method. If the close method is called and there is an active transaction, the results are implementation-defined.

Note: This will only close if there are no open statements attached to this connection. Statements can be removed forcefully, and this connection can be closed, using TLptsFactoryConnection.removeConnection(cnx, true); // true means forcefully close associated statements.

Specified by:
close in interface java.sql.Connection
Throws:
java.sql.SQLException - SQLException if a database access error occurs

closeWE

public void closeWE()
This is close() without the exception (WE) for coding convenience. Any exception thrown by close() is caught and logged in the logger.

JavaDoc from the Connection Interface: releases this Connection object's database and JDBC resources immediately instead of waiting for them to be automatically released.

Calling the method close on a Connection object that is already closed is a no-op.

It is strongly recommended that an application explicitly commits or rolls back an active transaction prior to calling the close method. If the close method is called and there is an active transaction, the results are implementation-defined.

Note: This will only close if there are no open statements attached to this connection. Statements can be removed forcefully, and this connection can be closed, using TLptsFactoryConnection.removeConnection(cnx, true); // true means forcefully close associated statements.

Throws:
java.sql.SQLException - SQLException if a database access error occurs

commit

public void commit()
            throws java.sql.SQLException
JavaDoc from the Connection Interface: Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this Connection object. This method should be used only when auto-commit mode has been disabled.

Specified by:
commit in interface java.sql.Connection
Throws:
java.sql.SQLException - if a database access error occurs, this method is called while participating in a distributed transaction, if this method is called on a closed conection or this Connection object is in auto-commit mode
See Also:
setAutoCommit(boolean)

createArrayOf

public java.sql.Array createArrayOf(java.lang.String typeName,
                                    java.lang.Object[] elements)
                             throws java.sql.SQLException
JavaDoc from the Connection Interface: Factory method for creating Array objects.

Note: When createArrayOf is used to create an array object that maps to a primitive data type, then it is implementation-defined whether the Array object is an array of that primitive data type or an array of Object.

Note: The JDBC driver is responsible for mapping the elements Object array to the default JDBC SQL type defined in java.sql.types for the given class of Object. The default mapping is specified in Appendix B of the JDBC specification. If the resulting JDBC type is not the appropriate type for the given typeName then it is implementation defined whether an SQLException is thrown or the driver supports the resulting conversion.

Specified by:
createArrayOf in interface java.sql.Connection
Parameters:
typeName - the SQL name of the type the elements of the array map to. The typeName is a database-specific name which may be the name of a built-in type, a user-defined type or a standard SQL type supported by this database. This is the value returned by Array.getBaseTypeName
elements - the elements that populate the returned object
Returns:
an Array object whose elements map to the specified SQL type
Throws:
java.sql.SQLException - if a database error occurs, the JDBC type is not appropriate for the typeName and the conversion is not supported, the typeName is null or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createBlob

public java.sql.Blob createBlob()
                         throws java.sql.SQLException
JavaDoc from the Connection Interface: Constructs an object that implements the Blob interface. The object returned initially contains no data. The setBinaryStream and setBytes methods of the Blob interface may be used to add data to the Blob.

Specified by:
createBlob in interface java.sql.Connection
Returns:
An object that implements the Blob interface
Throws:
java.sql.SQLException - if an object that implements the Blob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createClob

public java.sql.Clob createClob()
                         throws java.sql.SQLException
JavaDoc from the Connection Interface: Constructs an object that implements the Clob interface. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the Clob interface may be used to add data to the Clob.

Specified by:
createClob in interface java.sql.Connection
Returns:
An object that implements the Clob interface
Throws:
java.sql.SQLException - if an object that implements the Clob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createNClob

public java.sql.NClob createNClob()
                           throws java.sql.SQLException
JavaDoc from the Connection Interface: Constructs an object that implements the NClob interface. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the NClob interface may be used to add data to the NClob.

Specified by:
createNClob in interface java.sql.Connection
Returns:
An object that implements the NClob interface
Throws:
java.sql.SQLException - if an object that implements the NClob interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createSQLXML

public java.sql.SQLXML createSQLXML()
                             throws java.sql.SQLException
JavaDoc from the Connection Interface: Constructs an object that implements the SQLXML interface. The object returned initially contains no data. The createXmlStreamWriter object and setString method of the SQLXML interface may be used to add data to the SQLXML object.

Specified by:
createSQLXML in interface java.sql.Connection
Returns:
An object that implements the SQLXML interface
Throws:
java.sql.SQLException - if an object that implements the SQLXML interface can not be constructed, this method is called on a closed connection or a database access error occurs.
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createStatement

public java.sql.Statement createStatement()
                                   throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a Statement object for sending SQL statements to the database. SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it may be more efficient to use a PreparedStatement object.

Result sets created using the returned Statement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
createStatement in interface java.sql.Connection
Returns:
a new default Statement object
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection

createStatement

public java.sql.Statement createStatement(int resultSetType,
                                          int resultSetConcurrency)
                                   throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a Statement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the createNewStatement method above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
createStatement in interface java.sql.Connection
Parameters:
resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Returns:
a new Statement object that will generate ResultSet objects with the given type and concurrency
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type and concurrency
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.
Since:
1.2

createStatement

public java.sql.Statement createStatement(int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability. This method is the same as the createNewStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:
createStatement in interface java.sql.Connection
Parameters:
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new Statement object that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.
Since:
1.4
See Also:
ResultSet

createStruct

public java.sql.Struct createStruct(java.lang.String typeName,
                                    java.lang.Object[] attributes)
                             throws java.sql.SQLException
JavaDoc from the Connection Interface: Factory method for creating Struct objects.

Specified by:
createStruct in interface java.sql.Connection
Parameters:
typeName - the SQL type name of the SQL structured type that this Struct object maps to. The typeName is the name of a user-defined type that has been defined for this database. It is the value returned by Struct.getSQLTypeName.
attributes - the attributes that populate the returned object
Returns:
a Struct object that maps to the given SQL type and is populated with the given attributes
Throws:
java.sql.SQLException - if a database error occurs, the typeName is null or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

equals

public boolean equals(java.lang.Object o)

This checks if one connection is equal to another, mainly used in the pooling process.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : N/A.

Notes :
This checks every aspect of the connection, including the driver interface information, to verify that a
connection is equal to another.

Example :

 

Overrides:
equals in class java.lang.Object
Returns:
Returns true if the objects are equal. False otherwise.

getAllTableNames

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAllTableNames()

Gets a map of all tables and their types, from the connected Database.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never, it returns an empty table in the worst case. Even in the case of an error.

Notes :
This function returns a map with lists of table names per type of table.
The types of tables available are listed in getTableListForType(String).
getTableListForType is easier to use than this function if we know the type of table we want.

If the tables are cached, then the cached tables are returned. To get a fresh list use before this call clearCachedTablesAndColumns().

Example :

 

Map> tablesMap = connection.getAllTableNames(); if(tablesMap!=null) { List tables = tablesMap.get(TLptsFactoryStatement.TABLE_TYPE_USER); if(tables!=null) { for(String table : tables) { List columns = connection.getColumnNames(table); List columnsTypes = connection.getColumnTypes(table); if(column!=null) displayTableColumnsAndTypes(table,columns,columnTypes); } } }


Returns:
a Map containing the types of the tables and the table list of each type.

getAutoCommit

public boolean getAutoCommit()
                      throws java.sql.SQLException
JavaDoc from the Connection Interface: Retrieves the current auto-commit mode for this Connection object.

Specified by:
getAutoCommit in interface java.sql.Connection
Returns:
the current state of this Connection object's auto-commit mode
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
See Also:
setAutoCommit(boolean)

getCatalog

public java.lang.String getCatalog()
                            throws java.sql.SQLException
JavaDoc from the Connection Interface: Retrieves this Connection object's current catalog name.

Specified by:
getCatalog in interface java.sql.Connection
Returns:
the current catalog name or null if there is none
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
See Also:
setCatalog(java.lang.String)

getClientInfo

public java.util.Properties getClientInfo()
                                   throws java.sql.SQLException
JavaDoc from the Connection Interface: Returns a list containing the name and current value of each client info property supported by the driver. The value of a client info property may be null if the property has not been set and does not have a default value.

Specified by:
getClientInfo in interface java.sql.Connection
Returns:
A Properties object that contains the name and current value of each of the client info properties supported by the driver.

Throws:
java.sql.SQLException - if the database server returns an error when fetching the client info values from the database or this method is called on a closed connection

Since:
1.6

getClientInfo

public java.lang.String getClientInfo(java.lang.String name)
                               throws java.sql.SQLException
JavaDoc from the Connection Interface: Returns the value of the client info property specified by name. This method may return null if the specified client info property has not been set and does not have a default value. This method will also return null if the specified client info property name is not supported by the driver.

Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver.

Specified by:
getClientInfo in interface java.sql.Connection
Parameters:
name - The name of the client info property to retrieve

Returns:
The value of the client info property specified

Throws:
java.sql.SQLException - if the database server returns an error when fetching the client info value from the database or this method is called on a closed connection

Since:
1.6

See Also:
DatabaseMetaData.getClientInfoProperties()

getColumnNames

public java.util.List<java.lang.String> getColumnNames(java.lang.String tableName)
Gets the Column names from a given table.

Thread Safe : Yes.

Spawns its own Thread : No.

May Return NULL : Never, an empty list in the worst case.

Notes : On some databases, the table name is case sensitive (like Oracle, which required all uppercase).

Example :

 

Map> tablesMap = connection.getAllTableNames();

List tables = tablesMap.get(TLptsFactoryStatement.TABLE_TYPE_USER); if(tables!=null) { for(String table : tables) { List columns = connection.getColumnNames(table); List columnsTypes = connection.getColumnTypes(table); if(column!=null) displayTableColumnsAndTypes(table,columns,columnTypes); } }

Parameters:
tableName - The name of the table to get the columns for.
Returns:
A list of column names.

getColumnTypes

public java.util.List<java.lang.Integer> getColumnTypes(java.lang.String tableName)
Gets the Column SQL Types for a given table.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never, an empty list in the worst case.

Notes : On some databases, the table name is case sensitive (like Oracle, which required all uppercase).

Example :

 

List tables = getTableListForType(TLptsFactoryStatement.TABLE_TYPE_USER); for(String table : tables) { List columns = connection.getColumnNames(table); List columnsTypes = connection.getColumnTypes(table); if(column!=null) displayTableColumnsAndTypes(table,columns,columnTypes); }

Parameters:
tableName - The name of the table to get the column types for.
Returns:
A list of integer SQL types.

getConnectionMetaData

public java.sql.DatabaseMetaData getConnectionMetaData()

Get the DataBase MetaData object.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Yes

Notes :
This is utilised internally to get all the table, column and stored procedure information from a connection.
The example below shows how to get the table information as a rowset. TLptsConnection has other more convenient functions for this purpose.
Functions like getAllTableNames(),getColumnNames(String) and getStoredProcedureNames().

Example :

 //To get Meta Data info ex: tables,procedures etc.
 ResultSet rs = getConnectionMetaData().getTables(null, null, null, null);
 

Returns:
database metadata

getHoldability

public int getHoldability()
                   throws java.sql.SQLException
JavaDoc from the Connection Interface: Retrieves the current holdability of ResultSet objects created using this Connection object.

Specified by:
getHoldability in interface java.sql.Connection
Returns:
the holdability, one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
Since:
1.4
See Also:
setHoldability(int), DatabaseMetaData.getResultSetHoldability(), ResultSet

getMetaData

public java.sql.DatabaseMetaData getMetaData()
                                      throws java.sql.SQLException
JavaDoc from the Connection Interface: Retrieves a DatabaseMetaData object that contains metadata about the database to which this Connection object represents a connection. The metadata includes information about the database's tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on.

Specified by:
getMetaData in interface java.sql.Connection
Returns:
a DatabaseMetaData object for this Connection object
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection

getNumberOfConnectedStatements

public int getNumberOfConnectedStatements()

Gets the Number of Statements for this Connection.

Thread Safe : Yes.

Spawns its own Thread : No.

May Return NULL : No, zero in worst case.

Notes :

Example :

 System.out.println(connection.getNumberOfConnectedStatements());
 Result: 0
 

TLptsStatement updateStatement = new TLptsStatement(connection,XLptsDBTypeOfStatementType.UPDATE); ... TLptsFactoryStatement.createNewStatement(connection, updateStatement); ... after we receive the statement created from the statement factory listener. System.out.println(connection.getNumberOfConnectedStatements()); Result: 1

Returns:
the number of statements for this connection

getStoredProcedureNames

public java.util.List<java.lang.String> getStoredProcedureNames()

Gets a list of the DataBase Stored Procedure names.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never, an empty list in the worst case.

Notes :

Example :

 //execute all stored procedures
 List storedProcedures;
 for(String proc : connection.getStoredProcedureNames()_
    storedProcedures.add("{CALL " + proc + "}");
 ...
 for(String sp : storedProcedures)
 {
  CallableStatement cs = connection.prepareCall(sp, ResultSet.TYPE_FORWARD_ONLY,ResultSet.CONCUR_UPDATABLE,ResultSet.CLOSE_CURSORS_AT_COMMIT);
  ResultSet rs = cs.executeQuery();
  processResultSet(rs);
 }
 

Returns:
The list of procedure names for this connection (database).

getTableListForType

public java.util.List<java.lang.String> getTableListForType(java.lang.String tableType)
Gets the list of table names from a connection, based on its type.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never, an empty list in the worst case.

Notes :
In an Excel workbook, the user tables (actually worksheets) are stored under system (TLptsFactoryConnection.TABLE_TYPE_SYSTEM_TABLES).
If the tables are cached, then the cached tables are returned. To get a fresh list use before this call clearCachedTablesAndColumns().

Example :

 List tables = tablesMap.connection.getTableListForType(TLptsFactoryConnection.TABLE_TYPE_TABLES);  // user table type.
 if(tables!=null)
 {
   for(String table : tables)
   {
     List columns = connection.getColumnNames(table);
     List columnsTypes = connection.getColumnTypes(table);
     if(column!=null)
       displayTableColumnsAndTypes(table,columns,columnTypes);
   }
 }
 

Parameters:
tableType - Valid types are as follows: TLptsFactoryConnection.TABLE_TYPE_TABLES TLptsFactoryConnection.TABLE_TYPE_VIEW TLptsFactoryConnection.TABLE_TYPE_SYSTEM_TABLES TLptsFactoryConnection.TABLE_TYPE_GLOBAL_TEMP TLptsFactoryConnection.TABLE_TYPE_LOCAL_TEMP TLptsFactoryConnection.TABLE_TYPE_ALIAS TLptsFactoryConnection.TABLE_TYPE_SYNONYM
Returns:
return a list that contains the names of the tables for the type specified. The list may be empty.

getTransactionIsolation

public int getTransactionIsolation()
                            throws java.sql.SQLException
JavaDoc from the Connection Interface: Retrieves this Connection object's current transaction isolation level.

Specified by:
getTransactionIsolation in interface java.sql.Connection
Returns:
the current transaction isolation level, which will be one of the following constants: Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, Connection.TRANSACTION_SERIALIZABLE, or Connection.TRANSACTION_NONE.
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
See Also:
setTransactionIsolation(int)

getTypeMap

public java.util.Map<java.lang.String,java.lang.Class<?>> getTypeMap()
                                                              throws java.sql.SQLException
JavaDoc from the Connection Interface: Retrieves the Map object associated with this Connection object. Unless the application has added an entry, the type map returned will be empty.

Specified by:
getTypeMap in interface java.sql.Connection
Returns:
the java.util.Map object associated with this Connection object
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.2
See Also:
setTypeMap(java.util.Map>)

getWarnings

public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException
JavaDoc from the Connection Interface: Retrieves the first warning reported by calls on this Connection object. If there is more than one warning, subsequent warnings will be chained to the first one and can be retrieved by calling the method SQLWarning.getNextWarning on the warning that was retrieved previously.

This method may not be called on a closed connection; doing so will cause an SQLException to be thrown.

Note: Subsequent warnings will be chained to this SQLWarning.

Specified by:
getWarnings in interface java.sql.Connection
Returns:
the first SQLWarning object or null if there are none
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
See Also:
SQLWarning

isClosed

public boolean isClosed()
                 throws java.sql.SQLException
JavaDoc from the Connection Interface: Retrieves whether this Connection object has been closed. A connection is closed if the method close has been called on it or if certain fatal errors have occurred. This method is guaranteed to return true only when it is called after the method Connection.close has been called.

This method generally cannot be called to determine whether a connection to a database is valid or invalid. A typical client can determine that a connection is invalid by catching any exceptions that might be thrown when an operation is attempted.

Specified by:
isClosed in interface java.sql.Connection
Returns:
true if this Connection object is closed; false if it is still open
Throws:
java.sql.SQLException - if a database access error occurs

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException
JavaDoc from the Connection Interface: Retrieves whether this Connection object is in read-only mode.

Specified by:
isReadOnly in interface java.sql.Connection
Returns:
true if this Connection object is read-only; false otherwise
Throws:
java.sql.SQLException - SQLException if a database access error occurs or this method is called on a closed connection

isValid

public boolean isValid(int timeout)
                throws java.sql.SQLException
JavaDoc from the Connection Interface: Returns true if the connection has not been closed and is still valid. The driver shall submit a query on the connection or use some other mechanism that positively verifies the connection is still valid when this method is called.

The query submitted by the driver to validate the connection shall be executed in the context of the current transaction.

Specified by:
isValid in interface java.sql.Connection
Parameters:
timeout - - The time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation.

Returns:
true if the connection is valid, false otherwise
Throws:
java.sql.SQLException - if the value supplied for timeout is less then 0
Since:
1.6

See Also:
DatabaseMetaData.getClientInfoProperties()

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException
JavaDoc from the Connection Interface: Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.

Specified by:
isWrapperFor in interface java.sql.Wrapper
Parameters:
iface - a Class defining an interface.
Returns:
true if this implements the interface or directly or indirectly wraps an object that does.
Throws:
java.sql.SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.
Since:
1.6

nativeSQL

public java.lang.String nativeSQL(java.lang.String sql)
                           throws java.sql.SQLException
JavaDoc from the Connection Interface: Converts the given SQL statement into the system's native SQL grammar. A driver may convert the JDBC SQL grammar into its system's native SQL grammar prior to sending it. This method returns the native form of the statement that the driver would have sent.

Specified by:
nativeSQL in interface java.sql.Connection
Parameters:
sql - an SQL statement that may contain one or more '?' parameter placeholders
Returns:
the native form of this statement
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql)
                                       throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a CallableStatement object for calling database stored procedures. The CallableStatement object provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.

Note: This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the method prepareCall is done; others may wait until the CallableStatement object is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.

Result sets created using the returned CallableStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
sql - an SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is specified using JDBC call escape syntax.
Returns:
a new default CallableStatement object containing the pre-compiled SQL statement
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency)
                                       throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain on or more '?' parameters
resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Returns:
a new CallableStatement object containing the pre-compiled SQL statement that will produce ResultSet objects with the given type and concurrency
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type and concurrency
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.
Since:
1.2

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency,
                                              int resultSetHoldability)
                                       throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type, result set concurrency type and holdability to be overridden.

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain on or more '?' parameters
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new CallableStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.
Since:
1.4
See Also:
ResultSet

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql)
                                            throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a PreparedStatement object for sending parameterized SQL statements to the database.

A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLException objects.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
Returns:
a new default PreparedStatement object containing the pre-compiled SQL statement
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int autoGeneratedKeys)
                                            throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys. The given constant tells the driver whether it should make auto-generated keys available for retrieval. This parameter is ignored if the SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS
Returns:
a new PreparedStatement object, containing the pre-compiled SQL statement, that will have the capability of returning auto-generated keys
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYS
Since:
1.4

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int[] columnIndexes)
                                            throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row or rows
Returns:
a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column indexes
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency)
                                            throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareStatement method above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain one or more '?' IN parameters
resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Returns:
a new PreparedStatement object containing the pre-compiled SQL statement that will produce ResultSet objects with the given type and concurrency
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type and concurrency
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.
Since:
1.2

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency,
                                                   int resultSetHoldability)
                                            throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.

This method is the same as the prepareStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain one or more '?' IN parameters
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new PreparedStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.
Since:
1.4
See Also:
ResultSet

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   java.lang.String[] columnNames)
                                            throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the names of the columns in the target table that contain the auto-generated keys that should be returned. The driver will ignore the array if the SQL statement is not an INSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - an SQL statement that may contain one or more '?' IN parameter placeholders
columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows
Returns:
a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column names
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4

releaseSavepoint

public void releaseSavepoint(java.sql.Savepoint savepoint)
                      throws java.sql.SQLException
JavaDoc from the Connection Interface: Removes the specified Savepoint and subsequent Savepoint objects from the current transaction. Any reference to the savepoint after it have been removed will cause an SQLException to be thrown.

Specified by:
releaseSavepoint in interface java.sql.Connection
Parameters:
savepoint - the Savepoint object to be removed
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given Savepoint object is not a valid savepoint in the current transaction
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4

rollback

public void rollback()
              throws java.sql.SQLException
JavaDoc from the Connection Interface: Undoes all changes made in the current transaction and releases any database locks currently held by this Connection object. This method should be used only when auto-commit mode has been disabled.

Specified by:
rollback in interface java.sql.Connection
Throws:
java.sql.SQLException - if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection or this Connection object is in auto-commit mode
See Also:
setAutoCommit(boolean)

rollback

public void rollback(java.sql.Savepoint savepoint)
              throws java.sql.SQLException
JavaDoc from the Connection Interface: Undoes all changes made after the given Savepoint object was set.

This method should be used only when auto-commit has been disabled.

Specified by:
rollback in interface java.sql.Connection
Parameters:
savepoint - the Savepoint object to roll back to
Throws:
java.sql.SQLException - if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection, the Savepoint object is no longer valid, or this Connection object is currently in auto-commit mode
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4
See Also:
Savepoint, rollback()

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws java.sql.SQLException
JavaDoc from the Connection Interface: Sets this connection's auto-commit mode to the given state. If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback. By default, new connections are in auto-commit mode.

The commit occurs when the statement completes. The time when the statement completes depends on the type of SQL Statement:

NOTE: If this method is called during a transaction and the auto-commit mode is changed, the transaction is committed. If setAutoCommit is called and the auto-commit mode is not changed, the call is a no-op.

Specified by:
setAutoCommit in interface java.sql.Connection
Parameters:
autoCommit - true to enable auto-commit mode; false to disable it
Throws:
java.sql.SQLException - if a database access error occurs, setAutoCommit(true) is called while participating in a distributed transaction, or this method is called on a closed connection
See Also:
getAutoCommit()

setCatalog

public void setCatalog(java.lang.String catalog)
                throws java.sql.SQLException
JavaDoc from the Connection Interface: Sets the given catalog name in order to select a subspace of this Connection object's database in which to work.

If the driver does not support catalogs, it will silently ignore this request.

Specified by:
setCatalog in interface java.sql.Connection
Parameters:
catalog - the name of a catalog (subspace in this Connection object's database) in which to work
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
See Also:
getCatalog()

setClientInfo

public void setClientInfo(java.util.Properties properties)
                   throws java.sql.SQLClientInfoException
JavaDoc from the Connection Interface: Sets the value of the connection's client info properties. The Properties object contains the names and values of the client info properties to be set. The set of client info properties contained in the properties list replaces the current set of client info properties on the connection. If a property that is currently set on the connection is not present in the properties list, that property is cleared. Specifying an empty properties list will clear all of the properties on the connection. See setClientInfo (String, String) for more information.

If an error occurs in setting any of the client info properties, a SQLClientInfoException is thrown. The SQLClientInfoException contains information indicating which client info properties were not set. The state of the client information is unknown because some databases do not allow multiple client info properties to be set atomically. For those databases, one or more properties may have been set before the error occurred.

Specified by:
setClientInfo in interface java.sql.Connection
Parameters:
properties - the list of client info properties to set

Throws:
java.sql.SQLClientInfoException - if the database server returns an error while setting the clientInfo values on the database server or this method is called on a closed connection

Since:
1.6

See Also:
setClientInfo(String, String)

setClientInfo

public void setClientInfo(java.lang.String name,
                          java.lang.String value)
                   throws java.sql.SQLClientInfoException
JavaDoc from the Connection Interface: Sets the value of the client info property specified by name to the value specified by value.

Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver and the maximum length that may be specified for each property.

The driver stores the value specified in a suitable location in the database. For example in a special register, session parameter, or system table column. For efficiency the driver may defer setting the value in the database until the next time a statement is executed or prepared. Other than storing the client information in the appropriate place in the database, these methods shall not alter the behavior of the connection in anyway. The values supplied to these methods are used for accounting, diagnostics and debugging purposes only.

The driver shall generate a warning if the client info name specified is not recognized by the driver.

If the value specified to this method is greater than the maximum length for the property the driver may either truncate the value and generate a warning or generate a SQLClientInfoException. If the driver generates a SQLClientInfoException, the value specified was not set on the connection.

The following are standard client info properties. Drivers are not required to support these properties however if the driver supports a client info property that can be described by one of the standard properties, the standard property name should be used.

Specified by:
setClientInfo in interface java.sql.Connection
Parameters:
name - The name of the client info property to set
value - The value to set the client info property to. If the value is null, the current value of the specified property is cleared.

Throws:
java.sql.SQLClientInfoException - if the database server returns an error while setting the client info value on the database server or this method is called on a closed connection

Since:
1.6

setHoldability

public void setHoldability(int holdability)
                    throws java.sql.SQLException
JavaDoc from the Connection Interface: Changes the default holdability of ResultSet objects created using this Connection object to the given holdability. The default holdability of ResultSet objects can be be determined by invoking DatabaseMetaData.getResultSetHoldability().

Specified by:
setHoldability in interface java.sql.Connection
Parameters:
holdability - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
java.sql.SQLException - if a database access occurs, this method is called on a closed connection, or the given parameter is not a ResultSet constant indicating holdability
java.sql.SQLFeatureNotSupportedException - if the given holdability is not supported
Since:
1.4
See Also:
getHoldability(), DatabaseMetaData.getResultSetHoldability(), ResultSet

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws java.sql.SQLException
JavaDoc from the Connection Interface: Puts this connection in read-only mode as a hint to the driver to enable database optimizations.

Note: This method cannot be called during a transaction.

Specified by:
setReadOnly in interface java.sql.Connection
Parameters:
readOnly - true enables read-only mode; false disables it
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or this method is called during a transaction

setSavepoint

public java.sql.Savepoint setSavepoint()
                                throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.

if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created savepoint.

Specified by:
setSavepoint in interface java.sql.Connection
Returns:
the new Savepoint object
Throws:
java.sql.SQLException - if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection or this Connection object is currently in auto-commit mode
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4
See Also:
Savepoint

setSavepoint

public java.sql.Savepoint setSavepoint(java.lang.String name)
                                throws java.sql.SQLException
JavaDoc from the Connection Interface: Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.

if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created savepoint.

Specified by:
setSavepoint in interface java.sql.Connection
Parameters:
name - a String containing the name of the savepoint
Returns:
the new Savepoint object
Throws:
java.sql.SQLException - if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection or this Connection object is currently in auto-commit mode
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4
See Also:
Savepoint

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws java.sql.SQLException
JavaDoc from the Connection Interface: Attempts to change the transaction isolation level for this Connection object to the one given. The constants defined in the interface Connection are the possible transaction isolation levels.

Note: If this method is called during a transaction, the result is implementation-defined.

Specified by:
setTransactionIsolation in interface java.sql.Connection
Parameters:
level - one of the following Connection constants: Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE. (Note that Connection.TRANSACTION_NONE cannot be used because it specifies that transactions are not supported.)
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameter is not one of the Connection constants
See Also:
DatabaseMetaData.supportsTransactionIsolationLevel(int), getTransactionIsolation()

setTypeMap

public void setTypeMap(java.util.Map<java.lang.String,java.lang.Class<?>> map)
                throws java.sql.SQLException
JavaDoc from the Connection Interface: Installs the given TypeMap object as the type map for this Connection object. The type map will be used for the custom mapping of SQL structured types and distinct types.

Specified by:
setTypeMap in interface java.sql.Connection
Parameters:
map - the java.util.Map object to install as the replacement for this Connection object's default type map
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameter is not a java.util.Map object
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.2
See Also:
getTypeMap()

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
         throws java.sql.SQLException
JavaDoc from the Connection Interface: Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Specified by:
unwrap in interface java.sql.Wrapper
Parameters:
iface - A Class defining an interface that the result must implement.
Returns:
an object that implements the interface. May be a proxy for the actual implementing object.
Throws:
java.sql.SQLException - If no object found that implements the interface
Since:
1.6

zsNCS

public void zsNCS(int ncs)
Obfuscated, as it is not required by the application.



Copyright 2009,2010, Lapetus Systems Ltd. (All rights reserved)