Package org.dbunit.dataset.excel

Class XlsDataSet

java.lang.Object

org.dbunit.dataset.AbstractDataSet

org.dbunit.dataset.excel.XlsDataSet

All Implemented Interfaces:

IDataSet

public class XlsDataSet
extends AbstractDataSet

This dataset implementation can read and write MS Excel documents. Each sheet represents a table. The first row of a sheet defines the columns names and remaining rows contains the data.

Since:

Feb 21, 2003

Version:

$Revision$

Author:

Manuel Laflamme

Field Summary

Fields inherited from class org.dbunit.dataset.AbstractDataSet

_orderedTableNameMap

Constructor Summary

Constructors

Constructor	Description
XlsDataSet(File file)	Creates a new XlsDataSet object that loads the specified Excel document.
XlsDataSet(InputStream in)	Creates a new XlsDataSet object that loads the specified Excel document.

Method Summary

Modifier and Type	Method	Description
protected ITableIterator	createIterator(boolean reversed)	Creates an iterator which provides access to all tables of this dataset
static void	write(IDataSet dataSet, OutputStream out)	Write the specified dataset to the specified Excel document.

Methods inherited from class org.dbunit.dataset.AbstractDataSet

createTableNameMap, getTable, getTableMetaData, getTableNames, getTables, initialize, isCaseSensitiveTableNames, iterator, reverseIterator, toString

Methods inherited from class java.lang.Object

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

Constructor Details

XlsDataSet

public XlsDataSet(File file)
           throws IOException,
DataSetException

Creates a new XlsDataSet object that loads the specified Excel document.

Parameters:

file - the Excel document to load.

Throws:

IOException - if the file cannot be read.

DataSetException - if the document cannot be parsed.

XlsDataSet

public XlsDataSet(InputStream in)
           throws IOException,
DataSetException

Creates a new XlsDataSet object that loads the specified Excel document.

Parameters:

in - the Excel document to load.

Throws:

IOException - if the stream cannot be read.

DataSetException - if the document cannot be parsed.

Method Details

write

public static void write(IDataSet dataSet,
 OutputStream out)
                  throws IOException,
DataSetException

Write the specified dataset to the specified Excel document.

Parameters:

dataSet - the dataset to write.

out - the stream to write the Excel document to.

Throws:

IOException - if writing to the stream fails.

DataSetException - if the dataset cannot be read.

createIterator

protected ITableIterator createIterator(boolean reversed)
                                 throws DataSetException

Description copied from class: AbstractDataSet

Creates an iterator which provides access to all tables of this dataset

Specified by:

createIterator in class AbstractDataSet

Parameters:

reversed - Whether the created iterator should be a reversed one or not

Returns:

The created ITableIterator

Throws:

DataSetException - if the iterator cannot be created.