org.dbunit.dataset

Class ReplacementDataSet

java.lang.Object

org.dbunit.dataset.AbstractDataSet

org.dbunit.dataset.ReplacementDataSet

All Implemented Interfaces:

IDataSet

public class ReplacementDataSet
extends AbstractDataSet

Decorator that replace configured values from the decorated dataset with replacement values.

Since:

Mar 17, 2003

Version:

$Revision$

Author:

Manuel Laflamme

Field Summary

Fields inherited from class org.dbunit.dataset.AbstractDataSet

_orderedTableNameMap

Constructor Summary

Constructors

Constructor and Description
ReplacementDataSet(IDataSet dataSet) Create a new ReplacementDataSet object that decorates the specified dataset.
ReplacementDataSet(IDataSet dataSet, java.util.Map objectMap, java.util.Map substringMap) Create a new ReplacementDataSet object that decorates the specified dataset.

Method Summary

Modifier and Type	Method and Description
void	addReplacementObject(java.lang.Object originalObject, java.lang.Object replacementObject) Add a new Object replacement mapping.
void	addReplacementSubstring(java.lang.String originalSubstring, java.lang.String replacementSubstring) Add a new substring replacement mapping.
protected ITableIterator	createIterator(boolean reversed) Creates an iterator which provides access to all tables of this dataset
ITable	getTable(java.lang.String tableName) Returns the specified table.
ITableMetaData	getTableMetaData(java.lang.String tableName) Returns the specified table metadata.
java.lang.String[]	getTableNames() Returns names of tables in this dataset in proper sequence.
void	setStrictReplacement(boolean strictReplacement) Setting this property to true indicates that when no replacement is found for a delimited substring the replacement will fail fast.
void	setSubstringDelimiters(java.lang.String startDelimiter, java.lang.String endDelimiter) Sets substring delimiters.

Methods inherited from class org.dbunit.dataset.AbstractDataSet

createTableNameMap, getTables, initialize, isCaseSensitiveTableNames, iterator, reverseIterator, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplacementDataSet

public ReplacementDataSet(IDataSet dataSet)

Create a new ReplacementDataSet object that decorates the specified dataset.

Parameters:

dataSet - the decorated table

ReplacementDataSet

public ReplacementDataSet(IDataSet dataSet,
                          java.util.Map objectMap,
                          java.util.Map substringMap)

Create a new ReplacementDataSet object that decorates the specified dataset.

Parameters:

dataSet - the decorated dataset

objectMap - the replacement objects mapping

substringMap - the replacement substrings mapping

Method Detail

setStrictReplacement

public void setStrictReplacement(boolean strictReplacement)

Setting this property to true indicates that when no replacement is found for a delimited substring the replacement will fail fast.

Parameters:

strictReplacement - true if replacement should be strict

addReplacementObject

public void addReplacementObject(java.lang.Object originalObject,
                                 java.lang.Object replacementObject)

Add a new Object replacement mapping.

Parameters:

originalObject - the object to replace

replacementObject - the replacement object

addReplacementSubstring

public void addReplacementSubstring(java.lang.String originalSubstring,
                                    java.lang.String replacementSubstring)

Add a new substring replacement mapping.

Parameters:

originalSubstring - the substring to replace

replacementSubstring - the replacement substring

setSubstringDelimiters

public void setSubstringDelimiters(java.lang.String startDelimiter,
                                   java.lang.String endDelimiter)

Sets substring delimiters.

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

getTableNames

public java.lang.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

Throws:

DataSetException

getTableMetaData

public ITableMetaData getTableMetaData(java.lang.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

Throws:

NoSuchTableException - if dataset do not contains the specified table

DataSetException

getTable

public ITable getTable(java.lang.String tableName)
                throws DataSetException

Description copied from interface: IDataSet

Returns the specified table.

Specified by:

getTable in interface IDataSet

Overrides:

getTable in class AbstractDataSet

Throws:

NoSuchTableException - if dataset do not contains the specified table

DataSetException