Package org.dbunit.database.statement

Class AutomaticPreparedBatchStatement

java.lang.Object

org.dbunit.database.statement.AutomaticPreparedBatchStatement

All Implemented Interfaces:

IPreparedBatchStatement

public class AutomaticPreparedBatchStatement
extends Object
implements IPreparedBatchStatement

Decorator around an IPreparedBatchStatement that automatically executes the accumulated batch once a configured row-count threshold is reached.

Since:

Jun 12, 2003

Version:

$Revision$

Author:

Manuel Laflamme

Constructor Summary

Constructors

Constructor	Description
AutomaticPreparedBatchStatement(IPreparedBatchStatement statement, int threshold)	Creates a statement that automatically executes the batch once the given threshold is reached.

Method Summary

Modifier and Type	Method	Description
void	addBatch()	Adds the currently bound parameters as a new row to the batch.
void	addValue(Object value, DataType dataType)	Binds the given value, cast using the given data type, to the next parameter of the statement.
void	clearBatch()	Clears all batched rows.
void	close()	Closes this statement.
int	executeBatch()	Executes all batched rows.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AutomaticPreparedBatchStatement

public AutomaticPreparedBatchStatement(IPreparedBatchStatement statement,
 int threshold)

Creates a statement that automatically executes the batch once the given threshold is reached.

Parameters:

statement - the decorated statement to which batching is delegated.

threshold - the number of batched rows that triggers an automatic execution.

Method Details

addValue

public void addValue(Object value,
 DataType dataType)
              throws TypeCastException,
SQLException

Description copied from interface: IPreparedBatchStatement

Binds the given value, cast using the given data type, to the next parameter of the statement.

Specified by:

addValue in interface IPreparedBatchStatement

Parameters:

value - the value to bind.

dataType - the data type used to cast the value.

Throws:

TypeCastException - if the value cannot be cast to the given data type.

SQLException - if binding the value to the statement fails.

addBatch

public void addBatch()
              throws SQLException

Description copied from interface: IPreparedBatchStatement

Adds the currently bound parameters as a new row to the batch.

Specified by:

addBatch in interface IPreparedBatchStatement

Throws:

SQLException - if adding the batch row fails.

executeBatch

public int executeBatch()
                 throws SQLException

Description copied from interface: IPreparedBatchStatement

Executes all batched rows.

Specified by:

executeBatch in interface IPreparedBatchStatement

Returns:

the number of rows affected by each batched statement.

Throws:

SQLException - if executing the batch fails.

clearBatch

public void clearBatch()
                throws SQLException

Description copied from interface: IPreparedBatchStatement

Clears all batched rows.

Specified by:

clearBatch in interface IPreparedBatchStatement

Throws:

SQLException - if clearing the batch fails.

close

public void close()
           throws SQLException

Description copied from interface: IPreparedBatchStatement

Closes this statement.

Specified by:

close in interface IPreparedBatchStatement

Throws:

SQLException - if closing the statement fails.