org.dbunit.util.fileloader
Class AbstractDataFileLoader

java.lang.Object
  org.dbunit.util.fileloader.AbstractDataFileLoader

All Implemented Interfaces:

DataFileLoader

Direct Known Subclasses:

CsvDataFileLoader, FlatXmlDataFileLoader, FullXmlDataFileLoader, XlsDataFileLoader

public abstract class AbstractDataFileLoader
extends java.lang.Object
implements DataFileLoader

Base class with common implementation for dbUnit data file loaders.

Since:

2.4.8

Version:

$Revision$ $Date$

Author:

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

Constructor Summary

AbstractDataFileLoader()
Create new instance.

AbstractDataFileLoader(java.util.Map ro)
Create new instance with replacement objects.

AbstractDataFileLoader(java.util.Map ro, java.util.Map rs)
Create new instance with replacement objects and replacement substrings.

Method Summary

void	addReplacementObjects(java.util.Map ro) Add the specified replacement objects to existing ones for use with ReplacementDataSet.
void	addReplacementSubstrings(java.util.Map rs) 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.
protected abstract IDataSet	loadDataSet(java.net.URL url) Make the dbUnit dataset (IDataSet) from the input stream of a dbUnit data file.
protected ReplacementDataSet	processReplacementTokens(IDataSet ds) Add the replacements in the maps (objects and substrings) to the specified 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDataFileLoader

public AbstractDataFileLoader()

Create new instance.

AbstractDataFileLoader

public AbstractDataFileLoader(java.util.Map ro)

Create new instance with replacement objects.

Parameters:

replacementObjects - The replacement objects for use with ReplacementDataSet.

AbstractDataFileLoader

public AbstractDataFileLoader(java.util.Map ro,
                              java.util.Map rs)

Create new instance with replacement objects and replacement substrings.

Parameters:

ro - The replacement objects for use with ReplacementDataSet.

rs - The replacement substrings for use with ReplacementDataSet.

Method Detail

load

public IDataSet load(java.lang.String filename)
              throws DatabaseUnitRuntimeException

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

Specified by:

load in interface DataFileLoader

Returns:

The dbUnit dataset of the specified file.

Throws:

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

loadDataSet

protected abstract IDataSet loadDataSet(java.net.URL url)
                                 throws DataSetException,
                                        java.io.IOException

Make the dbUnit dataset (IDataSet) from the input stream of a dbUnit data file. The type of dbUnit dataset created is delegated to the implementing subclass.

Parameters:

url - The dbUnit data file url.

Returns:

dbUnit dataset of the corresponding input file type.

Throws:

DataSetException - On data errors.

java.io.IOException - On file errors.

Since:

2.4.8

processReplacementTokens

protected ReplacementDataSet processReplacementTokens(IDataSet ds)

Add the replacements in the maps (objects and substrings) to the specified dataset.

Parameters:

ds - The dataset to wrap with a ReplacementDataSet and process replacement tokens on.

Returns:

The specified dataset decorated with ReplacementDataSet and processed with the tokens in the replacement maps.

Since:

2.4.8

addReplacementObjects

public void addReplacementObjects(java.util.Map ro)

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

Specified by:

addReplacementObjects in interface DataFileLoader

Parameters:

ro - The replacement objects to include.

addReplacementSubstrings

public void addReplacementSubstrings(java.util.Map rs)

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

Specified by:

addReplacementSubstrings in interface DataFileLoader

Parameters:

rs - The replacement substrings to include.

removeAllReplacementObjects

public void removeAllReplacementObjects()

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

Specified by:

removeAllReplacementObjects in interface DataFileLoader

removeAllReplacementSubstrings

public void removeAllReplacementSubstrings()

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

Specified by:

removeAllReplacementSubstrings in interface DataFileLoader