org.jberet.support.io

Class JdbcItemWriter

java.lang.Object

org.jberet.support.io.ItemReaderWriterBase

org.jberet.support.io.JsonItemReaderWriterBase

org.jberet.support.io.JdbcItemReaderWriterBase

org.jberet.support.io.JdbcItemWriter

All Implemented Interfaces:

javax.batch.api.chunk.ItemWriter

@Named
 @Dependent
public class JdbcItemWriter
extends JdbcItemReaderWriterBase
implements javax.batch.api.chunk.ItemWriter

An implementation of javax.batch.api.chunk.ItemWriter that inserts data items into the target database.

Since:

1.1.0

See Also:

JdbcItemReader, JdbcItemReaderWriterBase

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	parameterNames String keys used to retrieve values from incoming data and apply to SQL insert statement parameters.
protected String[]	parameterTypes Tells this class which PreparedStatement setter method to call to set insert statement parameters.

Fields inherited from class org.jberet.support.io.JdbcItemReaderWriterBase

beanType, dataSource, dataSourceLookup, password, preparedStatement, properties, sql, url, user

Fields inherited from class org.jberet.support.io.JsonItemReaderWriterBase

customDataTypeModules, customDeserializers, customSerializers, deserializationFeatures, jsonFactory, jsonFactoryFeatures, jsonFactoryLookup, mapperFeatures, objectMapper, serializationFeatures

Fields inherited from class org.jberet.support.io.ItemReaderWriterBase

NEW_LINE, resource, skipBeanValidation

Constructor Summary

Constructors

Constructor and Description
JdbcItemWriter()

Method Summary

Modifier and Type	Method and Description
Serializable	checkpointInfo()
void	close()
void	open(Serializable checkpoint)
void	writeItems(List<Object> items)

Methods inherited from class org.jberet.support.io.JdbcItemReaderWriterBase

close, getConnection, init

Methods inherited from class org.jberet.support.io.JsonItemReaderWriterBase

initJsonFactory, initJsonFactoryAndObjectMapper, registerModule

Methods inherited from class org.jberet.support.io.ItemReaderWriterBase

getInputStream, getOutputStream, getValidator, validate

Methods inherited from class java.lang.Object

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

Field Detail

parameterNames

@Inject
protected String[] parameterNames

String keys used to retrieve values from incoming data and apply to SQL insert statement parameters. It should have the same length and order as SQL insert statement parameters. Optional property and if not set, it is initialized from the columns part of SQL insert statement. This property is not used when JdbcItemReaderWriterBase.beanType is java.util.List, which assumes that incoming data is already in the same order as SQL parameters.

If JdbcItemReaderWriterBase.beanType is java.util.Map, and any of its key is different than the target table column names, parameterNames should be specified. For example, if an incoming data item is:

{"name" = "Jon", "address" = "1 Main st", "age" = 30}

And JdbcItemReaderWriterBase.sql is

INSERT INTO PERSON(NAME, ADDRESS, AGE) VALUES(?, ?, ?)

then parameterNames should be specified as follows in job xml:

"name, address, age"

If JdbcItemReaderWriterBase.beanType is custom bean type, custom mapping may be achieved with either parameterNames, or in bean class with annotations, e.g., JAXB or Jackson annotations. If the bean class does not contain field mapping, or the field mapping is intended for other part of the application (e.g., ItemReader), parameterNames can be used to customize mapping.

parameterTypes

@Inject
protected String[] parameterTypes

Tells this class which PreparedStatement setter method to call to set insert statement parameters. It should have the same length and order as SQL insert statement parameters. Optional property, and if not set, this class calls PreparedStatement.setObject(int, Object) for all parameters. For example, this property can be configured as follows in job xml:

"String, String, Int"

And this class will call PreparedStatement.setString(int, String), PreparedStatement.setString(int, String), and PreparedStatement.setInt(int, int).

Note that the value of this property is case sensitive.

Constructor Detail

JdbcItemWriter

public JdbcItemWriter()

Method Detail

writeItems

public void writeItems(List<Object> items)
                throws Exception

Specified by:

writeItems in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception

open

public void open(Serializable checkpoint)
          throws Exception

Specified by:

open in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception

checkpointInfo

public Serializable checkpointInfo()
                            throws Exception

Specified by:

checkpointInfo in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception