FlatXmlDataSet (dbUnit Extension 2.4.9 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.dbunit.dataset.xml
Class FlatXmlDataSet

java.lang.Object
  org.dbunit.dataset.AbstractDataSet
      org.dbunit.dataset.CachedDataSet
          org.dbunit.dataset.xml.FlatXmlDataSet

All Implemented Interfaces:: IDataSet, IDataSetConsumer

public class FlatXmlDataSet
extends CachedDataSet
extends CachedDataSet

Reads and writes flat XML dataset document. Each XML element corresponds to a table row. Each XML element name corresponds to a table name. The XML attributes correspond to table columns.

Flat XML dataset document sample:

 <!DOCTYPE dataset SYSTEM "my-dataset.dtd">
 <dataset>
     <TEST_TABLE COL0="row 0 col 0"
         COL1="row 0 col 1"
         COL2="row 0 col 2"/>
     <TEST_TABLE COL1="row 1 col 1"/>
     <SECOND_TABLE COL0="row 0 col 0"
           COL1="row 0 col 1" />
     <EMPTY_TABLE/>
 </dataset>

To specify null values, omit corresponding attribute. In the above example, missing COL0 and COL2 attributes of TEST_TABLE second row represents null values.

Table metadata is deduced from the first row of each table by default. Beware that DbUnit may think a table misses some columns if the first row of that table has one or more null values. You can do one of the following things to avoid this:

Use a DTD. DbUnit will use the columns declared in the DTD as table metadata. DbUnit only supports external system URI. The URI can be absolute or relative.

Since DBUnit 2.3.0 there is a functionality called "column sensing" which basically reads in the whole XML into a buffer and dynamically adds new columns as they appear. It can be used as demonstrated in the following example:

   // since dbunit 2.4.7
   FlatXmlDataSetBuilder builder = new FlatXmlDataSetBuilder();
   builder.setInputSource(new File("src/xml/flatXmlTableTest.xml"));
   builder.setColumnSensing(true);
   IDataSet dataSet = builder.build();
   
   // or dbunit release <= 2.4.6:
   boolean enableColumnSensing = true;
   IDataSet dataSet = new FlatXmlDataSet(
            new File("src/xml/flatXmlTableTest.xml"), false, enableColumnSensing);

Since:: 1.0 (Mar 12, 2002)
Version:: $Revision: 1048 $ $Date: 2009-09-26 11:21:40 -0500 (Sat, 26 Sep 2009) $
Author:: Manuel Laflamme, gommma (gommma AT users.sourceforge.net), Last changed by: $Author: gommma $

Field Summary

Fields inherited from class org.dbunit.dataset.AbstractDataSet
`_orderedTableNameMap`

Constructor Summary
`FlatXmlDataSet(File xmlFile)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(File xmlFile, boolean dtdMetadata)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(File xmlFile, boolean dtdMetadata, boolean columnSensing)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(File xmlFile, boolean dtdMetadata, boolean columnSensing, boolean caseSensitiveTableNames)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(FlatXmlProducer flatXmlProducer)` Creates a new `FlatXmlDataSet` with the data of the given producer.
`FlatXmlDataSet(InputSource source)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(InputStream xmlStream)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(InputStream xmlStream, boolean dtdMetadata)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(InputStream xmlStream, IDataSet metaDataSet)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(InputStream xmlStream, InputStream dtdStream)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(Reader xmlReader)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(Reader xmlReader, boolean dtdMetadata)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(Reader xmlReader, boolean dtdMetadata, boolean columnSensing, boolean caseSensitiveTableNames)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(Reader xmlReader, IDataSet metaDataSet)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(Reader xmlReader, Reader dtdReader)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(URL xmlUrl)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(URL xmlUrl, boolean dtdMetadata)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(URL xmlUrl, boolean dtdMetadata, boolean columnSensing)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`
`FlatXmlDataSet(URL xmlUrl, boolean dtdMetadata, boolean columnSensing, boolean caseSensitiveTableNames)` Deprecated. since 2.4.7 - use `FlatXmlDataSetBuilder` to create a `FlatXmlDataSet`

Method Summary
`static void`	`write(IDataSet dataSet, OutputStream out)` Write the specified dataset to the specified output stream as xml.
`static void`	`write(IDataSet dataSet, Writer writer)` Write the specified dataset to the specified writer as xml.
`static void`	`write(IDataSet dataSet, Writer writer, String encoding)` Write the specified dataset to the specified writer as xml.
`static void`	`writeDtd(IDataSet dataSet, OutputStream out)` Deprecated. use `FlatDtdDataSet.write(org.dbunit.dataset.IDataSet, java.io.OutputStream)`

Methods inherited from class org.dbunit.dataset.CachedDataSet
`createIterator, endDataSet, endTable, row, startDataSet, startTable`

Methods inherited from class org.dbunit.dataset.AbstractDataSet
`createTableNameMap, getTable, getTableMetaData, getTableNames, getTables, isCaseSensitiveTableNames, iterator, reverseIterator, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

FlatXmlDataSet

public FlatXmlDataSet(FlatXmlProducer flatXmlProducer)
               throws DataSetException

Creates a new FlatXmlDataSet with the data of the given producer.

Parameters:: flatXmlProducer - The producer that provides the FlatXmlDataSet content
Throws:: DataSetException
Since:: 2.4.7