summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/utilities/datastructures/HashMapList.java
blob: 7c5c950baf24b48958745007b335c5d5d4830274 (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
116
117
118
119
120
121
122
123
124
package de.lmu.ifi.dbs.elki.utilities.datastructures;

/*
 This file is part of ELKI:
 Environment for Developing KDD-Applications Supported by Index-Structures

 Copyright (C) 2011
 Ludwig-Maximilians-Universität München
 Lehr- und Forschungseinheit für Datenbanksysteme
 ELKI Development Team

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

/**
 * Multi-Associative container, that stores a list of values for a particular key.
 * 
 * @author Erich Schubert
 * 
 * @apiviz.has List oneway - - contains
 *
 * @param <K> Key type
 * @param <V> Value type
 */
// TODO: use MultiValueMap from apache collections instead?
public class HashMapList<K, V> extends HashMap<K, List<V>> {
  /**
   * Serial version
   */
  private static final long serialVersionUID = 3883242025598456055L;

  /**
   * Constructor.
   */
  public HashMapList() {
    super();
  }

  /**
   * Constructor with initial capacity (of the hash)
   * 
   * @param initialCapacity initial capacity
   */
  public HashMapList(int initialCapacity) {
    super(initialCapacity);
  }

  /**
   * Add a single value to the given key.
   * 
   * @param key Key
   * @param value Additional Value
   */
  public synchronized void add(K key, V value) {
    List<V> list = super.get(key);
    if (list == null) {
      list = new ArrayList<V>(1);
      super.put(key, list);
    }
    list.add(value);
  }

  /**
   * Check that there is at least one value for the key.
   */
  @Override
  public boolean containsKey(Object key) {
    List<V> list = super.get(key);
    if (list == null) {
      return false;
    }
    return list.size() > 0;
  }

  /**
   * Remove a single value from the map.
   * 
   * @param key Key to remove
   * @param value Value to remove.
   * @return <tt>true</tt> if this list contained the specified element
   */
  public synchronized boolean remove(K key, V value) {
    List<V> list = super.get(key);
    if (list == null) {
      return false;
    }
    boolean success = list.remove(value);
    // remove empty lists.
    if (list.size() == 0) {
      super.remove(key);
    }
    return success;
  }

  /**
   * Test if a given value is already present for the key.
   * 
   * @param key Key
   * @param value Value
   * @return <tt>true</tt> if the keys list contains the specified element
   */
  public boolean contains(K key, V value) {
    List<V> list = super.get(key);
    if (list == null) {
      return false;
    }
    return list.contains(value);
  }
}