vortex.sql

Class vortexDriver

java.lang.Object

vortex.sql.vortexDriver

All Implemented Interfaces:

java.sql.Driver

public class vortexDriver
extends java.lang.Object
implements java.sql.Driver

The interface that every driver class must implement.

Constructor Summary

Constructors

Constructor and Description
vortexDriver() Constructs a new driver and registers it with java.sql.DriverManager.registerDriver()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptsURL(java.lang.String url) 'jdbc:vortex' is the only URL accepted here
java.sql.Connection	connect(java.lang.String url, java.util.Properties info) Try to make a database connection to the given URL.
int	getMajorVersion() Get the driver's major version number.
int	getMinorVersion() Get the driver's minor version number.
java.util.logging.Logger	getParentLogger() Return the parent Logger of all the Loggers used by this driver.
java.sql.DriverPropertyInfo[]	getPropertyInfo(java.lang.String url, java.util.Properties info) The getPropertyInfo method is intended to allow a generic GUI tool to discover what properties it should prompt a human for in order to get enough information to connect to a database.
boolean	jdbcCompliant() JDBC compliance requires full support for the JDBC API and full support for SQL 92 Entry Level.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

vortexDriver

public vortexDriver()
             throws java.sql.SQLException

Constructs a new driver and registers it with java.sql.DriverManager.registerDriver()

Throws:

java.sql.SQLException - thrown in the event the driver regist fails

Method Detail

connect

public java.sql.Connection connect(java.lang.String url,
                          java.util.Properties info)
                            throws java.sql.SQLException

Try to make a database connection to the given URL. The driver will return "null" if it realizes it is the wrong kind of driver to connect to the given URL.

The driver will raise a SQLException if it is the right driver to connect to the given URL, but has trouble connecting to the database.

The java.util.Properties argument can be used to passed arbitrary string tag/value pairs as connection arguments.

login	for database login such as 'scott/tiger' or 'sa/sa/master'
port	for port number connect to VORTEX server eg. 1958
host	for the host machine name/IP address
service	for the host server program, eg. 'VTX4'
environs	(optional) for the environment variables, eg. 'ORACLE_SID=?', 'INFORMIXDIR=?'
fetch_size	(optional) for query fetch buffer size. default: 8192
max_column	(optional) maximum columns allowed. default: 256
db_cursor	(optional) database cursor allocated. default: 128
logical_cursor	(optional) logical cursor allocated. default: 1024
user	(optional) operating system login user name.
password	(optional) operating system login password name.
connect_timeout	(optional) operating system login password name.
read_timeout	(optional) operating system login password name.
write_timeout	(optional) operating system login password name.

Specified by:

connect in interface java.sql.Driver

Parameters:

url - The URL of the database to connect to

     jdbc:vortex://[database login][embedded props]@[port:][host][!service][,environs]
 

For more details concerning the login string and info parameters, see the Vortex Installation and Operations Manual.

info - a list of string tag/value pairs as connection arguments

Returns:

a Connection to the URL

Throws:

java.sql.SQLException - thrown in the event the connection fails

acceptsURL

public boolean acceptsURL(java.lang.String url)
                   throws java.sql.SQLException

'jdbc:vortex' is the only URL accepted here

Specified by:

acceptsURL in interface java.sql.Driver

Parameters:

url - The URL of the database.

Returns:

True if the given URL contains 'jdbc:vortex'.

Throws:

java.sql.SQLException - Not apply

getPropertyInfo

public java.sql.DriverPropertyInfo[] getPropertyInfo(java.lang.String url,
                                            java.util.Properties info)

The getPropertyInfo method is intended to allow a generic GUI tool to discover what properties it should prompt a human for in order to get enough information to connect to a database. Note that depending on the values the human has supplied so far, additional values may become necessary, so it may be necessary to iterate though several calls to getPropertyInfo.

Specified by:

getPropertyInfo in interface java.sql.Driver

Parameters:

url - The URL of the database to connect to.

info - A proposed list of tag/value pairs that will be sent on connect open.

Returns:

An array of DriverPropertyInfo objects describing possible properties. This array may be an empty array if no properties are required.

Throws:

java.sql.SQLException - Not apply

getMajorVersion

public int getMajorVersion()

Get the driver's major version number.

Specified by:

getMajorVersion in interface java.sql.Driver

getMinorVersion

public int getMinorVersion()

Get the driver's minor version number.

Specified by:

getMinorVersion in interface java.sql.Driver

jdbcCompliant

public boolean jdbcCompliant()

JDBC compliance requires full support for the JDBC API and full support for SQL 92 Entry Level. It is expected that JDBC compliant drivers will be available for all the major commercial databases.

Specified by:

jdbcCompliant in interface java.sql.Driver

Returns:

return true.

getParentLogger

public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException

Return the parent Logger of all the Loggers used by this driver. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this driver. Configuring this Logger will affect all of the log messages generated by the driver. In the worst case, this may be the root Logger.

Specified by:

getParentLogger in interface java.sql.Driver

Returns:

the parent Logger for this driver

Throws:

java.sql.SQLFeatureNotSupportedException - - if the driver does not use java.util.logging.