File Doc Category Size Date Package
Driver.java API Doc Android 1.5 API 5276 Wed May 06 22:41:06 BST 2009 java.sql

Driver

public interface Driver

An interface to a JDBC driver.

The JDBC driver uses URLs to specify the location of specific data. URL format typically takes the form " {@code xxxx:yyyy:SpecificData}", where " {@code xxxx:yyyy}" is referred to as the subprotocol and is normally the same for all of a particular driver. " {@code SpecificData}" is a string which identifies the particular data source that the driver should use.

A driver needs to be registered with a {@link DriverManager}. It is registered and instantiated by calling {@code Class.forName("DriverURL")} with the URL string as argument.

see: DriverManager
since: Android 1.0

Fields Summary
Constructors Summary
Methods Summary
public boolean acceptsURL(java.lang.String url)
Returns whether the driver thinks that it can open a connection to the given URL.
param
url the URL to connect to.
return
{@code true} if the driver thinks that is can open a connection to the supplied URL, {@code false} otherwise. Typically, the driver will respond {@code true} if it thinks that it can handle the subprotocol specified by the driver.
throws
SQLException if a database error occurs.
since
Android 1.0
public java.sql.Connection connect(java.lang.String url, java.util.Properties info)
Attempts to make a database connection to a data source specified by a supplied URL.
param
url the URL to connect.
param
info some properties that should be used in establishing the connection. The properties consist of name/value pairs of strings. Normally, a connection to a database requires at least two properties - for {@code "user"} and {@code "password"} in order to pass authentication to the database.
return
the connection to the database.
throws
SQLException if a database error occurs.
since
Android 1.0
public int getMajorVersion()
Gets the driver's major version number.
return
the major version number of the driver - typically starts at 1.
since
Android 1.0
public int getMinorVersion()
Gets the driver's minor version number.
return
the minor version number of the driver - typically starts at 0.
since
Android 1.0
public java.sql.DriverPropertyInfo[] getPropertyInfo(java.lang.String url, java.util.Properties info)
Gets information about possible properties for this driver.
This method is intended to provide a listing of possible properties that the client of the driver must supply in order to establish a connection to a database. Note that the returned array of properties may change depending on the supplied list of property values.
param
url the URL of the database. An application may call this method iteratively as the property list is built up - for example, when displaying a dialog to an end-user as part of the database login process.
param
info a set of tag/value pairs giving data that a user may be prompted to provide in order to connect to the database.
return
an array of {@code DriverPropertyInfo} records which provide details on which additional properties are required (in addition to those supplied in the {@code info} parameter) in order to connect to the database.
throws
SQLException if a database error occurs.
since
Android 1.0
public boolean jdbcCompliant()
Reports whether this driver is a genuine JDBC CompliantTM driver. The driver may only return {@code true} if it passes all the JDBC compliance tests.
A driver may not be fully compliant if the underlying database has limited functionality.
return
{@code true} if the driver is fully JDBC compliant, {@code false} otherwise.
since
Android 1.0