summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/esodata/Multimap.java
blob: a79f1b09dc7d55b8e18d6eede4d4b86d0f7b33c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
package bjc.esodata;

import java.util.*;

/**
 * A map that has support for multiple values for a given key.
 *
 * Whenever you give another value for a key, that is then returned for that
 * key. About the only somewhat complex thing, is that, if you add the same
 * key-value pair multiple times, it will only show up once. However, you will
 * have to remove that pair as many times as you added it.
 *
 * @author Ben Culkin
 * @param <KeyType> The type of keys in the map.
 * @param <ValueType> The type of values in the map.
 */
public class Multimap<KeyType, ValueType> {
	private Map<KeyType, ThresholdSet<ValueType>> backing;

	/**
	 * Create a new empty multimap.
	 */
	public Multimap() {
		backing = new HashMap<>();
	}

	/**
	 * Add a key-value mapping to the map.
	 *
	 * @param key
	 *              The key to store the value under.
	 *
	 * @param value
	 *              The value to store.
	 */
	public void add(KeyType key, ValueType value) {
		ThresholdSet<ValueType> container
				= backing.computeIfAbsent(key, k -> new ThresholdSet<>());

		container.add(value);
	}

	/**
	 * Delete a particular key-value mapping from the map.
	 *
	 * @param key
	 *              The key of the mapping to remove.
	 *
	 * @param value
	 *              The value of the mapping to remove.
	 */
	public void remove(KeyType key, ValueType value) {
		// We have no values for that key; bail.
		if (!backing.containsKey(key))
			return;

		backing.get(key).remove(value);
	}

	/**
	 * Delete all of the values associated with a particular key.
	 *
	 * @param key
	 *            The key to remove values for.
	 */
	public void remove(KeyType key) {
		backing.remove(key);
	}

	/**
	 * Get a set containing all of the values that are recorded for that key.
	 *
	 * @param key
	 *            The key to look up values for.
	 *
	 * @return A set containing all of the values that have been mapped to that key.
	 */
	public Set<ValueType> get(KeyType key) {
		if (!backing.containsKey(key))
			return new HashSet<>();

		return backing.get(key).values();
	}

	/**
	 * Check if there is at least one value mapped to the given key.
	 *
	 * @param key
	 *            The key to check for mappings for.
	 *
	 * @return Whether or not there is at least one value mapped to the key.
	 */
	public boolean contains(KeyType key) {
		return backing.containsKey(key);
	}

	/**
	 * Check if there is at least one instance of a particular key-value mapping.
	 *
	 * @param key
	 *              The key to check for mappings for.
	 *
	 * @param value
	 *              The value to check for mappings for.
	 *
	 * @return Whether or not there is at least one instance of the given key-value
	 *         mapping.
	 */
	public boolean contains(KeyType key, ValueType value) {
		if (!backing.containsKey(key))
			return false;

		return backing.get(key).contains(value) > 0;
	}
}