com.ibatis.sqlmap.engine.execution

Class BatchException

public class BatchException extends Exception

This exception is thrown if a java.sql.BatchUpdateException is caught during the execution of any nested batch. The exception contains the java.sql.BatchUpdateException that is the root cause, as well as the results from any prior nested batch that executed successfully. This exception is only thrown from the executeBatchDetailed method.

Author: Jeff Butler

Constructor Summary
BatchException(String message, BatchUpdateException cause, List successfulBatchResults, String failingStatementId, String failingSqlStatement)
Method Summary
BatchUpdateExceptiongetBatchUpdateException()
Returns the BatchUpdateException that caused the nested batch to fail.
StringgetFailingSqlStatement()
Returns the SQL statement that caused the failure (not the parameters)
StringgetFailingStatementId()
Returns the statement id of the statement that caused the failure
ListgetSuccessfulBatchResults()
Returns a list of BatchResult objects.

Constructor Detail

BatchException

public BatchException(String message, BatchUpdateException cause, List successfulBatchResults, String failingStatementId, String failingSqlStatement)

Method Detail

getBatchUpdateException

public BatchUpdateException getBatchUpdateException()
Returns the BatchUpdateException that caused the nested batch to fail. That exception contains an array of row counts that can be used to determine exactly which statemtn of the batch caused the failure (or failures).

Returns: the root BatchUpdateException

getFailingSqlStatement

public String getFailingSqlStatement()
Returns the SQL statement that caused the failure (not the parameters)

Returns: the failing SQL string

getFailingStatementId

public String getFailingStatementId()
Returns the statement id of the statement that caused the failure

Returns: the statement id

getSuccessfulBatchResults

public List getSuccessfulBatchResults()
Returns a list of BatchResult objects. There will be one entry in the list for each successful sub-batch executed before the failing batch.

Returns: the previously successful batch results (may be an empty list if no batch has executed successfully)

Copyright © 2011. All Rights Reserved.