|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.springframework.batch.item.util.ExecutionContextUserSupport
org.springframework.batch.item.xml.StaxEventItemWriter<T>
public class StaxEventItemWriter<T>
An implementation of ItemWriter which uses StAX and
Marshaller for serializing object to XML.
This item writer also provides restart, statistics and transaction features
by implementing corresponding interfaces.
The implementation is *not* thread-safe.
| Constructor Summary | |
|---|---|
StaxEventItemWriter()
|
|
| Method Summary | |
|---|---|
void |
afterPropertiesSet()
|
void |
close()
Flush and close the output source. |
protected void |
endDocument(javax.xml.stream.XMLEventWriter writer)
Writes the EndDocument tag manually. |
java.lang.String |
getEncoding()
Get used encoding. |
java.util.Map<java.lang.String,java.lang.String> |
getRootElementAttributes()
Get attributes of the root element. |
java.lang.String |
getRootTagName()
Get the tag name of the root element. |
java.lang.String |
getVersion()
Get XML version. |
void |
open(ExecutionContext executionContext)
Open the output source |
void |
setEncoding(java.lang.String encoding)
Set encoding to be used for output file. |
void |
setFooterCallback(StaxWriterCallback footerCallback)
footerCallback is called after writing all items but before closing the file |
void |
setHeaderCallback(StaxWriterCallback headerCallback)
headerCallback is called before writing any items. |
void |
setMarshaller(org.springframework.oxm.Marshaller marshaller)
Set Object to XML marshaller. |
void |
setOverwriteOutput(boolean overwriteOutput)
Set "overwrite" flag for the output file. |
void |
setResource(org.springframework.core.io.Resource resource)
Set output file. |
void |
setRootElementAttributes(java.util.Map<java.lang.String,java.lang.String> rootElementAttributes)
Set the root element attributes to be written. |
void |
setRootTagName(java.lang.String rootTagName)
Set the tag name of the root element. |
void |
setSaveState(boolean saveState)
|
void |
setVersion(java.lang.String version)
Set XML version to be used for output XML. |
protected void |
startDocument(javax.xml.stream.XMLEventWriter writer)
Writes simple XML header containing: xml declaration - defines encoding and XML version opening tag of the root element and its attributes If this is not sufficient for you, simply override this method. |
void |
update(ExecutionContext executionContext)
Get the restart data. |
void |
write(java.util.List<? extends T> items)
Write the value objects and flush them to the file. |
| Methods inherited from class org.springframework.batch.item.util.ExecutionContextUserSupport |
|---|
getKey, getName, setName |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public StaxEventItemWriter()
| Method Detail |
|---|
public void setResource(org.springframework.core.io.Resource resource)
setResource in interface ResourceAwareItemWriterItemStream<T>resource - the output filepublic void setMarshaller(org.springframework.oxm.Marshaller marshaller)
marshaller - the Object to XML marshallerpublic void setHeaderCallback(StaxWriterCallback headerCallback)
public void setFooterCallback(StaxWriterCallback footerCallback)
public java.lang.String getEncoding()
public void setEncoding(java.lang.String encoding)
encoding - the encoding to be usedpublic java.lang.String getVersion()
public void setVersion(java.lang.String version)
version - the XML version to be usedpublic java.lang.String getRootTagName()
public void setRootTagName(java.lang.String rootTagName)
rootTagName - the tag name to be used for the root elementpublic java.util.Map<java.lang.String,java.lang.String> getRootElementAttributes()
public void setRootElementAttributes(java.util.Map<java.lang.String,java.lang.String> rootElementAttributes)
rootElementAttributes - attributes of the root elementpublic void setOverwriteOutput(boolean overwriteOutput)
overwriteOutput - public void setSaveState(boolean saveState)
public void afterPropertiesSet()
throws java.lang.Exception
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBeanjava.lang.ExceptionInitializingBean.afterPropertiesSet()public void open(ExecutionContext executionContext)
open in interface ItemStreamItemStream.open(ExecutionContext)
protected void startDocument(javax.xml.stream.XMLEventWriter writer)
throws javax.xml.stream.XMLStreamException
writer - XML event writer
javax.xml.stream.XMLStreamException
protected void endDocument(javax.xml.stream.XMLEventWriter writer)
throws javax.xml.stream.XMLStreamException
writer - XML event writer
javax.xml.stream.XMLStreamExceptionpublic void close()
close in interface ItemStreamItemStream.close()
public void write(java.util.List<? extends T> items)
throws org.springframework.oxm.XmlMappingException,
java.io.IOException
write in interface ItemWriter<T>items - the value object
java.io.IOException
org.springframework.oxm.XmlMappingExceptionpublic void update(ExecutionContext executionContext)
update in interface ItemStreamexecutionContext - to be updatedItemStream.update(ExecutionContext)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||