edu.stanford.nlp.util

Class ThreeDimensionalCollectionValuedMap<K1,K2,K3,V>

java.lang.Object

edu.stanford.nlp.util.ThreeDimensionalCollectionValuedMap<K1,K2,K3,V>

All Implemented Interfaces:

java.io.Serializable

public class ThreeDimensionalCollectionValuedMap<K1,K2,K3,V>
extends java.lang.Object
implements java.io.Serializable

A class which can store mappings from Object keys to Collections of Object values. Important methods are the add(K1, K2, K3, V) for adding a value to/from the Collection associated with the key, and the get(K1, K2, K3) method for getting the Collection associated with a key. The class is quite general, because on construction, it is possible to pass a MapFactory which will be used to create the underlying map and a CollectionFactory which will be used to create the Collections. Thus this class can be configured to act like a "HashSetValuedMap" or a "ListValuedMap", or even a "HashSetValuedIdentityHashMap". The possibilities are endless!

Author:

Teg Grenager (grenager@cs.stanford.edu)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ThreeDimensionalCollectionValuedMap()

Method Summary

Modifier and Type	Method and Description
void	add(K1 key1, K2 key2, K3 key3, V value) Adds the value to the Collection mapped to by the key.
void	clear()
boolean	containsKey(K1 key)
java.util.Collection<V>	get(K1 key1, K2 key2, K3 key3)
TwoDimensionalCollectionValuedMap<K2,K3,V>	getTwoDimensionalCollectionValuedMap(K1 key1)
java.util.Set<K1>	keySet()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreeDimensionalCollectionValuedMap

public ThreeDimensionalCollectionValuedMap()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTwoDimensionalCollectionValuedMap

public TwoDimensionalCollectionValuedMap<K2,K3,V> getTwoDimensionalCollectionValuedMap(K1 key1)

Returns:

the Collection mapped to by key, never null, but may be empty.

get

public java.util.Collection<V> get(K1 key1,
                                   K2 key2,
                                   K3 key3)

add

public void add(K1 key1,
                K2 key2,
                K3 key3,
                V value)

Adds the value to the Collection mapped to by the key.

clear

public void clear()

keySet

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

Returns:

a Set view of the keys in this Map.

containsKey

public boolean containsKey(K1 key)