edu.northwestern.at.utils

Interface Map2D<R extends java.lang.Comparable,C extends java.lang.Comparable,V>

All Known Implementing Classes:

HashMap2D, TreeMap2D

public interface Map2D<R extends java.lang.Comparable,C extends java.lang.Comparable,V>

Interface for two dimensional map.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear all entries from this map and its child maps.
java.util.Set<C>	columnKeySet() Get column key set.
java.util.Set<C>	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(R rowKey, C 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<R>	rowKeySet() Get row key set.
int	size() Return number of entries.

Method Detail

clear

void clear()

Clear all entries from this map and its child maps.

size

int size()

Return number of entries.

Returns:

Number of entries in map.

containsKeys

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

Determine if map contains a key pair.

Parameters:

rowKey - Row key.

columnKey - Column key.

Returns:

true if entry exists, false otherwise.

containsKey

boolean containsKey(CompoundKey key)

Determine if map contains a compound key.

Parameters:

key - Compound key.

Returns:

true if entry exists, false otherwise.

get

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

Get value at specified (rowKey, columnKey) position.

Parameters:

rowKey - Row key.

columnKey - Column key.

Returns:

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

get

V get(CompoundKey key)

Get value at specified CompoundKey position.

Parameters:

key - Compound key.

Returns:

The value at the specified compound key position.

put

V put(R rowKey,
    C columnKey,
    V value)

Add value for specified (rowKey, columnKey) .

Parameters:

rowKey - Row key.

columnKey - Column key.

value - Value to store.

Returns:

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

remove

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

Remove entry at (rowKey, columnKey).

Parameters:

rowKey - Row key.

columnKey - Column key.

Returns:

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

keySet

java.util.Set<CompoundKey> keySet()

Get the compound key set.

Returns:

The compound key set.

rowKeySet

java.util.Set<R> rowKeySet()

Get row key set.

Returns:

rows key set.

columnKeySet

java.util.Set<C> columnKeySet()

Get column key set.

Returns:

column key set.

columnKeySet

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

Get column key set with specified row value.

Parameters:

rowKey - Row key value.

Returns:

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