org.seasar.doma.jdbc.builder

Class MapBatchInsertBuilder

java.lang.Object

org.seasar.doma.jdbc.builder.MapBatchInsertBuilder

public class MapBatchInsertBuilder
extends java.lang.Object

A builder that builds SQL INSERT statements from maps for a batch execution.

This is not thread safe.

Java

 MapBatchInsertBuilder builder = MapBatchInsertBuilder.newInstance(config, "Emp");
 builder.batchSize(10);
 builder.execute(new ArrayList<Map<String, Object>>() {
     {
         add(new LinkedHashMap<String, Object>() {
             {
                 put("name", "SMITH");
                 put("salary", 1000);
             }
         });
         add(new LinkedHashMap<String, Object>() {
             {
                 put("name", "ALLEN");
                 put("salary", 2000);
             }
         });
     }
 });
 

built SQLs

 insert into Emp
 (name, salary)
 values('SMITH', 1000)

 insert into Emp
 (name, salary)
 values('ALLEN', 2000)
 

Method Summary

Modifier and Type	Method and Description
void	batchSize(int batchSize) Sets the batch size.
void	callerClassName(java.lang.String className) Sets the caller class name.
void	callerMethodName(java.lang.String methodName) Sets the caller method name.
int[]	execute(java.lang.Iterable<? extends java.util.Map<java.lang.String,java.lang.Object>> parameter) Executes SQL INSERT statements.
java.util.List<? extends Sql<?>>	getSqls() Returns the built SQL.
static MapBatchInsertBuilder	newInstance(Config config, java.lang.String tableName) Creates a new instance.
void	queryTimeout(int queryTimeout) Sets the query timeout limit in seconds.
void	sqlLogType(SqlLogType sqlLogType) Sets the SQL log format.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static MapBatchInsertBuilder newInstance(Config config,
                                                java.lang.String tableName)

Creates a new instance.

Parameters:

config - the configuration

tableName - the table name

Returns:

a builder

Throws:

DomaNullPointerException - if config or tableName is null

execute

public int[] execute(java.lang.Iterable<? extends java.util.Map<java.lang.String,java.lang.Object>> parameter)

Executes SQL INSERT statements.

Parameters:

parameter - the parameter

Returns:

the array whose each element contains affected rows count. The array length is equal to the parameter size.

Throws:

DomaNullPointerException - if parameter is null

DomaIllegalArgumentException - if parameter is empty

UniqueConstraintException - if an unique constraint violation occurs

JdbcException - if a JDBC related error occurs

queryTimeout

public void queryTimeout(int queryTimeout)

Sets the query timeout limit in seconds.

If not specified, the value of Config.getQueryTimeout() is used.

Parameters:

queryTimeout - the query timeout limit in seconds

See Also:

Statement.setQueryTimeout(int)

sqlLogType

public void sqlLogType(SqlLogType sqlLogType)

Sets the SQL log format.

Parameters:

sqlLogType - the SQL log format type

batchSize

public void batchSize(int batchSize)

Sets the batch size.

If not specified, the value of Config.getBatchSize() is used.

Parameters:

batchSize - the batch size

callerClassName

public void callerClassName(java.lang.String className)

Sets the caller class name.

If not specified, the class name of this instance is used.

Parameters:

className - the caller class name

Throws:

DomaNullPointerException - if className is null

callerMethodName

public void callerMethodName(java.lang.String methodName)

Sets the caller method name.

if not specified, execute is used.

Parameters:

methodName - the caller method name

Throws:

DomaNullPointerException - if methodName is null

getSqls

public java.util.List<? extends Sql<?>> getSqls()

Returns the built SQL.

Returns:

the built SQL