org.dbunit.dataset

Class OrderedTableNameMap

java.lang.Object

org.dbunit.dataset.OrderedTableNameMap

public class OrderedTableNameMap
extends java.lang.Object

Associates a table name with an arbitrary object. Moreover the order of the added table names is maintained and the ordered table names can be retrieved via getTableNames().

The map ensures that one table name can only be added once.

TODO In the future it might be discussed if a ListOrderedMap (apache-commons-collections) can/should be used.

Since:

2.4.0

Version:

$Revision$

Author:

gommma, Last changed by: $Author$

Constructor Summary

Constructors

Constructor and Description
OrderedTableNameMap(boolean caseSensitiveTableNames) Creates a new map which does strictly force that one table can only occur once.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String tableName, java.lang.Object object) Adds the given table name to the map of table names, associating it with the given object.
boolean	containsTable(java.lang.String tableName) Checks if this map contains the given table name
java.lang.Object	get(java.lang.String tableName) Returns the object associated with the given table name
java.lang.String	getLastTableName()
java.lang.String	getTableName(java.lang.String tableName) Returns the table name in the correct case (for example as upper case string)
java.lang.String[]	getTableNames() Provides the ordered table names having the same order in which the table names have been added via add(String, Object).
boolean	isLastTable(java.lang.String tableName)
java.util.Collection	orderedValues()
void	setLastTable(java.lang.String tableName)
java.lang.String	toString()
void	update(java.lang.String tableName, java.lang.Object object) Updates the value associated with the given table name.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderedTableNameMap

public OrderedTableNameMap(boolean caseSensitiveTableNames)

Creates a new map which does strictly force that one table can only occur once.

Parameters:

caseSensitiveTableNames - Whether or not table names should be case sensitive

Method Detail

get

public java.lang.Object get(java.lang.String tableName)

Returns the object associated with the given table name

Parameters:

tableName - The table name for which the associated object is retrieved

Returns:

The object that has been associated with the given table name

getTableNames

public java.lang.String[] getTableNames()

Provides the ordered table names having the same order in which the table names have been added via add(String, Object).

Returns:

The list of table names ordered in the sequence as they have been added to this map

containsTable

public boolean containsTable(java.lang.String tableName)

Checks if this map contains the given table name

Parameters:

tableName -

Returns:

Returns true if the map of tables contains the given table name

isLastTable

public boolean isLastTable(java.lang.String tableName)

Parameters:

tableName - The table name to check

Returns:

true if the given tableName matches the last table that has been added to this map.

getLastTableName

public java.lang.String getLastTableName()

Returns:

The name of the last table that has been added to this map. Returns null if no table has been added yet.

setLastTable

public void setLastTable(java.lang.String tableName)
                  throws NoSuchTableException

Throws:

NoSuchTableException

add

public void add(java.lang.String tableName,
                java.lang.Object object)
         throws AmbiguousTableNameException

Adds the given table name to the map of table names, associating it with the given object.

Parameters:

tableName - The table name to be added

object - Object to be associated with the given table name. Can be null

Throws:

AmbiguousTableNameException - If the given table name already exists

orderedValues

public java.util.Collection orderedValues()

Returns:

The values of this map ordered in the sequence they have been added

update

public void update(java.lang.String tableName,
                   java.lang.Object object)

Updates the value associated with the given table name. Must be invoked if the table name has already been added before.

Parameters:

tableName - The table name for which the association should be updated

object - The new object to be associated with the given table name

getTableName

public java.lang.String getTableName(java.lang.String tableName)

Returns the table name in the correct case (for example as upper case string)

Parameters:

tableName - The input table name to be resolved

Returns:

The table name for the given string in the correct case.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object