org.jberet.support.io

Class XmlItemReader

java.lang.Object

org.jberet.support.io.ItemReaderWriterBase

org.jberet.support.io.XmlItemReaderWriterBase

org.jberet.support.io.XmlItemReader

All Implemented Interfaces:

javax.batch.api.chunk.ItemReader

@Named
 @Dependent
public class XmlItemReader
extends XmlItemReaderWriterBase
implements javax.batch.api.chunk.ItemReader

An implementation of javax.batch.api.chunk.ItemReader that reads a collection of data from XML resource. Users of this class should provide a bean class that represents individual data item in the source XML, and the readItem() method reads one item at a time and binds it to the provided bean type.

Since:

1.0.2

See Also:

XmlItemWriter, XmlItemReaderWriterBase

Field Summary

Fields

Modifier and Type	Field and Description
protected Class	beanType The bean class that represents individual data item in the ItemReaderWriterBase.resource XML, and the readItem() method reads one item at a time and binds it to the provided bean type.
protected int	end Specify the end position in the data set (inclusive).
protected Class	inputDecorator Fully-qualified name of a class implementing com.fasterxml.jackson.core.io.InputDecorator, which can be used to decorate input sources.
protected int	start Specifies the start position (a positive integer starting from 1) to read the data.
protected String	xmlTextElementName Alternate "virtual name" to use for XML CDATA segments; that is, text values.

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

customDataTypeModules, xmlFactory, xmlFactoryLookup, xmlMapper, xmlModule

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

NEW_LINE, resource, skipBeanValidation

Constructor Summary

Constructors

Constructor and Description
XmlItemReader()

Method Summary

Modifier and Type	Method and Description
Serializable	checkpointInfo()
void	close()
protected void	initXmlModule() Initializes XmlItemReaderWriterBase.xmlModule, if needed by job xml configuration.
void	open(Serializable checkpoint)
Object	readItem()

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

initXmlFactory

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

beanType

@Inject
protected Class beanType

The bean class that represents individual data item in the ItemReaderWriterBase.resource XML, and the readItem() method reads one item at a time and binds it to the provided bean type. Required property. For example,

• org.jberet.support.io.StockTrade
• org.jberet.support.io.Person
• my.own.custom.ItemBean

start

@Inject
protected int start

Specifies the start position (a positive integer starting from 1) to read the data. If reading from the beginning of the input XML, there is no need to specify this property.

end

@Inject
protected int end

Specify the end position in the data set (inclusive). Optional property, and defaults to Integer.MAX_VALUE. If reading till the end of the input XML, there is no need to specify this property.

inputDecorator

@Inject
protected Class inputDecorator

Fully-qualified name of a class implementing com.fasterxml.jackson.core.io.InputDecorator, which can be used to decorate input sources. Optional property, and defaults to null.

See Also:

"com.fasterxml.jackson.core.io.InputDecorator", "com.fasterxml.jackson.core.JsonFactory#setInputDecorator(com.fasterxml.jackson.core.io.InputDecorator)"

xmlTextElementName

@Inject
protected String xmlTextElementName

Alternate "virtual name" to use for XML CDATA segments; that is, text values. Optional property and defaults to null (empty String, "", is used as the virtual name).

See Also:

"com.fasterxml.jackson.dataformat.xml.JacksonXmlModule#setXMLTextElementName(java.lang.String)"

Constructor Detail

XmlItemReader

public XmlItemReader()

Method Detail

open

public void open(Serializable checkpoint)
          throws Exception

Specified by:

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

Throws:

Exception

readItem

public Object readItem()
                throws Exception

Specified by:

readItem in interface javax.batch.api.chunk.ItemReader

Throws:

Exception

checkpointInfo

public Serializable checkpointInfo()
                            throws Exception

Specified by:

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

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

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

Throws:

Exception

initXmlModule

protected void initXmlModule()

Description copied from class: XmlItemReaderWriterBase

Initializes XmlItemReaderWriterBase.xmlModule, if needed by job xml configuration.

Specified by:

initXmlModule in class XmlItemReaderWriterBase