Package org.dbunit.dataset.xml

Class XmlDataSetWriter

java.lang.Object
org.dbunit.dataset.xml.XmlDataSetWriter
All Implemented Interfaces:
IDataSetConsumer
public class XmlDataSetWriter extends Object implements IDataSetConsumer
Since:
1.5.5 (Jun 13, 2003)
Version:
$Revision$ $Date$
Author:
Manuel Laflamme, Last changed by: $Author$

  • Constructor Details

    • XmlDataSetWriter

      public XmlDataSetWriter(OutputStream outputStream, Charset charset)
      Parameters:
      outputStream - The stream to which the XML will be written.
      encoding - The encoding to be used for the XmlWriter. Can be null. See
      invalid reference 
      XmlWriter#XmlWriter(OutputStream, String)
      .
      Throws:
      UnsupportedEncodingException

    • XmlDataSetWriter

      public XmlDataSetWriter(Writer writer)

    • XmlDataSetWriter

      public XmlDataSetWriter(Writer writer, Charset charset)

  • Method Details

    • setPrettyPrint

      public void setPrettyPrint(boolean enabled)
      Enable or disable pretty print of the XML.
      Parameters:
      enabled - true to enable pretty print (which is the default). false otherwise.
      Since:
      2.4

    • setIncludeColumnComments

      public void setIncludeColumnComments(boolean includeColumnComments)
      Whether or not to write the column name as comment into the XML
      Parameters:
      includeColumnComments - Whether or not to write the column name as comment into the XML

    • write

      public void write(IDataSet dataSet) throws DataSetException
      Writes the given IDataSet using this writer.
      Parameters:
      dataSet - The IDataSet to be written
      Throws:
      DataSetException

    • startDataSet

      public void startDataSet() throws DataSetException
      Description copied from interface: IDataSetConsumer
      Receive notification of the beginning of a dataset. This method is invoked only once, before any other methods in this interface.
      Specified by:
      startDataSet in interface IDataSetConsumer
      Throws:
      DataSetException

    • endDataSet

      public void endDataSet() throws DataSetException
      Description copied from interface: IDataSetConsumer
      Receive notification of the end of a dataset. This method is invoked only once, and it will be the last method invoked in this interface.
      Specified by:
      endDataSet in interface IDataSetConsumer
      Throws:
      DataSetException

    • startTable

      public void startTable(ITableMetaData metaData) throws DataSetException
      Description copied from interface: IDataSetConsumer
      Receive notification of the beginning of a table. This method is invoked at the beginning of every table in the dataset; there will be a corresponding IDataSetConsumer.endDataSet() event for every startTable event (even when the table is empty).
      Specified by:
      startTable in interface IDataSetConsumer
      Parameters:
      metaData - the table metadata
      Throws:
      DataSetException

    • endTable

      public void endTable() throws DataSetException
      Description copied from interface: IDataSetConsumer
      Receive notification of the end of a table.
      Specified by:
      endTable in interface IDataSetConsumer
      Throws:
      DataSetException

    • row

      public void row(Object[] values) throws DataSetException
      Description copied from interface: IDataSetConsumer
      Receive notification of a table row. This method is invoked to report each row of a table.
      Specified by:
      row in interface IDataSetConsumer
      Parameters:
      values - The row values.
      Throws:
      DataSetException

    • writeValueCData

      protected void writeValueCData(String stringValue) throws IOException
      Writes the given String as CDATA using the XmlWriter. Can be overridden to add custom behavior. This implementation just invokes XmlWriter.writeCData(String)
      Parameters:
      stringValue - The value to be written
      Throws:
      IOException
      Since:
      2.4.4

    • writeValue

      protected void writeValue(String stringValue) throws IOException
      Writes the given String as normal text using the XmlWriter. Can be overridden to add custom behavior. This implementation just invokes XmlWriter.writeText(String).
      Parameters:
      stringValue - The value to be written
      Throws:
      IOException
      Since:
      2.4.4

    • getXmlWriter

      protected final XmlWriter getXmlWriter()
      Returns:
      The XmlWriter that is used for writing out XML.
      Since:
      2.4.4