public class StaxEventItemWriter<T> extends AbstractItemStreamItemWriter<T> implements ResourceAwareItemWriterItemStream<T>, org.springframework.beans.factory.InitializingBean
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 and Description |
---|
StaxEventItemWriter() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet() |
void |
close()
Flush and close the output source.
|
protected Result |
createStaxResult()
Subclasses can override to customize the stax result.
|
protected XMLEventFactory |
createXmlEventFactory()
Subclasses can override to customize the event factory.
|
protected XMLEventWriter |
createXmlEventWriter(XMLOutputFactory outputFactory,
Writer writer)
Subclasses can override to customize the writer.
|
protected XMLOutputFactory |
createXmlOutputFactory()
Subclasses can override to customize the factory.
|
protected void |
endDocument(XMLEventWriter writer)
Writes the EndDocument tag manually.
|
String |
getEncoding()
Get used encoding.
|
Map<String,String> |
getRootElementAttributes()
Get attributes of the root element.
|
String |
getRootTagName()
Get the tag name of the root element.
|
String |
getRootTagNamespace()
Get the namespace of the root element.
|
String |
getRootTagNamespacePrefix()
Get the namespace prefix of the root element.
|
String |
getVersion()
Get XML version.
|
protected void |
initNamespaceContext(XMLEventWriter writer)
Inits the namespace context of the XMLEventWriter:
rootTagNamespacePrefix for rootTagName
any other xmlns namespace prefix declarations in the root element attributes
|
void |
open(ExecutionContext executionContext)
Open the output source
|
void |
setEncoding(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 |
setForceSync(boolean forceSync)
Flag to indicate that changes should be force-synced to disk on flush.
|
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(Map<String,String> rootElementAttributes)
Set the root element attributes to be written.
|
void |
setRootTagName(String rootTagName)
Set the tag name of the root element.
|
void |
setSaveState(boolean saveState) |
void |
setShouldDeleteIfEmpty(boolean shouldDeleteIfEmpty)
Flag to indicate that the target file should be deleted if no items have
been written (other than header and footer) on close.
|
void |
setTransactional(boolean transactional)
Flag to indicate that writes should be deferred to the end of a
transaction if present.
|
void |
setVersion(String version)
Set XML version to be used for output XML.
|
protected void |
startDocument(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(List<? extends T> items)
Write the value objects and flush them to the file.
|
getExecutionContextKey, setExecutionContextName, setName
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 void setTransactional(boolean transactional)
transactional
- the flag to setpublic void setForceSync(boolean forceSync)
forceSync
- the flag value to setpublic void setShouldDeleteIfEmpty(boolean shouldDeleteIfEmpty)
shouldDeleteIfEmpty
- the flag value to setpublic String getEncoding()
public void setEncoding(String encoding)
encoding
- the encoding to be usedpublic String getVersion()
public void setVersion(String version)
version
- the XML version to be usedpublic String getRootTagName()
public void setRootTagName(String rootTagName)
{uri}prefix:rootThe prefix is optional (defaults to empty), but if it is specified then the uri must be provided. In addition you might want to declare other namespaces using the
root
attributes
.rootTagName
- the tag name to be used for the root elementpublic String getRootTagNamespacePrefix()
public String getRootTagNamespace()
public Map<String,String> getRootElementAttributes()
public void setRootElementAttributes(Map<String,String> rootElementAttributes)
rootElementAttributes
- attributes of the root elementpublic void setOverwriteOutput(boolean overwriteOutput)
overwriteOutput
- public void setSaveState(boolean saveState)
public void afterPropertiesSet() throws Exception
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
Exception
InitializingBean.afterPropertiesSet()
public void open(ExecutionContext executionContext)
open
in interface ItemStream
open
in class ItemStreamSupport
ItemStream.open(ExecutionContext)
protected XMLEventWriter createXmlEventWriter(XMLOutputFactory outputFactory, Writer writer) throws XMLStreamException
outputFactory
- writer
- XMLStreamException
protected XMLOutputFactory createXmlOutputFactory() throws FactoryConfigurationError
FactoryConfigurationError
protected XMLEventFactory createXmlEventFactory() throws FactoryConfigurationError
FactoryConfigurationError
protected Result createStaxResult() throws Exception
Exception
protected void initNamespaceContext(XMLEventWriter writer) throws XMLStreamException
writer
- XML event writerXMLStreamException
protected void startDocument(XMLEventWriter writer) throws XMLStreamException
writer
- XML event writerXMLStreamException
protected void endDocument(XMLEventWriter writer) throws XMLStreamException
writer
- XML event writerXMLStreamException
public void close()
close
in interface ItemStream
close
in class ItemStreamSupport
ItemStream.close()
public void write(List<? extends T> items) throws org.springframework.oxm.XmlMappingException, Exception
write
in interface ItemWriter<T>
items
- the value objectIOException
org.springframework.oxm.XmlMappingException
Exception
- if there are errors. The framework will catch the
exception and convert or rethrow it as appropriate.public void update(ExecutionContext executionContext)
update
in interface ItemStream
update
in class ItemStreamSupport
executionContext
- to be updatedItemStream.update(ExecutionContext)
Copyright © 2014 Pivotal. All rights reserved.