Package 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	Description
static final String	ATTR_TYPE
static final boolean	DEFAULT_EMIT_TYPE_ATTRIBUTE
static final String	ELEMENT_BODY
static final String	ELEMENT_FIELD
static final String	ELEMENT_FOOTER
static final String	ELEMENT_HEADER
static final String	ELEMENT_RECORD
static final String	ELEMENT_ROOT

Constructor Summary

Constructors

Constructor	Description
ExporterXML()

Method Summary

Modifier and Type	Method	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.
final Charset	getCharset()
final EExchangeFileType	getFileType()
final com.helger.xml.serialize.write.IXMLWriterSettings	getXMLWriterSettings()
final boolean	isEmitTypeAttr()
final ExporterXML	setCharset(Charset aCharset)
final ExporterXML	setEmitTypeAttr(boolean bEmitTypeAttr)
final com.helger.xml.serialize.write.XMLWriterSettings	xmlWriterSettings()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_EMIT_TYPE_ATTRIBUTE

public static final boolean DEFAULT_EMIT_TYPE_ATTRIBUTE

See Also:

• Constant Field Values

ELEMENT_ROOT

public static final String ELEMENT_ROOT

See Also:

• Constant Field Values

ELEMENT_HEADER

public static final String ELEMENT_HEADER

See Also:

• Constant Field Values

ELEMENT_BODY

public static final String ELEMENT_BODY

See Also:

• Constant Field Values

ELEMENT_FOOTER

public static final String ELEMENT_FOOTER

See Also:

• Constant Field Values

ELEMENT_RECORD

public static final String ELEMENT_RECORD

See Also:

• Constant Field Values

ELEMENT_FIELD

public static final String ELEMENT_FIELD

See Also:

• Constant Field Values

ATTR_TYPE

public static final String ATTR_TYPE

See Also:

• Constant Field Values

Constructor Details

ExporterXML

public ExporterXML()

Method Details

getFileType

@Nonnull
public final EExchangeFileType getFileType()

Specified by:

getFileType in interface IExporterFile

Returns:

The file type for export.

getCharset

@Nonnull
public final Charset getCharset()

setCharset

@Nonnull
public final ExporterXML setCharset(@Nonnull
 Charset aCharset)

xmlWriterSettings

@Nonnull
@ReturnsMutableObject
public final com.helger.xml.serialize.write.XMLWriterSettings xmlWriterSettings()

getXMLWriterSettings

@Nonnull
@ReturnsImmutableObject
public final com.helger.xml.serialize.write.IXMLWriterSettings getXMLWriterSettings()

isEmitTypeAttr

public final boolean isEmitTypeAttr()

setEmitTypeAttr

@Nonnull
public final 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.