org.apache.ddlutils.io

Class DataWriter

java.lang.Object

org.apache.ddlutils.io.PrettyPrintingXmlWriter

org.apache.ddlutils.io.DataWriter

public class DataWriter
extends PrettyPrintingXmlWriter

Writes dyna beans matching a specified database model into an XML file.

Constructor Summary

Constructors

Constructor and Description
DataWriter(OutputStream output) Creates a data writer instance using UTF-8 encoding.
DataWriter(OutputStream output, String encoding) Creates a data writer instance.
DataWriter(Writer output, String encoding) Creates a data writer instance using the specified writer.

Method Summary

Methods

Modifier and Type	Method and Description
ConverterConfiguration	getConverterConfiguration() Returns the converter configuration of this data reader.
protected void	throwException(Exception baseEx) Rethrows the given exception, wrapped in a DdlUtilsXMLException.
void	write(Collection beans) Writes the beans contained in the given collection.
void	write(Iterator beans) Writes the beans contained in the given iterator.
void	write(SqlDynaBean bean) Writes the given bean.
void	writeDocumentEnd() Writes the end of the XML document, including the end of the outermost XML element (data).
void	writeDocumentStart() Writes the start of the XML document, including the start of the outermost XML element (data).

Methods inherited from class org.apache.ddlutils.io.PrettyPrintingXmlWriter

getEncoding, indentIfPrettyPrinting, isPrettyPrinting, printlnIfPrettyPrinting, setDefaultNamespace, setPrettyPrinting, writeAttribute, writeCData, writeCharacters, writeElementEnd, writeElementStart, writeNamespace

Methods inherited from class java.lang.Object

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

Constructor Detail

DataWriter

public DataWriter(OutputStream output)
           throws DataWriterException

Creates a data writer instance using UTF-8 encoding.

Parameters:

output - The target to write the data XML to

Throws:

DataWriterException

DataWriter

public DataWriter(OutputStream output,
          String encoding)
           throws DataWriterException

Creates a data writer instance.

Parameters:

output - The target to write the data XML to

encoding - The encoding of the XML file

Throws:

DataWriterException

DataWriter

public DataWriter(Writer output,
          String encoding)
           throws DataWriterException

Creates a data writer instance using the specified writer. Note that the writer needs to be configured using the specified encoding.

Parameters:

output - The target to write the data XML to

encoding - The encoding of the writer

Throws:

DataWriterException

Method Detail

throwException

protected void throwException(Exception baseEx)
                       throws DdlUtilsXMLException

Rethrows the given exception, wrapped in a DdlUtilsXMLException. This method allows subclasses to throw their own subclasses of this exception.

Overrides:

throwException in class PrettyPrintingXmlWriter

Parameters:

baseEx - The original exception

Throws:

DdlUtilsXMLException - The wrapped exception

getConverterConfiguration

public ConverterConfiguration getConverterConfiguration()

Returns the converter configuration of this data reader.

Returns:

The converter configuration

writeDocumentStart

public void writeDocumentStart()
                        throws DdlUtilsXMLException

Writes the start of the XML document, including the start of the outermost XML element (data).

Overrides:

writeDocumentStart in class PrettyPrintingXmlWriter

Throws:

DdlUtilsXMLException

writeDocumentEnd

public void writeDocumentEnd()
                      throws DdlUtilsXMLException

Writes the end of the XML document, including the end of the outermost XML element (data).

Overrides:

writeDocumentEnd in class PrettyPrintingXmlWriter

Throws:

DdlUtilsXMLException

write

public void write(SqlDynaBean bean)
           throws DataWriterException

Writes the given bean.

Parameters:

bean - The bean to write

Throws:

DataWriterException

write

public void write(Iterator beans)
           throws DataWriterException

Writes the beans contained in the given iterator.

Parameters:

beans - The beans iterator

Throws:

DataWriterException

write

public void write(Collection beans)
           throws DataWriterException

Writes the beans contained in the given collection.

Parameters:

beans - The beans

Throws:

DataWriterException