org.firebirdsql.jdbc

Interface FirebirdStatement

All Superinterfaces:
Statement
Known Subinterfaces:
FirebirdCallableStatement, FirebirdPreparedStatement
Known Implementing Classes:
AbstractCallableStatement, AbstractPreparedStatement, AbstractStatement

public interface FirebirdStatement
extends Statement

Firebird-specific extensions to the Statement interface.
Author:
Roman Rokytskyy

Field Summary

static int
CLOSE_ALL_RESULTS
The constant indicating that all ResultSet objects that have previously been kept open should be closed when calling getMoreResults.
static int
CLOSE_CURRENT_RESULT
The constant indicating that the current ResultSet object should be closed when calling getMoreResults.
static int
KEEP_CURRENT_RESULT
The constant indicating that the current ResultSet object should not be closed when calling getMoreResults.

Method Summary

ResultSet
getCurrentResultSet()
Get current result set.
int
getDeletedRowsCount()
Get number of deleted rows.
int
getInsertedRowsCount()
Get number of inserted rows.
String
getLastExecutionPlan()
Get execution plan for the last executed statement.
int
getUpdatedRowsCount()
Get number of updated rows.
boolean
hasOpenResultSet()
Check if this statement has open result set.
boolean
isValid()
Check if this statement is valid.

Field Details

CLOSE_ALL_RESULTS

public static final int CLOSE_ALL_RESULTS
The constant indicating that all ResultSet objects that have previously been kept open should be closed when calling getMoreResults.

Copied from JDBC 3.0 definition

Field Value:
3

CLOSE_CURRENT_RESULT

public static final int CLOSE_CURRENT_RESULT
The constant indicating that the current ResultSet object should be closed when calling getMoreResults.

Copied from JDBC 3.0 definition

Field Value:
1

KEEP_CURRENT_RESULT

public static final int KEEP_CURRENT_RESULT
The constant indicating that the current ResultSet object should not be closed when calling getMoreResults.

Copied from JDBC 3.0 definition

Field Value:
2

Method Details

getCurrentResultSet

public ResultSet getCurrentResultSet()
            throws SQLException
Get current result set. Behaviour of this method is similar to the behavior of the Statement.getResultSet(), except that this method can be called as much as you like.
Returns:
instance of ResultSet representing current result set or null if it is not available.

getDeletedRowsCount

public int getDeletedRowsCount()
            throws SQLException
Get number of deleted rows. You can call this method multiple times, it does not affect the JDBC result number.
Returns:
number of deleted rows or -1 if current result is result set.

getInsertedRowsCount

public int getInsertedRowsCount()
            throws SQLException
Get number of inserted rows. You can call this method multiple times, it does not affect the JDBC result number.
Returns:
number of inserted rows or -1 if current result is result set.

getLastExecutionPlan

public String getLastExecutionPlan()
            throws SQLException
Get execution plan for the last executed statement. Unlike the FirebirdPreparedStatement.getExecutionPlan(), this method can be called only after executing a query or update statement.
Returns:
execution plan returned by the server.

getUpdatedRowsCount

public int getUpdatedRowsCount()
            throws SQLException
Get number of updated rows. You can call this method multiple times, it does not affect the JDBC result number.
Returns:
number of updated rows or -1 if current result is result set.

hasOpenResultSet

public boolean hasOpenResultSet()
Check if this statement has open result set. Note, this method works correctly if auto-commit is disabled. In auto-commit mode it will always return false because from the statement's point of view result set is not open (in auto-commit mode complete result set is fetched and cached in wrapping object before returning from the getResultSet() method).
Returns:
true if there's already open result set associated with this statement, otherwise false.

isValid

public boolean isValid()
Check if this statement is valid.
Returns:
true if statement is valid and can be used to execute SQL.

Copyright B) 2001 David Jencks and other authors. All rights reserved.