All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.as400.vaccess.SQLStatementDocument
java.lang.Object
|
+----com.sun.java.swing.text.AbstractDocument
|
+----com.sun.java.swing.text.PlainDocument
|
+----com.ibm.as400.vaccess.SQLStatementDocument
- public class SQLStatementDocument
- extends PlainDocument
- implements Serializable
The SQLStatementDocument class represents SQL statement that is
issued when execute() is called.
It is up to the user to register a JDBC driver when using this class.
For example, the following code registers the AS/400 Toolbox for Java
JDBC driver.
DriverManager.registerDriver (new com.ibm.as400.access.AS400JDBCDriver ());
Most errors are reported by firing ErrorEvents, rather
than throwing exceptions. Users should listen for ErrorEvents
in order to diagnose and recover from error conditions.
SQLStatementDocument objects generate the following events:
- ActionCompletedEvent
- ErrorEvent
- PropertyChangeEvent
- DocumentEvent
- WorkingEvent
-
SQLStatementDocument()
- Constructs a SQLStatementDocument object.
-
SQLStatementDocument(SQLConnection, String)
- Constructs a SQLStatementDocument object.
-
addActionCompletedListener(ActionCompletedListener)
- Adds a listener to be notified when a SQL statement is executed.
-
addErrorListener(ErrorListener)
- Adds a listener to be notified when an error occurs.
-
addPropertyChangeListener(PropertyChangeListener)
- Adds a listener to be notified when the value of any bound
property is changed.
-
addVetoableChangeListener(VetoableChangeListener)
- Adds a listener to be notified when the value of any constrained
property is changed.
-
addWorkingListener(WorkingListener)
- Adds a listener to be notified when work starts and stops
on potentially long-running operations.
-
execute()
- Runs the contents of this document as a SQL statement.
-
getConnection()
- Returns the SQL connection used to execute statements.
-
getMoreResults()
- Makes the next result of the last statement run the current result.
-
getResultSet()
- Returns the current results of the last SQL statement run.
-
getSQLStatement()
- Returns the SQL statement that was last executed
which the results in this object represent.
-
getUpdateCount()
- Returns the number of rows affected by the last SQL statement run.
-
getWarnings()
- Returns the warnings generated by the JDBC connection and statement.
-
removeActionCompletedListener(ActionCompletedListener)
- Removes a listener from being notified when a SQL statement is issued.
-
removeErrorListener(ErrorListener)
- Removes a listener from being notified when an error occurs.
-
removePropertyChangeListener(PropertyChangeListener)
- Removes a listener from being notified when the value of any bound
property is changed.
-
removeVetoableChangeListener(VetoableChangeListener)
- Removes a listener from being notified when the value of any constrained
property is changed.
-
removeWorkingListener(WorkingListener)
- Removes a listener from being notified when work starts and stops
on potentially long-running operations.
-
setConnection(SQLConnection)
- Sets the SQL connection used to execute statements.
SQLStatementDocument
public SQLStatementDocument()
- Constructs a SQLStatementDocument object.
SQLStatementDocument
public SQLStatementDocument(SQLConnection connection,
String text)
- Constructs a SQLStatementDocument object.
- Parameters:
- connection - The SQL connection.
- text - The text for the document
addActionCompletedListener
public void addActionCompletedListener(ActionCompletedListener listener)
- Adds a listener to be notified when a SQL statement is executed.
The listener's actionCompleted() method will be called.
- Parameters:
- listener - The listener.
addErrorListener
public void addErrorListener(ErrorListener listener)
- Adds a listener to be notified when an error occurs.
The listener's errorOccurred() method will be called.
- Parameters:
- listener - The listener.
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
- Adds a listener to be notified when the value of any bound
property is changed.
The listener's propertyChange() method will be called.
- Parameters:
- listener - The listener.
addVetoableChangeListener
public void addVetoableChangeListener(VetoableChangeListener listener)
- Adds a listener to be notified when the value of any constrained
property is changed.
The listener's vetoableChange() method will be called.
- Parameters:
- listener - The listener.
addWorkingListener
public void addWorkingListener(WorkingListener listener)
- Adds a listener to be notified when work starts and stops
on potentially long-running operations.
- Parameters:
- listener - The listener.
execute
public void execute()
- Runs the contents of this document as a SQL statement.
getConnection
public SQLConnection getConnection()
- Returns the SQL connection used to execute statements.
- Returns:
- The SQL connection.
getMoreResults
public void getMoreResults()
- Makes the next result of the last statement run the current result.
Nothing is done if no statement has been executed.
Refer to JDBC documentation for more information.
getResultSet
public ResultSet getResultSet()
- Returns the current results of the last SQL statement run.
Multiple results can be obtained by
calling getUpdateCount() and/or getResultSet() multiple
times, with intervening getMoreResults() calls.
Refer to JDBC documentation for more information.
- Returns:
- The result set or null if the result was not a
result set, or if there are no results.
getSQLStatement
public String getSQLStatement()
- Returns the SQL statement that was last executed
which the results in this object represent.
- Returns:
- The SQL statement that the results in this object represent.
getUpdateCount
public int getUpdateCount()
- Returns the number of rows affected by the last SQL statement run.
Multiple results can be obtained by
calling getUpdateCount() and/or getResultSet() multiple
times, with intervening getMoreResults() calls.
If an error occurs, 0 is returned.
Refer to JDBC documentation for more information.
- Returns:
- The number of rows that were
affected. If no rows were affected or the SQL statement was
a DDL command, 0 is returned. If there are no results or the results
are a result set, -1 is returned.
getWarnings
public SQLWarning getWarnings()
- Returns the warnings generated by the JDBC connection and statement.
Each time the execute() is called (the SQL statement is run), the
warnings are cleared. Connection warnings are only available after the
first time a statement is executed. The warnings from the statement will
be linked to the end of any connection warnings.
- Returns:
- The warnings generated by the connection and statement,
or null if none.
removeActionCompletedListener
public void removeActionCompletedListener(ActionCompletedListener listener)
- Removes a listener from being notified when a SQL statement is issued.
- Parameters:
- listener - The listener.
removeErrorListener
public void removeErrorListener(ErrorListener listener)
- Removes a listener from being notified when an error occurs.
- Parameters:
- listener - The listener.
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
- Removes a listener from being notified when the value of any bound
property is changed.
- Parameters:
- listener - The listener.
removeVetoableChangeListener
public void removeVetoableChangeListener(VetoableChangeListener listener)
- Removes a listener from being notified when the value of any constrained
property is changed.
- Parameters:
- listener - The listener.
removeWorkingListener
public void removeWorkingListener(WorkingListener listener)
- Removes a listener from being notified when work starts and stops
on potentially long-running operations.
- Parameters:
- listener - The listener.
setConnection
public void setConnection(SQLConnection connection) throws PropertyVetoException
- Sets the SQL connection used to execute statements.
This property is bound and constrained.
- Parameters:
- connection - The SQL connection.
- Throws: PropertyVetoException
- If the change is vetoed.
All Packages Class Hierarchy This Package Previous Next Index