Package org.dbunit.dataset.xml

Class FlatDtdDataSet

java.lang.Object

org.dbunit.dataset.AbstractDataSet

org.dbunit.dataset.xml.FlatDtdDataSet

All Implemented Interfaces:

IDataSet, IDataSetConsumer

public class FlatDtdDataSet
extends AbstractDataSet
implements IDataSetConsumer

IDataSet built by consuming table metadata declared in a flat DTD document.

Since:

1.0 (Apr 4, 2002)

Version:

$Revision$ $Date$

Author:

Manuel Laflamme, Last changed by: $Author$

Field Summary

Fields inherited from class org.dbunit.dataset.AbstractDataSet

_orderedTableNameMap

Constructor Summary

Constructors

Constructor	Description
FlatDtdDataSet()	Default constructor.
FlatDtdDataSet(InputStream in)	Creates a dataset from the DTD content of the given input stream.
FlatDtdDataSet(Reader reader)	Creates a dataset from the DTD content of the given reader.
FlatDtdDataSet(IDataSetProducer producer)	Creates a dataset that synchronously consumes the specified producer.

Method Summary

Modifier and Type	Method	Description
protected ITableIterator	createIterator(boolean reversed)	Creates an iterator which provides access to all tables of this dataset
void	endDataSet()	Receive notification of the end of a dataset.
void	endTable()	Receive notification of the end of a table.
ITable	getTable(String tableName)	Returns the specified table.
ITableMetaData	getTableMetaData(String tableName)	Returns the specified table metadata.
String[]	getTableNames()	Returns names of tables in this dataset in proper sequence.
protected void	initialize()	Initializes the tables of this dataset
void	row(Object[] values)	Receive notification of a table row.
void	startDataSet()	Receive notification of the beginning of a dataset.
void	startTable(ITableMetaData metaData)	Receive notification of the beginning of a table.
String	toString()
static void	write(IDataSet dataSet, OutputStream out)	Writes the specified dataset to the specified output stream as DTD, encoded in UTF-8, matching what the InputStream constructor's SAX parsing assumes absent an explicit encoding declaration.
static void	write(IDataSet dataSet, Writer out)	Write the specified dataset to the specified writer as DTD.

Methods inherited from class org.dbunit.dataset.AbstractDataSet

createTableNameMap, getTables, isCaseSensitiveTableNames, iterator, reverseIterator

Methods inherited from class java.lang.Object

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

Constructor Details

FlatDtdDataSet

public FlatDtdDataSet()

Default constructor.

FlatDtdDataSet

public FlatDtdDataSet(InputStream in)
               throws DataSetException,
IOException

Creates a dataset from the DTD content of the given input stream.

Parameters:

in - the input stream to read the DTD from.

Throws:

DataSetException - if the DTD content is invalid.

IOException - if the input stream cannot be read.

FlatDtdDataSet

public FlatDtdDataSet(Reader reader)
               throws DataSetException,
IOException

Creates a dataset from the DTD content of the given reader.

Parameters:

reader - the reader to read the DTD from.

Throws:

DataSetException - if the DTD content is invalid.

IOException - if the reader cannot be read.

FlatDtdDataSet

public FlatDtdDataSet(IDataSetProducer producer)
               throws DataSetException

Creates a dataset that synchronously consumes the specified producer.

Parameters:

producer - the producer to consume.

Throws:

DataSetException - if consuming the producer fails.

Method Details

initialize

protected void initialize()

Description copied from class: AbstractDataSet

Initializes the tables of this dataset

Overrides:

initialize in class AbstractDataSet

write

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

Writes the specified dataset to the specified output stream as DTD, encoded in UTF-8, matching what the InputStream constructor's SAX parsing assumes absent an explicit encoding declaration.

Parameters:

dataSet - the dataset to write a DTD for.

out - the stream to write to.

Throws:

IOException - if writing fails.

DataSetException - if reading the dataset fails.

See Also:

• FlatDtdWriter

write

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

Write the specified dataset to the specified writer as DTD.

Parameters:

dataSet - the dataset to write a DTD for.

out - the writer to write to.

Throws:

IOException - if writing fails.

DataSetException - if reading the dataset fails.

See Also:

• FlatDtdWriter

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.

getTableNames

public String[] getTableNames()
                       throws DataSetException

Description copied from interface: IDataSet

Returns names of tables in this dataset in proper sequence. Multiple occurrence of the same name may be returned if multiple tables having the same name are present in the dataset.

Specified by:

getTableNames in interface IDataSet

Overrides:

getTableNames in class AbstractDataSet

Returns:

the table names, in proper sequence.

Throws:

DataSetException - if the table names cannot be determined.

getTableMetaData

public ITableMetaData getTableMetaData(String tableName)
                                throws DataSetException

Description copied from interface: IDataSet

Returns the specified table metadata.

Specified by:

getTableMetaData in interface IDataSet

Overrides:

getTableMetaData in class AbstractDataSet

Parameters:

tableName - the name of the table to look up.

Returns:

the metadata of the specified table.

Throws:

DataSetException

getTable

public ITable getTable(String tableName)
                throws DataSetException

Description copied from interface: IDataSet

Returns the specified table.

Specified by:

getTable in interface IDataSet

Overrides:

getTable in class AbstractDataSet

Parameters:

tableName - the name of the table to look up.

Returns:

the specified table.

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 - if the notification cannot be processed.

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 - if the notification cannot be processed.

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 - if the notification cannot be processed.

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 - if the notification cannot be processed.

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 - if the notification cannot be processed.

toString

public String toString()

Overrides:

toString in class AbstractDataSet