org.dbunit.util.fileloader
Interface DataFileLoader

All Known Implementing Classes:

AbstractDataFileLoader, CsvDataFileLoader, FlatXmlDataFileLoader, FullXmlDataFileLoader, XlsDataFileLoader

public interface DataFileLoader

Defines a dbUnit data file loader supporting replacement objects and substrings with ReplacementDataSet.

Since:

2.4.8

Version:

$Revision$ $Date$

Author:

Jeff Jensen jeffjensen AT users.sourceforge.net, Last changed by: $Author$

Method Summary

void	addReplacementObjects(java.util.Map replacementObjects) Add the specified replacement objects to existing ones for use with ReplacementDataSet.
void	addReplacementSubstrings(java.util.Map replacementSubstrings) Add the specified replacement substrings to existing ones for use with ReplacementDataSet.
IDataSet	load(java.lang.String fileName) Load the specified filename from the classpath into a dbUnit dataset.
void	removeAllReplacementObjects() Remove all existing replacement objects, resetting to none so no object replacements occur.
void	removeAllReplacementSubstrings() Remove all existing replacement substring objects, resetting to none so no substring replacements occur.

Method Detail

load

IDataSet load(java.lang.String fileName)

Load the specified filename from the classpath into a dbUnit dataset. If filename == null or "", then returns an empty DefaultDataSet.

Parameters:

filename - The dbUnit file to load, in the format for the loader implementation and fully qualified name with package syntax.

Returns:

The dbUnit dataset of the specified file.

Throws:

DatabaseUnitRuntimeException - DataSetException wrapped in a DatabaseUnitRuntimeException when file load errors occur.

addReplacementObjects

void addReplacementObjects(java.util.Map replacementObjects)

Add the specified replacement objects to existing ones for use with ReplacementDataSet.

Parameters:

replacementObjects - The replacement objects to include.

Since:

2.4.8

addReplacementSubstrings

void addReplacementSubstrings(java.util.Map replacementSubstrings)

Add the specified replacement substrings to existing ones for use with ReplacementDataSet.

Parameters:

replacementSubstrings - The replacement substrings to include.

Since:

2.4.8

removeAllReplacementObjects

void removeAllReplacementObjects()

Remove all existing replacement objects, resetting to none so no object replacements occur.

Since:

2.4.8

removeAllReplacementSubstrings

void removeAllReplacementSubstrings()

Remove all existing replacement substring objects, resetting to none so no substring replacements occur.

Since:

2.4.8