edu.northwestern.at.utils

Class HashMap2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

java.lang.Object

edu.northwestern.at.utils.HashMap2D<K1,K2,V>

All Implemented Interfaces:

Map2D<K1,K2,V>

public class HashMap2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>
extends java.lang.Object
implements Map2D<K1,K2,V>

Two dimensional HashMap.

The two dimensional hash map is implemented as a hash map of hash maps. Each "row" key points to a "column" hash map.

Example of use:

Map2D map = new HashMap2D(); map.put( "a" , "b" , "my value" ); String s = map.get( "a" , "b" );

Note: HashMap2D does not implement the Map interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	capacity Initial capacity for child hash maps.
protected java.util.Map<K1,java.util.Map<K2,V>>	localMap Local map.

Constructor Summary

Constructors

Constructor and Description
HashMap2D() Create two dimensional hash map.
HashMap2D(int initialCapacity) Create two dimensional hash map with specified initial row capacity.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear all entries from this map and its child maps.
java.util.Set<K2>	columnKeySet() Get column key set.
java.util.Set<K2>	columnKeySet(java.lang.Object rowKey) Get column key set with specified row value.
boolean	containsKey(CompoundKey key) Determine if map contains a compound key.
boolean	containsKeys(java.lang.Object rowKey, java.lang.Object columnKey) Determine if map contains a key pair.
V	get(CompoundKey key) Get value at specified CompoundKey position.
V	get(java.lang.Object rowKey, java.lang.Object columnKey) Get value at specified (rowKey, columnKey) position.
java.util.Set<CompoundKey>	keySet() Get the compound key set.
V	put(K1 rowKey, K2 columnKey, V value) Add value for specified (rowKey, columnKey) .
V	remove(java.lang.Object rowKey, java.lang.Object columnKey) Remove entry at (rowKey, columnKey).
java.util.Set<K1>	rowKeySet() Get row key set.
int	size() Return number of entries.
java.lang.String	toString() Return formatted string displaying all entries.

Methods inherited from class java.lang.Object

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

Field Detail

localMap

protected java.util.Map<K1 extends java.lang.Comparable,java.util.Map<K2 extends java.lang.Comparable,V>> localMap

Local map.

capacity

protected int capacity

Initial capacity for child hash maps.

Constructor Detail

HashMap2D

public HashMap2D()

Create two dimensional hash map.

HashMap2D

public HashMap2D(int initialCapacity)

Create two dimensional hash map with specified initial row capacity.

Parameters:

initialCapacity -

Method Detail

clear

public void clear()

Clear all entries from this map and its child maps.

Specified by:

clear in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

size

public int size()

Return number of entries.

Specified by:

size in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Returns:

Number of entries in map.

The number of entries is given by the sum of the number of entries for each submap.

containsKeys

public boolean containsKeys(java.lang.Object rowKey,
                   java.lang.Object columnKey)

Determine if map contains a key pair.

Specified by:

containsKeys in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Parameters:

rowKey - Row key.

columnKey - Column key.

Returns:

true if entry exists, false otherwise.

containsKey

public boolean containsKey(CompoundKey key)

Determine if map contains a compound key.

Specified by:

containsKey in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Parameters:

key - Compound key.

Returns:

true if entry exists, false otherwise.

get

public V get(java.lang.Object rowKey,
    java.lang.Object columnKey)

Get value at specified (rowKey, columnKey) position.

Specified by:

get in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Parameters:

rowKey - Row key.

columnKey - Column key.

Returns:

The value at the specified (rowKey, columnKey) position.

get

public V get(CompoundKey key)

Get value at specified CompoundKey position.

Specified by:

get in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Parameters:

key - Compound key.

Returns:

The value at the specified compound key position.

put

public V put(K1 rowKey,
    K2 columnKey,
    V value)

Add value for specified (rowKey, columnKey) .

Specified by:

put in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Parameters:

rowKey - Row key.

columnKey - Column key.

value - Value to store.

Returns:

Previous value for (rowKey, columnKey). May be null.

remove

public V remove(java.lang.Object rowKey,
       java.lang.Object columnKey)

Remove entry at (rowKey, columnKey).

Specified by:

remove in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Parameters:

rowKey - Row key.

columnKey - Column key.

Returns:

Previous value for (rowKey, columnKey). May be null.

keySet

public java.util.Set<CompoundKey> keySet()

Get the compound key set.

Specified by:

keySet in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Returns:

The compound key set.

rowKeySet

public java.util.Set<K1> rowKeySet()

Get row key set.

Specified by:

rowKeySet in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Returns:

rows key set.

columnKeySet

public java.util.Set<K2> columnKeySet()

Get column key set.

Specified by:

columnKeySet in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Returns:

column key set.

columnKeySet

public java.util.Set<K2> columnKeySet(java.lang.Object rowKey)

Description copied from interface: Map2D

Get column key set with specified row value.

Specified by:

columnKeySet in interface Map2D<K1 extends java.lang.Comparable,K2 extends java.lang.Comparable,V>

Parameters:

rowKey - Row key value.

Returns:

Column key set. May be empty if no row key matches.

toString

public java.lang.String toString()

Return formatted string displaying all entries.

Overrides:

toString in class java.lang.Object

Returns:

Formatted string displaying all entries.