Class QueryExecuteEvent

  • All Implemented Interfaces:
    java.io.Serializable

    public class QueryExecuteEvent
    extends java.util.EventObject
    An event that is generated when a query is executed.
    Version:
    $Revision: 7059 $
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    QueryExecuteListener, Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      QueryExecuteEvent​(java.lang.Object source, DbUtils utils, java.lang.String query, int rows, java.sql.ResultSet rs, java.lang.Exception ex)
      constructs the event
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean failed()
      is TRUE in case the exception is not NULL, i.e.
      DbUtils getDbUtils()
      returns the DbUtils instance that was executed the query
      java.lang.Exception getException()
      returns the exception, if one happened, otherwise NULL
      int getMaxRows()
      returns the maximum number of rows to retrieve.
      java.lang.String getQuery()
      returns the query that was executed
      java.sql.ResultSet getResultSet()
      returns the resultset that was produced, can be null in case the query failed
      boolean hasResult()
      whether a ResultSet was produced, e.g.
      java.lang.String toString()
      returns the event in a string representation
      • Methods inherited from class java.util.EventObject

        getSource
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • QueryExecuteEvent

        public QueryExecuteEvent​(java.lang.Object source,
                                 DbUtils utils,
                                 java.lang.String query,
                                 int rows,
                                 java.sql.ResultSet rs,
                                 java.lang.Exception ex)
        constructs the event
        Parameters:
        source - the source that generated this event
        utils - the DbUtils instance that connected to the DB
        query - the query that is the basis for the resultset
        rows - the maximum number of rows to retrieve (0 for all)
        rs - the ResultSet that was produced (depending on the type of SQL query it can also be NULL)
        ex - in case an exception occurred
    • Method Detail

      • getDbUtils

        public DbUtils getDbUtils()
        returns the DbUtils instance that was executed the query
      • getQuery

        public java.lang.String getQuery()
        returns the query that was executed
      • getMaxRows

        public int getMaxRows()
        returns the maximum number of rows to retrieve. 0 means all.
      • failed

        public boolean failed()
        is TRUE in case the exception is not NULL, i.e. the query failed
      • hasResult

        public boolean hasResult()
        whether a ResultSet was produced, e.g. DDL commands like delete, drop or update do not produce one.
      • getResultSet

        public java.sql.ResultSet getResultSet()
        returns the resultset that was produced, can be null in case the query failed
      • getException

        public java.lang.Exception getException()
        returns the exception, if one happened, otherwise NULL
      • toString

        public java.lang.String toString()
        returns the event in a string representation
        Overrides:
        toString in class java.util.EventObject
        Returns:
        the event in a string representation