Class ResultHandlerDelegate

  • All Implemented Interfaces:
    ResultHandler

    public class ResultHandlerDelegate
    extends java.lang.Object
    implements ResultHandler
    Internal to the driver class, please do not use in the application.

    The class simplifies creation of ResultHandler delegates: it provides default implementation for the interface methods

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.sql.SQLException getException()
      Returns the first encountered exception.
      java.sql.SQLWarning getWarning()
      Returns the first encountered warning.
      void handleCommandStatus​(java.lang.String status, long updateCount, long insertOID)
      Called when a query that did not return a resultset completes.
      void handleCompletion()
      Called before a QueryExecutor method returns.
      void handleError​(java.sql.SQLException error)
      Called when an error occurs.
      void handleResultRows​(Query fromQuery, Field[] fields, java.util.List<Tuple> tuples, ResultCursor cursor)
      Called when result rows are received from a query.
      void handleWarning​(java.sql.SQLWarning warning)
      Called when a warning is emitted.
      void secureProgress()
      Callback for batch statements.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ResultHandlerDelegate

        public ResultHandlerDelegate​(ResultHandler delegate)
    • Method Detail

      • handleResultRows

        public void handleResultRows​(Query fromQuery,
                                     Field[] fields,
                                     java.util.List<Tuple> tuples,
                                     ResultCursor cursor)
        Description copied from interface: ResultHandler
        Called when result rows are received from a query.
        Specified by:
        handleResultRows in interface ResultHandler
        Parameters:
        fromQuery - the underlying query that generated these results; this may not be very specific (e.g. it may be a query that includes multiple statements).
        fields - column metadata for the resultset; might be null if Query.QUERY_NO_METADATA was specified.
        tuples - the actual data
        cursor - a cursor to use to fetch additional data; null if no further results are present.
      • handleCommandStatus

        public void handleCommandStatus​(java.lang.String status,
                                        long updateCount,
                                        long insertOID)
        Description copied from interface: ResultHandler
        Called when a query that did not return a resultset completes.
        Specified by:
        handleCommandStatus in interface ResultHandler
        Parameters:
        status - the command status string (e.g. "SELECT") returned by the backend
        updateCount - the number of rows affected by an INSERT, UPDATE, DELETE, FETCH, or MOVE command; -1 if not available.
        insertOID - for a single-row INSERT query, the OID of the newly inserted row; 0 if not available.
      • handleWarning

        public void handleWarning​(java.sql.SQLWarning warning)
        Description copied from interface: ResultHandler
        Called when a warning is emitted.
        Specified by:
        handleWarning in interface ResultHandler
        Parameters:
        warning - the warning that occurred.
      • handleError

        public void handleError​(java.sql.SQLException error)
        Description copied from interface: ResultHandler
        Called when an error occurs. Subsequent queries are abandoned; in general the only calls between a handleError call and a subsequent handleCompletion call are handleError or handleWarning.
        Specified by:
        handleError in interface ResultHandler
        Parameters:
        error - the error that occurred
      • handleCompletion

        public void handleCompletion()
                              throws java.sql.SQLException
        Description copied from interface: ResultHandler
        Called before a QueryExecutor method returns. This method may throw a SQLException if desired; if it does, the QueryExecutor method will propagate that exception to the original caller.
        Specified by:
        handleCompletion in interface ResultHandler
        Throws:
        java.sql.SQLException - if the handler wishes the original method to throw an exception.
      • secureProgress

        public void secureProgress()
        Description copied from interface: ResultHandler
        Callback for batch statements. In case batch statement is executed in autocommit==true mode, the executor might commit "as it this it is best", so the result handler should track which statements are executed successfully and which are not.
        Specified by:
        secureProgress in interface ResultHandler
      • getException

        public java.sql.SQLException getException()
        Description copied from interface: ResultHandler
        Returns the first encountered exception. The rest are chained via SQLException.setNextException(SQLException)
        Specified by:
        getException in interface ResultHandler
        Returns:
        the first encountered exception
      • getWarning

        public java.sql.SQLWarning getWarning()
        Description copied from interface: ResultHandler
        Returns the first encountered warning. The rest are chained via SQLException.setNextException(SQLException)
        Specified by:
        getWarning in interface ResultHandler
        Returns:
        the first encountered warning