SQLDataSet (MicroDeveloper 1.7.4 API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

MDi JLib
1.7.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.microdeveloper.data
Class SQLDataSet

java.lang.Object
  com.microdeveloper.data.SQLDataSet

public class SQLDataSet
extends Object
extends Object

The implementation of the SQLSet, a java.sql.ResultSet which is wrapped in a self contained object with connection information, sql basis, sql parameters, and meta information related to a ResultSet.

The functionality of the class allows the class to be treated much like a simple collection with update capability. Updates are not performed on the object itself but rather through DML statements in the SQL property.

The class provides methods for manipulating the results of the Sql in a convienient manner and provides the following capabilities:

The cursor may be positioned within the class and moved forward, backward, or to an absolute position.
Data may be retrieved by direct conversion of the database object type or as a simple java object element.
Data may be iterated over by index position such as row 10 - column 3, or by named reference such as row 10 - column "ADDRESS".
Forward and reverse meta-data methods for retrieval of the column name or position allows for convienient positioning within the result set.
Self contained connection and results may be passed between classes or sessions when used as a bean.
DML statements may be issued for insert, update, and delete functionality.
Parameters may be set dynamically
The connection, resultset, metadata, parameter lists, and conversion utilities are conveniently wrapped in a single object

The parameters for the SQL call are flexible in that they can be as generic as an array of Strings, set individually, or passed in as a batch. Unlike the SQL driver construct for a statement or prepared statement, you do not need to make a particularly named call to set a variable. For example:
JDBC norm:

 Connection conn = DriverManager...
 PreparedStatment ps = conn.prepareStatement (sql);
 ps.setString(1, "My Value");

SQLDataSet:

 Connection conn = DriverManager...
 SQLDataSet ds = new SQLDataSet(conn, sql);
 ds.setParameter(1, java.sql.Types.VARCHAR, "My Value");

To iterate over a SQLDataSet simply use the traditional JDBC methods. For example:

while (ds.next()) {
   System.out.println("Column foo: " + ds.getString("foo"));
   ...
 }

One area of confusion can come from setting primitive types such as int. You can use setInt(int, int), but because setParameter takes an Object as an argument and int must be passed in as an Java object such as Integer by using Integer.valueOf(int). Almost all primary and extended jdbc types are supported but only a limited set are supported by the setParameter call. If you attempt to use a type that is not supported, you will get an UnsupportedSQLType exception. The following types are supported by setParameter:
SQL type (Java type): DATE (Date), INTEGER (Integer), DOUBLE (Double), FLOAT (Float), NUMERIC (Double), TIMESTAMP (Timestamp), VARCHAR (String)

So, if you can use the native parameter call why use setParameter? SetParameter does more than just set the argument in one call, it also examines the contents you pass in and automatically adjusts the value to the appropriate setNull call when the value given is, in fact, null. Because of this, you need not test for null and then programmatically set the appropriate call and SQLType. Mearly make a call to setParameter passing in the value (null or not), and the method will setup the rest.

Note: Arguments are being deprecated and removed from this class in favor of using parameters in the traditional jdbc sense. When passing in arguments in batches, use ArrayList objects to represent the components. You must provide 3 lists: name list, type list, and value list. Each must have the same number of entries and corresponding positioning. Arguments may also be set as an array of Strings which is treated as VARCHAR object types for DML purposes. Finally, it is also possible to simply call setArg(String) for very simple calls where there is only one argument. The type is assumed to be VARCHAR, the value is the String given, and the position is the first (and only) parameter.

Arguments set manually, in batches or through a direct call to query or update, are synchronized with the parameters, however the inverse is not true. If you set the parameters directly through setParameter or setXYZ where XYZ is the type (e.g., setInt), the argument list is not updated. The call to getParameterMetaData will always return the currently established parameter list.

Important: Always close the SQLDataSet when you are done using it. Failure to do so will result in a cursor leak which, if nested, could cause the database to run out of memory of throw internal errors. Closing the connection alone does not always free up cursors, and combined with certain drivers, will not cleanup cursors when used with Connection pooling even if the resultset is explicitly destroyed. Therefore always ensure that the ResultSet is released along with the PreparedStatement by using the close() method which will take care of releasing both immediately.

Since:: 1.1
Version:: 1.6
Author:: MicroDeveloper, Inc.

Constructor Summary
`SQLDataSet()` Initializes a new instance of SQLDataSet.
`SQLDataSet(Connection conn, String sql)` Initializes a new instance of SQLDataSeta and establishes the connection and statement.

Method Summary
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Creates a property change listener
`void`	`afterLast()` Moves the ResultSet cursor after the last record
`void`	`beforeFirst()` Moves the ResultSet cursor before the 1st record
`void`	`clearArgs()` Sets the current arguments and parameters to empty (null)
`void`	`close()` Closes the ResultSet thereby freeing the cursors.
`boolean`	`doCommit()` Performs a commit action within the database connection.
`boolean`	`doRollback()` Performs a rollback action within the database connection.
`boolean`	`doRollback(Savepoint sp)` Performs a rollback action within the database connection.
`ResultSet`	`executeQuery()` Establishes and returns the ResultSet based on the SQL property value and the established parameters using the established Connection property.
`int`	`executeUpdate()` Executes the SQL statement in this SQL property value, which must be an SQL INSERT, UPDATE or DELETE statement; or an SQL statement that returns nothing, such as a DDL statement.
`void`	`finalize()` Cleans out the instance during garbage collection.
`void`	`first()` Moves the cursor position to the first record in the ResultSet.
`ArrayList`	`getArguments(String type)` Deprecated. as of 1.5 may be removed from future versions
`boolean`	`getAutoCommit()` Returns the current state of automatic commit processing.
`boolean`	`getAutoRollback()` Returns the current state of automatic rollback functionality.
`BigDecimal`	`getBigDecimal(String columnName)` Gets a BigDecimal value from the current row based on the name of the column desired.
`Blob`	`getBlob(String columnName)` Gets a Blob (Binary Large Object Block) object from the current row based on the name of the column desired.
`Clob`	`getClob(String columnName)` Gets a Clob (Character Large Object Block) object from the current row based on the name of the column desired.
`int`	`getColumnCount()` Gets the number of columns in the ResultSet
`String`	`getColumnName(int i)` Gets the name of the column as indicated by the position of the column (i) within the ResultSet.
`String[]`	`getColumnNames()` Gets the column names from the current ResultSet and returns them as a string array
`int`	`getColumnPosition(String columnName)` Gets the position of a column in the resultset given the name of the column.
`String`	`getColumnType(int i)` Gets the type of a particular column in the ResultSet by numeric position
`String`	`getColumnType(String columnName)` Gets the database type of column in the selected drivers meta-data notation.
`boolean`	`getCommitting()` Returns the current state of commit processing.
`Connection`	`getConnection()` Gets the connection object for this instantiation.
`String`	`getConnectionURL()` Gets the URL that describes or represents this jdbc connection.
`Connection`	`getConnProperty()` Gets the current database connection object
`int`	`getCurrentRow()` Deprecated. As of release 1.5, replaced by `getRow()` may be removed from future versions
`SQLSet`	`getDataSetInterface()` Establishes the interface to a SQLDataSetInterface.
`Date`	`getDate(String columnName)` Gets a Date value from the current row based on the name of the column desired using the default Calendar.
`Date`	`getDate(String columnName, Calendar cal)` Gets a Date value from the current row based on the name of the column desired using the Calendar specified.
`double`	`getDouble(String columnName)` Gets a Double value from the current row based on the name of the column desired.
`float`	`getFloat(String columnName)` Gets a Float value from the current row based on the name of the column desired.
`int`	`getInt(String columnName)` Gets a Integer value from the current row based on the name of the column desired.
`Object`	`getObject(int i)` Gets the column object specifed by integer position of the column for the current row.
`Object`	`getObject(int row, int column)` Gets the column object specifed by integer position of the row and column.
`Object`	`getObject(int row, String columnName)` Gets the column object specifed by integer position of the row and column.
`Object`	`getObject(String columnName)` Gets the column object specifed by column name for the current row in the recordset.
`ParameterMetaData`	`getParameterMetaData()` Retrieves the number, types and properties of this PreparedStatement object's parameters.
`ResultSet`	`getResultSet()` Gets the current java.sql.ResultSet
`int`	`getRow()` Gets in the position of the cursor within the ResultSet.
`int`	`getRowCount()` Gets the current number of rows in the ResultSet
`int`	`getSize()` Gets the number of rows in the current ResultSet
`String`	`getSql()` Gets the SQL currently set for this instance
`String`	`getSqlProperty()` Gets the currently established SQL property
`String`	`getString(String columnName)` Gets a String value from the current row based on the name of the column desired.
`String`	`getTableName(int i)` Gets the tablename from within the current resultset given the positional number of the table.
`Time`	`getTime(String columnName)` Gets a Time value from the current row based on the name of the column desired using the default Calendar.
`Time`	`getTime(String columnName, Calendar cal)` Gets a Time value from the current row based on the name of the column desired using the Calendar specified.
`boolean`	`hasData()` Gets the state of the ResultSet returning true if the ResultSet contains data, otherwise false.
`boolean`	`isEmpty()` Determines of the ResultSet is empty or not
`void`	`last()` Moves the cursor position to the last record in the ResultSet.
`boolean`	`next()` Moves the record set pointer forward by one record.
`void`	`nextRecord()` Deprecated. as of 1.7.1, replaced by `next()` may be removed from future versions
`boolean`	`previous()` Method previous will move the record set pointer backward by one record.
`void`	`previousRecord()` Deprecated. as of 1.7.1, replaced by `previous()` may be removed from future versions
`void`	`query()` Deprecated. as of 1.5, replaced by `executeQuery()` may be removed from future versions
`void`	`query(Connection conn, String sql)` Deprecated. as of 1.5, replaced by `executeQuery()` may be removed from future versions
`void`	`query(Connection conn, String sql, String[] args)` Deprecated. as of 1.5, replaced by `executeQuery()` may be removed from future versions
`void`	`query(String sql)` Deprecated. as of 1.5, replaced by `executeQuery()` may be removed from future versions
`void`	`query(String[] args)` Deprecated. as of 1.5, replaced by `executeQuery()` may be removed from future versions
`void`	`query(String sql, String[] args)` Deprecated. as of 1.5, replaced by `executeQuery()` may be removed from future versions
`void`	`releaseSavepoint(Savepoint sp)` Releases a given savepoint.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a set property
`void`	`setArg(String arg)` Deprecated. As of release 1.5, replaced by `setParameter(int,int,Object)`
`void`	`setArgs(String[] args)` Deprecated. As of release 1.5, replaced by `setParameter(int,int,Object)`
`void`	`setArguments(ArrayList nameList, ArrayList typeList, ArrayList valueList)` Deprecated. As of release 1.5, replaced by `setParameter(int,int,Object)`
`void`	`setArray(int parameterIndex, Array x)` Sets the designated parameter to the given Java int value.
`void`	`setAsciiStream(int parameterIndex, InputStream x, int length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`void`	`setAutoCommit(boolean state)` Turns automatic comitting on or off.
`void`	`setAutoRollback(boolean state)` Turns automatic rollback functionality on or off.
`void`	`setBigDecimal(int parameterIndex, BigDecimal x)` Sets the designated parameter to the given java.math.BigDecimal value.
`void`	`setBinaryStream(int parameterIndex, InputStream x, int length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`void`	`setBlob(int parameterIndex, Blob x)` Sets the designated parameter to the given java.sql.Blob value.
`void`	`setBoolean(int parameterIndex, boolean x)` Sets the designated parameter to the given Java boolean value.
`void`	`setByte(int parameterIndex, byte x)` Sets the designated parameter to the given Java byte value.
`void`	`setBytes(int parameterIndex, byte[] x)` Sets the designated parameter to the given Java array of bytes value.
`void`	`setCharacterStream(int parameterIndex, Reader reader, int length)` Sets the designated parameter to the given Reader object, which is the given number of characters long.
`void`	`setClob(int parameterIndex, Clob x)` Sets the designated parameter to the given java.sql.Clob value.
`void`	`setCommitting(boolean state)` Turns commit processing on or off.
`void`	`setConnection(Connection c)` Assigns the Connection c to this object to use for all operations
`void`	`setConnProperty(Connection value)` Sets the current database connection property.
`void`	`setCurrentRow(int i)` Sets the cursor position to an absolute row in the ResultSet
`void`	`setData()` Deprecated. As of release 1.2, replaced by `query()`
`void`	`setData(Connection conn, String sql, String[] args)` Deprecated. As of release 1.2, replaced by `query(java.sql.Connection,String,String[])`
`void`	`setData(String[] args)` Deprecated. As of release 1.2, replaced by `query(String[])`
`void`	`setData(String sql, String[] args)` Deprecated. As of release 1.2, replaced by `query(String,String[])`
`void`	`setDate(int parameterIndex, Date x)` Sets the designated parameter to the given java.sql.Date value.
`void`	`setDate(int parameterIndex, Date x, Calendar cal)` Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
`void`	`setDouble(int parameterIndex, double x)` Sets the designated parameter to the given Java double value.
`void`	`setFloat(int parameterIndex, float x)` Sets the designated parameter to the given Java float value.
`void`	`setInt(int parameterIndex, int x)` Sets the designated parameter to the given Java int value.
`void`	`setLong(int parameterIndex, long x)` Sets the designated parameter to the given Java long value.
`void`	`setNull(int parameterIndex, int sqlType)` Sets the designated parameter to SQL NULL.
`void`	`setObject(int parameterIndex, Object x)` Sets the value of the designated parameter using the given object.
`void`	`setParameter(int parameterIndex, int sqlType, Object x)` Sets a parameter for use in the subsequent query or update call by evaluating the type and object value passed in.
`void`	`setRef(int parameterIndex, Ref x)` Sets the designated parameter to the given REF() value.
`protected void`	`setRowCount()` Sets the current row count property to the size of the current record set.
`Savepoint`	`setSavePoint()` Sets an un-named savepoint in the current transaction.
`Savepoint`	`setSavePoint(String s)` Sets an named savepoint in the current transaction.
`void`	`setShort(int parameterIndex, short x)` Sets the designated parameter to the given Java short value.
`void`	`setSql(String sql)` Sets the SQL to use for performing queries to populate the ResultSet with.
`void`	`setSqlProperty(String value)` Sets the current SQL code property used in a query
`void`	`setString(int parameterIndex, String x)` Sets the designated parameter to the given Java String value.
`void`	`setTime(int parameterIndex, Time x)` Sets the designated parameter to the given java.sql.Time value value.
`void`	`setTime(int parameterIndex, Time x, Calendar cal)` Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
`void`	`setTimestamp(int parameterIndex, Timestamp x)` Sets the designated parameter to the given java.sql.Timestamp value.
`void`	`setURL(int parameterIndex, URL x)` Sets the designated parameter to the given java.net.URL value.
`Object[][]`	`toObjectArray()` Converts the resultset to a two dimensional array of primitive type java.lang.Object (Object [][]).
`String[][]`	`toStringArray()` Converts the resultset to a two dimensional array of type java.lang.String (String [][]).
`int`	`update()` Deprecated. as of 1.5, replaced by `executeUpdate()` may be removed from future versions
`int`	`update(Connection conn, String sql)` Deprecated. as of 1.5, replaced by `executeUpdate()` may be removed from future versions
`int`	`update(Connection conn, String sql, String[] args)` Deprecated. as of 1.5, replaced by `executeUpdate()` may be removed from future versions
`int`	`update(String sql)` Deprecated. as of 1.5, replaced by `executeUpdate()` may be removed from future versions
`int`	`update(String[] args)` Deprecated. as of 1.5, replaced by `executeUpdate()` may be removed from future versions
`int`	`update(String sql, String[] args)` Deprecated. as of 1.5, replaced by `executeUpdate()` may be removed from future versions

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

Constructor Detail

SQLDataSet

public SQLDataSet()

Initializes a new instance of SQLDataSet.

SQLDataSet

public SQLDataSet(Connection conn,
                  String sql)
           throws SQLException

Initializes a new instance of SQLDataSeta and establishes the connection and statement.

Parameters:: conn - an open connection to the database URL; sql - an SQL statement that may contain one or more '?' IN parameter placeholders
Throws:: SQLException

Method Detail

getDataSetInterface

public SQLSet getDataSetInterface()

Establishes the interface to a SQLDataSetInterface.

Returns:: SQLSet object

finalize

public void finalize()
              throws Throwable

Cleans out the instance during garbage collection.

Overrides:: finalize in class Object

Throws:: Throwable

getArguments

public ArrayList getArguments(String type)

Deprecated. as of 1.5 may be removed from future versions

Gets the current set of arguments established for this data set. There are three types of argument lists; Names, Types, and Values. You may select the types by specifying all or part of the type name. For example, "Name", "NAME", "Na", "N" are all treated as type "Name".

Name: The name of the parameter
Type: The java type of the parameter
Value: The current value of the parameter

Parameters are set using the setArguments method. However, parameters are also set as a result of using the method setData(Connection, String, String[]) or setData(String, String[]) or setData(String[]) methods. In this case the arguments are all treated as String arguments with a name of "anonymous".

Parameters:: type - One of the following (only first letter is relevant):
[N]ame

[T]ype

[V]alue
Returns:: the requested argument list as a java.util.ArrayList object

toObjectArray

public Object[][] toObjectArray()

Converts the resultset to a two dimensional array of primitive type java.lang.Object (Object [][]).

Returns:: an Object array representing the contents of the java.sql.ResultSet contents of this SQLDataSet object. If the resultset is empty or null then null is returned.

toStringArray

public String[][] toStringArray()

Converts the resultset to a two dimensional array of type java.lang.String (String [][]). The first element representing the record and the second representing the column within the record.

For example:
mySqlDataSet[6][8] = the seventh record and the nineth column from the instance objects java.sql.ResultSet.

Returns:: a String array representing the contents of the java.sql.ResultSet contents of this SQLDataSet object. If the resultset is empty or null then null is returned.

getConnection

public Connection getConnection()

Gets the connection object for this instantiation.

Returns:: connection object of type java.sql.Connection

getConnectionURL

public String getConnectionURL()
                        throws SQLException

Gets the URL that describes or represents this jdbc connection.

Returns:: a URL string that describes this jdbc connection.
Throws:: SQLException - if the resultset does not exist or a database error occurs

getColumnPosition

public int getColumnPosition(String columnName)

Gets the position of a column in the resultset given the name of the column. For example consider the SQL:

select x, y, z from dual

2 == getColumnPosition("y")

Parameters:: columnName - the text name of the column to find. The column name is not case sensitive.
Returns:: an integer representing the columns position in the resultset with 1 being the first position

getTableName

public String getTableName(int i)

Gets the tablename from within the current resultset given the positional number of the table.

For example, consider the following SQL:

select a.x, a.y, b.z from table_a, table_b where ...

"table_b" == getTableName(2)

Parameters:: i - the position of the table within the SQL. 1 equals the first table, 2 the second and so on.
Returns:: the text name of the table in the query (not the alias if one exists).

getString

public String getString(String columnName)
                 throws SQLException

Gets a String value from the current row based on the name of the column desired. If the field is not a String it is converted to a String.

Parameters:: columnName - database column name, case insensitive
Returns:: value from the field in the record
Throws:: SQLException - Throws a general exception if unable to fetch the column

getInt

public int getInt(String columnName)
           throws SQLException

Gets a Integer value from the current row based on the name of the column desired. If the field is not a Integer, or the record pointer is not positioned on a record, an exception will be thrown.

Parameters:: columnName - name of the column to fetch the value from the current record
Returns:: value of the desired column as a int value
Throws:: SQLException - thrown when unable to fetch the value, null values have no effect

getDate

public Date getDate(String columnName)
             throws SQLException

Gets a Date value from the current row based on the name of the column desired using the default Calendar. If the field is not a Date, or the record pointer is not positioned on a record, an exception may be thrown or the date may be improperly translated.

Parameters:: columnName - name of the column to fetch the value from the current record
Returns:: value of the desired column as a Date value
Throws:: SQLException - thrown when unable to fetch the value, null values have no effect
See Also:: getDate(String,java.util.Calendar)

getFloat

public float getFloat(String columnName)
               throws SQLException

Gets a Float value from the current row based on the name of the column desired. If the field is not a Float number, or the record pointer is not positioned on a record, an exception will be thrown. or the date may be improperly translated.

Parameters:: columnName - name of the column to fetch the value from the current record
Returns:: value of the desired column as a Date value
Throws:: SQLException - thrown when unable to fetch the value or the value is not of type Float, null values have no effect

getBigDecimal

public BigDecimal getBigDecimal(String columnName)
                         throws SQLException

Gets a BigDecimal value from the current row based on the name of the column desired. If the field is not a BigDecimal number, or the record pointer is not positioned on a record, an exception will be thrown.

Parameters:: columnName - name of the column to fetch the value from the current record
Returns:: value of the desired column as a BigDecimal value
Throws:: SQLException - thrown when unable to fetch the value or the value is not of type BigDecimal or cannot be coerced to Big Decimal, null values have no effect

getBlob

public Blob getBlob(String columnName)
             throws SQLException

Gets a Blob (Binary Large Object Block) object from the current row based on the name of the column desired. If the field is not a Blob, or the record pointer is not positioned on a record, an exception will be thrown. The interpretation of the Blob is dependent on the underlying SQL driver used. The object returned is a generic sql.java.Blob object.

Parameters:: columnName - name of the column to fetch the value from the current record
Returns:: value of the desired column as a Blob object
Throws:: SQLException - thrown when unable to fetch the value or the value is not of type BLOB, null values have no effect

getDate

public Date getDate(String columnName,
                    Calendar cal)
             throws SQLException

Gets a Date value from the current row based on the name of the column desired using the Calendar specified. If the field is not a Date, or the record pointer is not positioned on a record, an exception may be thrown or the date may be improperly translated.

Parameters:: columnName - name of the column to fetch the value from the current record; cal - a java.util.Calendar object
Returns:: value of the desired column as a Date value
Throws:: SQLException - thrown when unable to fetch the value, null values have no effect
See Also:: getDate(String)

getTime

public Time getTime(String columnName,
                    Calendar cal)
             throws SQLException

Gets a Time value from the current row based on the name of the column desired using the Calendar specified. If the field is not a Time field, or the record pointer is not positioned on a record, an exception may be thrown or the Time may be improperly translated.

Parameters:: columnName - name of the column to fetch the value from the current record; cal - a java.util.Calendar object
Returns:: value of the desired column as a Time value
Throws:: SQLException - thrown when unable to fetch the value, null values have no effect
See Also:: getTime(String), getDate(String), (String, Calendar)

getTime

public Time getTime(String columnName)
             throws SQLException

Gets a Time value from the current row based on the name of the column desired using the default Calendar. If the field is not a Time field, or the record pointer is not positioned on a record, an exception may be thrown or the Time may be improperly translated.

Parameters:: columnName - name of the column to fetch the value from the current record
Returns:: value of the desired column as a Time value
Throws:: SQLException - thrown when unable to fetch the value, null values have no effect
See Also:: getTime(String), getDate(String), (String, Calendar)

getDouble

public double getDouble(String columnName)
                 throws SQLException

Gets a Double value from the current row based on the name of the column desired. If the field is not a Double number, or the record pointer is not positioned on a record, an exception will be thrown. or the date may be improperly translated.

Parameters:: columnName - name of the column to fetch the value from the current record
Returns:: value of the desired column as a Double value
Throws:: SQLException - thrown when unable to fetch the value or the value is not of type Double, null values have no effect

getClob

public Clob getClob(String columnName)
             throws SQLException

Gets a Clob (Character Large Object Block) object from the current row based on the name of the column desired. If the field is not a Clob, or the record pointer is not positioned on a record, an exception will be thrown. The interpretation of the Clob is dependent on the underlying SQL driver used. The object returned is a generic sql.java.Clob object.

Parameters:: columnName - name of the column to fetch the value from the current record
Returns:: value of the desired column as a Clob object
Throws:: SQLException - thrown when unable to fetch the value or the value is not of type CLOB, null values have no effect

getColumnType

public String getColumnType(String columnName)
                     throws SQLException

Gets the database type of column in the selected drivers meta-data notation.

Parameters:: columnName - name of the column to investigate
Returns:: java type associated with the column type as a String
Throws:: SQLException - thrown if an error occurs, otherwise the value or null

beforeFirst

public void beforeFirst()
                 throws SQLException

Moves the ResultSet cursor before the 1st record

Throws:: SQLException - thrown if a database access error occurs
See Also:: afterLast(), first(), last(), next(), nextRecord(), previous(), previousRecord()

afterLast

public void afterLast()
               throws SQLException

Moves the ResultSet cursor after the last record

Throws:: SQLException - throws a SQL exception if an error occurs while trying to reposition the result set
See Also:: beforeFirst(), first(), last(), next(), nextRecord(), previous(), previousRecord()

public boolean next()
             throws SQLException

Moves the record set pointer forward by one record. If there are no more records to advance to, nextRecord will return false, otherwise it will return true.

Returns:: boolean true if a record is found, false otherwise
Throws:: SQLException - thrown if a database access error occurs
See Also:: afterLast(), beforeFirst(), first(), last(), nextRecord(), previous(), previousRecord()

nextRecord

public void nextRecord()
                throws SQLException

Deprecated. as of 1.7.1, replaced by next() may be removed from future versions

Method nextRecord will advance to the next record in the record set. If no additional records are found it will throw a SQLException.

Throws:: SQLException - thrown if no record is found
See Also:: afterLast(), beforeFirst(), first(), last(), next(), previous(), previousRecord()

public boolean previous()
                 throws SQLException

Method previous will move the record set pointer backward by one record. If there are no more records prior to the current record, nextRecord will return false, otherwise it will return true.

Returns:: boolean true if a record is found, false otherwise
Throws:: SQLException - if a database access error occurs
See Also:: afterLast(), beforeFirst(), first(), last(), next(), nextRecord(), previousRecord()

previousRecord

public void previousRecord()
                    throws SQLException

Deprecated. as of 1.7.1, replaced by previous() may be removed from future versions

Method previousRecord will move to the previous record in the record set. If no previous records are found it will throw a SQLException.

Throws:: SQLException - if a database access error occurs
See Also:: afterLast(), beforeFirst(), first(), last(), next(), nextRecord(), previous()

first

public void first()
           throws SQLException

Moves the cursor position to the first record in the ResultSet. If the ResultSet is not established an exception will be thrown.

Throws:: SQLException - thrown if a database access error occurs
See Also:: afterLast(), beforeFirst(), last(), next(), nextRecord(), previous(), previousRecord()

last

public void last()
          throws SQLException

Moves the cursor position to the last record in the ResultSet. If the ResultSet is not established an exception will be thrown.

Throws:: SQLException - thrown if a database access error occurs
See Also:: afterLast(), beforeFirst(), first(), next(), nextRecord(), previous(), previousRecord()

getObject

public Object getObject(int row,
                        int column)
                 throws SQLException

Gets the column object specifed by integer position of the row and column. For example

getObject(1,1)

would get the first column in the first row in the established record set.

If the record set did not previously exist, an exception is thrown.

Parameters:: row - the integer value of the record position (first record = 1); column - the integer value of the column position (first column = 1)
Returns:: Object or null
Throws:: SQLException - thrown if an access or database error occurs
See Also:: getObject(String), getObject(int,String), getObject(int)

getObject

public Object getObject(int row,
                        String columnName)
                 throws SQLException

Gets the column object specifed by integer position of the row and column. For example

getObject(1,1)

would get the first column in the first row in the established record set.

If the record set did not previously exist, an exception is thrown.

Parameters:: row - the integer value of the record position (first record = 1); columnName - name of the column to retreive
Returns:: Object or null
Throws:: SQLException - thrown if an access or database error occurs
See Also:: getObject(int,int), getObject(String), getObject(int)

getObject

public Object getObject(String columnName)
                 throws SQLException

Gets the column object specifed by column name for the current row in the recordset. You must ensure that the cursor is pointed to a particular row otherwise an exception will be thrown.

Parameters:: columnName - name of the column to fetch
Returns:: Object or null
Throws:: SQLException - thrown if an access or database error occurs
See Also:: getObject(int,int), getObject(int,String), getObject(int)

getObject

public Object getObject(int i)
                 throws SQLException

Gets the column object specifed by integer position of the column for the current row. You must ensure that the cursor is pointed to a particular row otherwise an exception will be thrown.

Parameters:: i - name of the column to fetch
Returns:: Object or null
Throws:: SQLException - thrown if an access or database error occurs
See Also:: getObject(int,int), getObject(String), getObject(int,String)

getResultSet

public ResultSet getResultSet()

Gets the current java.sql.ResultSet

Returns:: ResultSet current ResultSet object or null if not set

setConnection

public void setConnection(Connection c)
                   throws SQLException

Assigns the Connection c to this object to use for all operations

Parameters:: c - valid opened java.sql.Connection object
Throws:: SQLException - thrown if the connection is not open or valid

getSize

public int getSize()

Gets the number of rows in the current ResultSet

Returns:: integer representing the number of rows in the ResultSet

getColumnNames

public String[] getColumnNames()

Gets the column names from the current ResultSet and returns them as a string array

Returns:: String[] representing the names of the columns in the ResultSet or null

getColumnCount

public int getColumnCount()

Gets the number of columns in the ResultSet

Returns:: int number of columns

getColumnType

public String getColumnType(int i)

Gets the type of a particular column in the ResultSet by numeric position

Parameters:: i - position of the column in the result set
Returns:: String java variable type associated with the column

isEmpty

public boolean isEmpty()

Determines of the ResultSet is empty or not

Returns:: boolean true if empty, otherwise false

setArg

public void setArg(String arg)

Deprecated. As of release 1.5, replaced by setParameter(int,int,Object)

A convenience method for setting a single argument rather than having to establish an array or arguments.

Parameters:: arg - single argument as a String
See Also:: setArguments(java.util.ArrayList,java.util.ArrayList,java.util.ArrayList), getArguments(String), clearArgs()

setArgs

public void setArgs(String[] args)

Deprecated. As of release 1.5, replaced by setParameter(int,int,Object)

Sets the arguments to use with the current SQL property

Parameters:: args - list of Arguments in a string array, all arguments are assumed to be of type String and anonymous
See Also:: setArguments(java.util.ArrayList,java.util.ArrayList,java.util.ArrayList), getArguments(String), clearArgs()

setArguments

public void setArguments(ArrayList nameList,
                         ArrayList typeList,
                         ArrayList valueList)

Deprecated. As of release 1.5, replaced by setParameter(int,int,Object)

Sets the arguments to use with the current SQL property

Parameters:: nameList - parameter name list; typeList - parameter type list; valueList - parameter value list
See Also:: setArgs(String[]), getArguments(String), clearArgs()

close

public void close()

Closes the ResultSet thereby freeing the cursors. Note that this does not close the connection or reset any parameters.

clearArgs

public void clearArgs()

Sets the current arguments and parameters to empty (null)

setSql

public void setSql(String sql)

Sets the SQL to use for performing queries to populate the ResultSet with.

Parameters:: sql - an SQL statement that may contain one or more '?' IN parameter placeholders
See Also:: getSql()

getSql

public String getSql()

Gets the SQL currently set for this instance

Returns:: String representing the SQL code

hasData

public boolean hasData()

Gets the state of the ResultSet returning true if the ResultSet contains data, otherwise false.

Returns:: true if the ResultSet currently contains data, false otherwise
See Also:: isEmpty()

setCurrentRow

public void setCurrentRow(int i)
                   throws SQLException

Sets the cursor position to an absolute row in the ResultSet

Parameters:: i - row to point to
Throws:: SQLException - thrown if an access or database error occurs

getCurrentRow

public int getCurrentRow()

Deprecated. As of release 1.5, replaced by getRow() may be removed from future versions

Gets in the position of the cursor within the ResultSet

Returns:: int position of the cursor
Since:: 1.0

getRow

public int getRow()

Gets in the position of the cursor within the ResultSet.

This is the same as (deprecated) {link #getCurrentRow()}. Essentially this is exactly like calling ResultSet.getRow().

Returns:: int position of the cursor
Since:: 1.7.1

getRowCount

public int getRowCount()

Gets the current number of rows in the ResultSet

Returns:: int number of rows in the ResultSet

getColumnName

public String getColumnName(int i)

Gets the name of the column as indicated by the position of the column (i) within the ResultSet.

Parameters:: i - position of the column
Returns:: name of the column

setData

public void setData()
             throws SQLException

Deprecated. As of release 1.2, replaced by query()

Establishes the result set by performing the query based on the given parameters.

Throws:: SQLException - thrown if an access or database error occurs
See Also:: query(), query(String[]), query(String,String[]), query(java.sql.Connection,String,String[])

setData

public void setData(String[] args)
             throws SQLException

Deprecated. As of release 1.2, replaced by query(String[])

Establishes the result set by performing the query based on the given parameters.

Parameters:: args - String array representing the corresponding argument values
Throws:: SQLException - thrown if an access or database error occurs
See Also:: query(), query(String[]), query(String,String[]), query(java.sql.Connection,String,String[])

setData

public void setData(String sql,
                    String[] args)
             throws SQLException

Deprecated. As of release 1.2, replaced by query(String,String[])

Establishes the result set by performing the query based on the given parameters.

Parameters:: sql - an SQL statement that may contain one or more '?' IN parameter placeholders; args - String array representing the corresponding argument values
Throws:: SQLException - thrown if an access or database error occurs
See Also:: query(), query(String[]), query(String,String[]), query(java.sql.Connection,String,String[])

setData

public void setData(Connection conn,
                    String sql,
                    String[] args)
             throws SQLException

Deprecated. As of release 1.2, replaced by query(java.sql.Connection,String,String[])

Establishes the result set by performing the query based on the given parameters.

Parameters:: conn - Connection object representing an opened java.sql.Connection; sql - an SQL statement that may contain one or more '?' IN parameter placeholders; args - String array representing the corresponding argument values
Throws:: SQLException - thrown if an access or database error occurs