com.cookingfox.util.uid

Class UidKeyTranslator<T>

java.lang.Object

com.cookingfox.util.uid.UidKeyTranslator<T>

Type Parameters:

T - Indicates the data type of the item (key) that the unique id is mapped to.

public class UidKeyTranslator<T>
extends Object

A class that can be used to manage a map of Uid to user-defined objects and 'translate' from one to the other format. This is useful when an application uses unique ids that require different data types in certain contexts. Use the addToDictionary(Map) method to add specifications for this format to the translator's dictionary.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Uid,T>	dictionary A map of unique ids to a user-defined data type.

Constructor Summary

Constructors

Constructor and Description
UidKeyTranslator() Creates a new instance.
UidKeyTranslator(Map<Uid,T> map) Creates a new instance, calling addToDictionary(Map) for the provided map.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToDictionary(Map<Uid,T> map) Adds a UID-key map to the dictionary.
T	fromUid(Uid uid) Returns the key that is mapped to this unique id.
Map<T,?>	fromUidMap(Map<Uid,?> map) Accepts a map of unique ids to values and returns a new map which replaces the unique ids with the keys from the dictionary.
String	toString()
Uid	toUid(T key) Returns the unique id that is mapped to this key.
Map<Uid,?>	toUidMap(Map<T,Object> map) Accepts a map of keys to values and returns a new map which replaces the keys with the unique ids from the dictionary.

Methods inherited from class java.lang.Object

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

Field Detail

dictionary

protected final Map<Uid,T> dictionary

A map of unique ids to a user-defined data type.

Constructor Detail

UidKeyTranslator

public UidKeyTranslator()

Creates a new instance.

UidKeyTranslator

public UidKeyTranslator(Map<Uid,T> map)
                 throws UidKeyTranslatorException

Creates a new instance, calling addToDictionary(Map) for the provided map.

Parameters:

map - The values to add to the dictionary.

Throws:

UidKeyTranslatorException - when the map contains invalid keys or values.

Method Detail

addToDictionary

public void addToDictionary(Map<Uid,T> map)
                     throws UidKeyTranslatorException

Adds a UID-key map to the dictionary.

Parameters:

map - The values to add to the dictionary.

Throws:

UidKeyTranslatorException - when the map contains invalid keys or values.

fromUid

public T fromUid(Uid uid)
          throws UidKeyTranslatorException

Returns the key that is mapped to this unique id.

Parameters:

uid - The uid to translate.

Returns:

The key that is mapped to the provided uid.

Throws:

UidKeyTranslatorException - when the provided uid is not in the dictionary.

fromUidMap

public Map<T,?> fromUidMap(Map<Uid,?> map)
                    throws UidKeyTranslatorException

Accepts a map of unique ids to values and returns a new map which replaces the unique ids with the keys from the dictionary.

Parameters:

map - Map of Uid -> value.

Returns:

Map of Key -> value.

Throws:

UidKeyTranslatorException - when a provided uid is not in the dictionary.

toUid

public Uid toUid(T key)
          throws UidKeyTranslatorException

Returns the unique id that is mapped to this key.

Parameters:

key - The key to translate to Uid.

Returns:

The uid that is mapped to the provided key.

Throws:

UidKeyTranslatorException - when the provided key is not in the dictionary.

toUidMap

public Map<Uid,?> toUidMap(Map<T,Object> map)
                    throws UidKeyTranslatorException

Accepts a map of keys to values and returns a new map which replaces the keys with the unique ids from the dictionary.

Parameters:

map - Map of Key -> value.

Returns:

Map of Uid -> value.

Throws:

UidKeyTranslatorException - when the provided key is not in the dictionary.

toString

public String toString()

Overrides:

toString in class Object