com.helger.photon.exchange.bulkexport.format

Class ExporterXML

java.lang.Object

com.helger.photon.exchange.bulkexport.format.ExporterXML

All Implemented Interfaces:

IExporter, IExporterFile

@NotThreadSafe
public class ExporterXML
extends Object
implements IExporterFile

Implementation of IExporterFile for XML files

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_EMIT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
ExporterXML()

Method Summary

Modifier and Type	Method and Description
com.helger.xml.microdom.IMicroDocument	convertRecords(IExportRecordProvider aProvider)
com.helger.commons.state.ESuccess	exportRecords(IExportRecordProvider aProvider, OutputStream aOS) Export all provided records to an output stream.
Charset	getCharset()
EExchangeFileType	getFileType()
com.helger.xml.serialize.write.XMLWriterSettings	getXMLWriterSettings()
ExporterXML	setCharset(Charset aCharset)
ExporterXML	setEmitTypeAttr(boolean bEmitTypeAttr)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EMIT_TYPE_ATTRIBUTE

public static final boolean DEFAULT_EMIT_TYPE_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

ExporterXML

public ExporterXML()

Method Detail

setCharset

@Nonnull
public ExporterXML setCharset(@Nonnull
                                        Charset aCharset)

getCharset

@Nonnull
public Charset getCharset()

getXMLWriterSettings

@Nonnull
 @ReturnsMutableObject(value="Design")
public com.helger.xml.serialize.write.XMLWriterSettings getXMLWriterSettings()

setEmitTypeAttr

@Nonnull
public ExporterXML setEmitTypeAttr(boolean bEmitTypeAttr)

convertRecords

@Nullable
public com.helger.xml.microdom.IMicroDocument convertRecords(@Nonnull
                                                                        IExportRecordProvider aProvider)

exportRecords

@Nonnull
public com.helger.commons.state.ESuccess exportRecords(@Nonnull
                                                                 IExportRecordProvider aProvider,
                                                                 @Nonnull @WillClose
                                                                 OutputStream aOS)

Description copied from interface: IExporter

Export all provided records to an output stream.

Specified by:

exportRecords in interface IExporter

Parameters:

aProvider - The provider for all records. May not be null.

aOS - The output stream to write to. Will be closed automatically in any case. May not be null.

Returns:

ESuccess.SUCCESS if at lease one record was provided and saving was successful.

getFileType

@Nonnull
public EExchangeFileType getFileType()

Specified by:

getFileType in interface IExporterFile

Returns:

The file type for export.