|
SSJ V. 2.6. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object umontreal.iro.lecuyer.util.JDBCManager
public class JDBCManager
This class provides some facilities to connect to a SQL database and to
retrieve data stored in it.
JDBC provides a standardized interface for accessing a database
independently of a specific database management system (DBMS).
The user of JDBC must create a Connection
object
used to send SQL queries to the underlying DBMS, but
the creation of the connection adds a DBMS-specific portion
in the application.
This class helps the developer in moving the DBMS-specific
information out of the source code by storing it in
a properties file. The methods in this class can
read such a properties file and establish the JDBC connection.
The connection can be made by using a DataSource
obtained
through a JNDI server, or by a JDBC URI associated with a
driver class.
Therefore, the properties used to connect to the
database must be a JNDI name (jdbc.jndi-name),
or a driver to load
(jdbc.driver) with the URI of a database (jdbc.uri).
The connection is established using the
connectToDatabase
method. Shortcut methods are also available to read the
properties from a file or a resource before establishing the connection.
This class also provides shortcut methods to read data from a database
and to copy the data into Java arrays.
Constructor Summary | |
---|---|
JDBCManager()
|
Method Summary | |
---|---|
static Connection |
connectToDatabase(File file)
Equivalent to connectToDatabase (new FileInputStream (file)). |
static Connection |
connectToDatabase(InputStream is)
Returns a connection to the database using the properties read from stream is. |
static Connection |
connectToDatabase(Properties prop)
Connects to the database using the properties prop and returns the an object representing the connection. |
static Connection |
connectToDatabase(String fileName)
Equivalent to connectToDatabase (new FileInputStream (fileName)). |
static Connection |
connectToDatabase(URL url)
Equivalent to connectToDatabase (url.openStream()). |
static Connection |
connectToDatabaseFromResource(String resource)
Uses connectToDatabase with the stream obtained from
the resource resource. |
static double[] |
readDoubleData(Connection connection,
String query)
Copies the result of the SQL query query into an array of double-precision values. |
static double[] |
readDoubleData(Connection connection,
String table,
String column)
Returns the values of the column column of the table table. |
static double[] |
readDoubleData(Statement stmt,
String query)
Copies the result of the SQL query query into an array of double-precision values. |
static double[] |
readDoubleData(Statement stmt,
String table,
String column)
Returns the values of the column column of the table table. |
static double[][] |
readDoubleData2D(Connection connection,
String query)
Copies the result of the SQL query query into a rectangular 2D array of double-precision values. |
static double[][] |
readDoubleData2D(Statement stmt,
String query)
Copies the result of the SQL query query into a rectangular 2D array of double-precision values. |
static double[][] |
readDoubleData2DTable(Connection connection,
String table)
Returns the values of the columns of the table table. |
static double[][] |
readDoubleData2DTable(Statement stmt,
String table)
Returns the values of the columns of the table table. |
static int[] |
readIntData(Connection connection,
String query)
Copies the result of the SQL query query into an array of integers. |
static int[] |
readIntData(Connection connection,
String table,
String column)
Returns the values of the column column of the table table. |
static int[] |
readIntData(Statement stmt,
String query)
Copies the result of the SQL query query into an array of integers. |
static int[] |
readIntData(Statement stmt,
String table,
String column)
Returns the values of the column column of the table table. |
static int[][] |
readIntData2D(Connection connection,
String query)
Copies the result of the SQL query query into a rectangular 2D array of integers. |
static int[][] |
readIntData2D(Statement stmt,
String query)
Copies the result of the SQL query query into a rectangular 2D array of integers. |
static int[][] |
readIntData2DTable(Connection connection,
String table)
Returns the values of the columns of the table table. |
static int[][] |
readIntData2DTable(Statement stmt,
String table)
Returns the values of the columns of the table table. |
static Object[] |
readObjectData(Connection connection,
String query)
Copies the result of the SQL query query into an array of objects. |
static Object[] |
readObjectData(Connection connection,
String table,
String column)
Returns the values of the column column of the table table. |
static Object[] |
readObjectData(Statement stmt,
String query)
Copies the result of the SQL query query into an array of objects. |
static Object[] |
readObjectData(Statement stmt,
String table,
String column)
Returns the values of the column column of the table table. |
static Object[][] |
readObjectData2D(Connection connection,
String query)
Copies the result of the SQL query query into a rectangular 2D array of integers. |
static Object[][] |
readObjectData2D(Statement stmt,
String query)
Copies the result of the SQL query query into a rectangular 2D array of objects. |
static Object[][] |
readObjectData2DTable(Connection connection,
String table)
Returns the values of the columns of the table table. |
static Object[][] |
readObjectData2DTable(Statement stmt,
String table)
Returns the values of the columns of the table table. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JDBCManager()
Method Detail |
---|
public static Connection connectToDatabase(Properties prop) throws SQLException
InitialContext
,
uses the context to get a DataSource
object,
and uses the data source to obtain a connection.
This method assumes that JNDI is configured correctly;
see the class InitialContext
for more information about configuring
JNDI.
If no JNDI name is specified, the method looks for a JDBC URI.
If a driver class name is specified along with the URI, the corresponding driver
is loaded and registered with the JDBC DriverManager
.
The driver manager is then used to obtain the connection using the URI.
This method throws
an SQLException
if the connection failed and an
IllegalArgumentException
if the properties do not contain the required values.
prop
- the properties to connect to the database.
SQLException
- if the connection failed.
IllegalArgumentException
- if the properties do not contain the require values.public static Connection connectToDatabase(InputStream is) throws IOException, SQLException
connectToDatabase
to establish the connection.
is
- the stream to read for the properties.
SQLException
- if the connection failed.
IOException
- if the stream can not be read correctly.
IllegalArgumentException
- if the properties do not contain the require values.public static Connection connectToDatabase(URL url) throws IOException, SQLException
connectToDatabase
(url.openStream()).
IOException
SQLException
public static Connection connectToDatabase(File file) throws IOException, SQLException
connectToDatabase
(new FileInputStream (file)).
IOException
SQLException
public static Connection connectToDatabase(String fileName) throws IOException, SQLException
connectToDatabase
(new FileInputStream (fileName)).
IOException
SQLException
public static Connection connectToDatabaseFromResource(String resource) throws IOException, SQLException
connectToDatabase
with the stream obtained from
the resource resource.
This method searches the file resource on the class path, opens
the first resource found, and extracts properties from it.
It then uses connectToDatabase
to establish the connection.
IOException
SQLException
public static double[] readDoubleData(Statement stmt, String query) throws SQLException
SQLException
if the query is not valid.
stmt
- the statement used to make the query.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static double[] readDoubleData(Connection connection, String query) throws SQLException
readDoubleData
, which returns an
array of double-precision values.
connection
- the active connection to the database.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static double[] readDoubleData(Statement stmt, String table, String column) throws SQLException
readDoubleData
(stmt, "SELECT column FROM table").
SQLException
public static double[] readDoubleData(Connection connection, String table, String column) throws SQLException
readDoubleData
(connection, "SELECT column FROM table").
SQLException
public static int[] readIntData(Statement stmt, String query) throws SQLException
SQLException
if the query is not valid.
The given statement stmt must not be set up to
produce forward-only result sets.
stmt
- the statement used to make the query.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static int[] readIntData(Connection connection, String query) throws SQLException
readIntData
, which returns an
array of integers.
connection
- the active connection to the database.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static int[] readIntData(Statement stmt, String table, String column) throws SQLException
readIntData
(stmt, "SELECT column FROM table").
SQLException
public static int[] readIntData(Connection connection, String table, String column) throws SQLException
readIntData
(connection, "SELECT column FROM table").
SQLException
public static Object[] readObjectData(Statement stmt, String query) throws SQLException
SQLException
if the query is not valid.
The given statement stmt must not be set up to
produce forward-only result sets.
stmt
- the statement used to make the query.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static Object[] readObjectData(Connection connection, String query) throws SQLException
readObjectData
, which returns an
array of integers.
connection
- the active connection to the database.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static Object[] readObjectData(Statement stmt, String table, String column) throws SQLException
readObjectData
(stmt, "SELECT column FROM table").
SQLException
public static Object[] readObjectData(Connection connection, String table, String column) throws SQLException
readObjectData
(connection, "SELECT column FROM table").
SQLException
public static double[][] readDoubleData2D(Statement stmt, String query) throws SQLException
SQLException
if the query is not valid.
The given statement stmt must not be set up to
produce forward-only result sets.
stmt
- the statement used to make the query.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static double[][] readDoubleData2D(Connection connection, String query) throws SQLException
readDoubleData2D
, which returns a 2D
array of double-precision values.
connection
- the active connection to the database.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static double[][] readDoubleData2DTable(Statement stmt, String table) throws SQLException
readDoubleData2D
(stmt, "SELECT * FROM table").
SQLException
public static double[][] readDoubleData2DTable(Connection connection, String table) throws SQLException
readDoubleData2D
(connection, "SELECT * FROM table").
SQLException
public static int[][] readIntData2D(Statement stmt, String query) throws SQLException
SQLException
if the query is not valid.
The given statement stmt must not be set up to
produce forward-only result sets.
stmt
- the statement used to make the query.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static int[][] readIntData2D(Connection connection, String query) throws SQLException
readIntData2D
, which returns a 2D
array of integers.
connection
- the active connection to the database.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static int[][] readIntData2DTable(Statement stmt, String table) throws SQLException
readIntData2D
(stmt, "SELECT * FROM table").
SQLException
public static int[][] readIntData2DTable(Connection connection, String table) throws SQLException
readIntData2D
(connection, "SELECT * FROM table").
SQLException
public static Object[][] readObjectData2D(Statement stmt, String query) throws SQLException
SQLException
if the query is not valid.
The given statement stmt must not be set up to
produce forward-only result sets.
stmt
- the statement used to make the query.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static Object[][] readObjectData2D(Connection connection, String query) throws SQLException
readObjectData2D
, which returns a 2D
array of integers.
connection
- the active connection to the database.query
- the SQL query to execute.
SQLException
- if the query is not valid.public static Object[][] readObjectData2DTable(Statement stmt, String table) throws SQLException
readObjectData2D
(stmt, "SELECT * FROM table").
SQLException
public static Object[][] readObjectData2DTable(Connection connection, String table) throws SQLException
readObjectData2D
(connection, "SELECT * FROM table").
SQLException
|
SSJ V. 2.6. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |