--- /dev/null
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ * VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.db.impl.query;\r
+\r
+///////////////////////////////////////////////////////////////////////////////\r
+//Copyright (c) 2001, Eric D. Friedman All Rights Reserved.\r
+//\r
+//This library is free software; you can redistribute it and/or\r
+//modify it under the terms of the GNU Lesser General Public\r
+//License as published by the Free Software Foundation; either\r
+//version 2.1 of the License, or (at your option) any later version.\r
+//\r
+//This library is distributed in the hope that it will be useful,\r
+//but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+//GNU General Public License for more details.\r
+//\r
+//You should have received a copy of the GNU Lesser General Public\r
+//License along with this program; if not, write to the Free Software\r
+//Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
+///////////////////////////////////////////////////////////////////////////////\r
+\r
+import gnu.trove.function.TObjectFunction;\r
+import gnu.trove.procedure.TObjectObjectProcedure;\r
+import gnu.trove.procedure.TObjectProcedure;\r
+\r
+import java.io.Externalizable;\r
+import java.util.ArrayList;\r
+import java.util.Arrays;\r
+import java.util.Collection;\r
+import java.util.Iterator;\r
+import java.util.Map;\r
+import java.util.Set;\r
+\r
+/**\r
+ * An implementation of the Map interface which uses an open addressed\r
+ * hash table to store its contents.\r
+ *\r
+ * Created: Sun Nov 4 08:52:45 2001\r
+ *\r
+ * @author Eric D. Friedman\r
+ * @version $Id: THashMap.java,v 1.33 2008/05/08 17:42:55 robeden Exp $\r
+ */\r
+public class StableHashMap<K,V> extends StableObjectHash<K> implements Map<K,V>, Externalizable {\r
+ static final long serialVersionUID = 1L;\r
+\r
+ /** the values of the map */\r
+ protected transient V[] _values;\r
+\r
+ /**\r
+ * Creates a new <code>THashMap</code> instance with the default\r
+ * capacity and load factor.\r
+ */\r
+ public StableHashMap() {\r
+ super();\r
+ }\r
+\r
+// /**\r
+// * Creates a new <code>THashMap</code> instance with a prime\r
+// * capacity equal to or greater than <tt>initialCapacity</tt> and\r
+// * with the default load factor.\r
+// *\r
+// * @param initialCapacity an <code>int</code> value\r
+// */\r
+// public StableHashMap(int initialCapacity) {\r
+// super(initialCapacity);\r
+// }\r
+\r
+// /**\r
+// * Creates a new <code>THashMap</code> instance with a prime\r
+// * capacity equal to or greater than <tt>initialCapacity</tt> and\r
+// * with the default load factor.\r
+// *\r
+// * @param initialCapacity an <code>int</code> value\r
+// * @param strategy used to compute hash codes and to compare objects.\r
+// */\r
+// public StableHashMap(int initialCapacity, TObjectHashingStrategy<K> strategy) {\r
+// super(initialCapacity, strategy);\r
+// }\r
+\r
+// /**\r
+// * Creates a new <code>THashMap</code> instance with a prime\r
+// * capacity equal to or greater than <tt>initialCapacity</tt> and\r
+// * with the specified load factor.\r
+// *\r
+// * @param initialCapacity an <code>int</code> value\r
+// * @param loadFactor a <code>float</code> value\r
+// */\r
+// public StableHashMap(int initialCapacity, float loadFactor) {\r
+// super(initialCapacity, loadFactor);\r
+// }\r
+\r
+// /**\r
+// * Creates a new <code>THashMap</code> instance with a prime\r
+// * capacity equal to or greater than <tt>initialCapacity</tt> and\r
+// * with the specified load factor.\r
+// *\r
+// * @param initialCapacity an <code>int</code> value\r
+// * @param loadFactor a <code>float</code> value\r
+// * @param strategy used to compute hash codes and to compare objects.\r
+// */\r
+// public StableHashMap(int initialCapacity, float loadFactor, TObjectHashingStrategy<K> strategy) {\r
+// super(initialCapacity, loadFactor, strategy);\r
+// }\r
+\r
+// /**\r
+// * Creates a new <code>THashMap</code> instance which contains the\r
+// * key/value pairs in <tt>map</tt>.\r
+// *\r
+// * @param map a <code>Map</code> value\r
+// */\r
+// public StableHashMap(Map<K,V> map) {\r
+// this(map.size());\r
+// putAll(map);\r
+// }\r
+//\r
+// /**\r
+// * Creates a new <code>THashMap</code> instance which contains the\r
+// * key/value pairs in <tt>map</tt>.\r
+// *\r
+// * @param map a <code>Map</code> value\r
+// * @param strategy used to compute hash codes and to compare objects.\r
+// */\r
+// public StableHashMap(Map<K,V> map, TObjectHashingStrategy<K> strategy) {\r
+// this(map.size(), strategy);\r
+// putAll(map);\r
+// }\r
+\r
+ /**\r
+ * @return a shallow clone of this collection\r
+ */\r
+ public StableHashMap<K,V> clone() {\r
+ StableHashMap<K,V> m = (StableHashMap<K,V>)super.clone();\r
+ m._values = this._values.clone();\r
+ return m;\r
+ }\r
+\r
+ /**\r
+ * initialize the value array of the map.\r
+ *\r
+ * @param initialCapacity an <code>int</code> value\r
+ * @return an <code>int</code> value\r
+ */\r
+ protected int setUp(int initialCapacity) {\r
+ int capacity;\r
+\r
+ capacity = super.setUp(initialCapacity);\r
+ //noinspection unchecked\r
+ _values = (V[]) new Object[capacity];\r
+ return capacity;\r
+ }\r
+\r
+ /**\r
+ * Inserts a key/value pair into the map.\r
+ *\r
+ * @param key an <code>Object</code> value\r
+ * @param value an <code>Object</code> value\r
+ * @return the previous value associated with <tt>key</tt>,\r
+ * or {@code null} if none was found.\r
+ */\r
+ public V put(K key, V value) {\r
+ int index = insertionIndex(key);\r
+ return doPut(key, value, index);\r
+ }\r
+\r
+ public V put(K key, V value, int hash) {\r
+ int index = insertionIndex(key, hash);\r
+ return doPut(key, value, index);\r
+ }\r
+ \r
+ /**\r
+ * Inserts a key/value pair into the map if the specified key is not already\r
+ * associated with a value.\r
+ * \r
+ * @param key an <code>Object</code> value\r
+ * @param value an <code>Object</code> value\r
+ * @return the previous value associated with <tt>key</tt>,\r
+ * or {@code null} if none was found.\r
+ */\r
+ public V putIfAbsent(K key, V value) {\r
+ int index = insertionIndex(key);\r
+ if (index < 0)\r
+ return _values[-index - 1];\r
+ return doPut(key, value, index);\r
+ }\r
+\r
+ private V doPut(K key, V value, int index) {\r
+ V previous = null;\r
+ Object oldKey;\r
+ boolean isNewMapping = true;\r
+ if (index < 0) {\r
+ index = -index -1;\r
+ previous = _values[index];\r
+ isNewMapping = false;\r
+ }\r
+ oldKey = _set[index];\r
+ _set[index] = key;\r
+ _values[index] = value;\r
+ if (isNewMapping) {\r
+ postInsertHook(oldKey == FREE);\r
+ }\r
+\r
+ return previous;\r
+ }\r
+\r
+ /**\r
+ * Compares this map with another map for equality of their stored\r
+ * entries.\r
+ *\r
+ * @param other an <code>Object</code> value\r
+ * @return a <code>boolean</code> value\r
+ */\r
+ public boolean equals(Object other) {\r
+ if (! (other instanceof Map)) {\r
+ return false;\r
+ }\r
+ Map<K, V> that = (Map<K, V>)other;\r
+ if (that.size() != this.size()) {\r
+ return false;\r
+ }\r
+ return forEachEntry(new EqProcedure<K,V>(that));\r
+ }\r
+\r
+ public int hashCode() {\r
+ HashProcedure p = new HashProcedure();\r
+ forEachEntry(p);\r
+ return p.getHashCode();\r
+ }\r
+\r
+ public String toString() {\r
+ final StringBuilder buf = new StringBuilder("{");\r
+ forEachEntry(new TObjectObjectProcedure<K,V>() {\r
+ private boolean first = true;\r
+ public boolean execute(K key, V value) {\r
+ if ( first ) first = false;\r
+ else buf.append( "," );\r
+\r
+ buf.append(key);\r
+ buf.append("=");\r
+ buf.append(value);\r
+ return true;\r
+ }\r
+ });\r
+ buf.append("}");\r
+ return buf.toString();\r
+ }\r
+\r
+ private final class HashProcedure implements TObjectObjectProcedure<K,V> {\r
+ private int h = 0;\r
+\r
+ public int getHashCode() {\r
+ return h;\r
+ }\r
+\r
+ public final boolean execute(K key, V value) {\r
+ h += _hashingStrategy.computeHashCode(key) ^ (value == null ? 0 : value.hashCode());\r
+ return true;\r
+ }\r
+ }\r
+\r
+ private static final class EqProcedure<K,V> implements TObjectObjectProcedure<K,V> {\r
+ private final Map<K,V> _otherMap;\r
+\r
+ EqProcedure(Map<K,V> otherMap) {\r
+ _otherMap = otherMap;\r
+ }\r
+\r
+ public final boolean execute(K key, V value) {\r
+ // Check to make sure the key is there. This avoids problems that come up with\r
+ // null values. Since it is only caused in that cause, only do this when the\r
+ // value is null (to avoid extra work).\r
+ if (value == null && !_otherMap.containsKey(key)) return false;\r
+\r
+ V oValue = _otherMap.get(key);\r
+ return oValue == value || (oValue != null && oValue.equals(value));\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Executes <tt>procedure</tt> for each key in the map.\r
+ *\r
+ * @param procedure a <code>TObjectProcedure</code> value\r
+ * @return false if the loop over the keys terminated because\r
+ * the procedure returned false for some key.\r
+ */\r
+ public boolean forEachKey(TObjectProcedure<K> procedure) {\r
+ return forEach(procedure);\r
+ }\r
+\r
+ /**\r
+ * Executes <tt>procedure</tt> for each value in the map.\r
+ *\r
+ * @param procedure a <code>TObjectProcedure</code> value\r
+ * @return false if the loop over the values terminated because\r
+ * the procedure returned false for some value.\r
+ */\r
+ public boolean forEachValue(TObjectProcedure<V> procedure) {\r
+ V[] values = _values;\r
+ Object[] set = _set;\r
+ for (int i = values.length; i-- > 0;) {\r
+ if (set[i] != FREE\r
+ && set[i] != REMOVED\r
+ && ! procedure.execute(values[i])) {\r
+ return false;\r
+ }\r
+ }\r
+ return true;\r
+ }\r
+\r
+ /**\r
+ * Executes <tt>procedure</tt> for each key/value entry in the\r
+ * map.\r
+ *\r
+ * @param procedure a <code>TObjectObjectProcedure</code> value\r
+ * @return false if the loop over the entries terminated because\r
+ * the procedure returned false for some entry.\r
+ */\r
+ public boolean forEachEntry(TObjectObjectProcedure<K,V> procedure) {\r
+ Object[] keys = _set;\r
+ V[] values = _values;\r
+ for (int i = keys.length; i-- > 0;) {\r
+ if (keys[i] != FREE\r
+ && keys[i] != REMOVED\r
+ && ! procedure.execute((K) keys[i],values[i])) {\r
+ return false;\r
+ }\r
+ }\r
+ return true;\r
+ }\r
+\r
+ /**\r
+ * Retains only those entries in the map for which the procedure\r
+ * returns a true value.\r
+ *\r
+ * @param procedure determines which entries to keep\r
+ * @return true if the map was modified.\r
+ */\r
+ public boolean retainEntries(TObjectObjectProcedure<K,V> procedure) {\r
+ boolean modified = false;\r
+ Object[] keys = _set;\r
+ V[] values = _values;\r
+\r
+ // Temporarily disable compaction. This is a fix for bug #1738760\r
+ tempDisableAutoCompaction();\r
+ try {\r
+ for (int i = keys.length; i-- > 0;) {\r
+ if (keys[i] != FREE\r
+ && keys[i] != REMOVED\r
+ && ! procedure.execute((K) keys[i],values[i])) {\r
+ removeAt(i);\r
+ modified = true;\r
+ }\r
+ }\r
+ }\r
+ finally {\r
+ reenableAutoCompaction(true);\r
+ }\r
+\r
+ return modified;\r
+ }\r
+\r
+ /**\r
+ * Transform the values in this map using <tt>function</tt>.\r
+ *\r
+ * @param function a <code>TObjectFunction</code> value\r
+ */\r
+ public void transformValues(TObjectFunction<V,V> function) {\r
+ V[] values = _values;\r
+ Object[] set = _set;\r
+ for (int i = values.length; i-- > 0;) {\r
+ if (set[i] != FREE && set[i] != REMOVED) {\r
+ values[i] = function.execute(values[i]);\r
+ }\r
+ }\r
+ }\r
+\r
+ /**\r
+ * rehashes the map to the new capacity.\r
+ *\r
+ * @param newCapacity an <code>int</code> value\r
+ */\r
+ protected void rehash(int newCapacity) {\r
+ int oldCapacity = _set.length;\r
+ Object oldKeys[] = _set;\r
+ V oldVals[] = _values;\r
+\r
+ _set = new Object[newCapacity];\r
+ Arrays.fill(_set, FREE);\r
+ _values = (V[]) new Object[newCapacity];\r
+\r
+ for (int i = oldCapacity; i-- > 0;) {\r
+ if(oldKeys[i] != FREE && oldKeys[i] != REMOVED) {\r
+ Object o = oldKeys[i];\r
+ int index = insertionIndex((K) o);\r
+ if (index < 0) {\r
+ throwObjectContractViolation(_set[(-index -1)], o);\r
+ }\r
+ _set[index] = o;\r
+ _values[index] = oldVals[i];\r
+ }\r
+ }\r
+ }\r
+\r
+ /**\r
+ * retrieves the value for <tt>key</tt>\r
+ *\r
+ * @param key an <code>Object</code> value\r
+ * @return the value of <tt>key</tt> or null if no such mapping exists.\r
+ */\r
+ public V get(Object key) {\r
+ Object[] set = _set;\r
+ V[] values = _values;\r
+ int index = index((K) key, set);\r
+ return index < 0 ? null : values[index];\r
+ }\r
+\r
+ public V get(Object key, int hash) {\r
+ Object[] set = _set;\r
+ V[] values = _values;\r
+ int index = index((K) key, hash, set);\r
+ return index < 0 ? null : values[index];\r
+ }\r
+ \r
+ /**\r
+ * Empties the map.\r
+ *\r
+ */\r
+ public void clear() {\r
+ if (size() == 0) return; // optimization\r
+\r
+ super.clear();\r
+\r
+ Arrays.fill(_set, 0, _set.length, FREE);\r
+ Arrays.fill(_values, 0, _values.length, null);\r
+ }\r
+\r
+ /**\r
+ * Deletes a key/value pair from the map.\r
+ *\r
+ * @param key an <code>Object</code> value\r
+ * @return an <code>Object</code> value\r
+ */\r
+ public V remove(Object key) {\r
+ Object[] set = _set;\r
+ V[] values = _values;\r
+ V prev = null;\r
+ int index = index((K) key, set);\r
+ if (index >= 0) {\r
+ prev = values[index];\r
+ removeAt(index); // clear key,state; adjust size\r
+ }\r
+ return prev;\r
+ }\r
+ \r
+ protected void removeAt(int index) {\r
+ _values[index] = null;\r
+ super.removeAt(index); // clear key, state; adjust size\r
+ }\r
+\r
+ /**\r
+ * removes the mapping at <tt>index</tt> from the map.\r
+ *\r
+ * @param index an <code>int</code> value\r
+ */\r
+ protected void removeAt(int index, V[] values) {\r
+ values[index] = null;\r
+ super.removeAt(index); // clear key, state; adjust size\r
+ }\r
+\r
+ public void values(int level, CacheCollectionResult result) {\r
+\r
+ for (int i = _set.length; i-- > 0;) {\r
+ if(_set[i] != null && _set[i] != REMOVED && _set[i] != FREE) {\r
+ CacheEntryBase e = (CacheEntryBase)_values[i];\r
+ if(e.getLevel() <= level)\r
+ result.add(e);\r
+ }\r
+ }\r
+\r
+ }\r
+ \r
+ /**\r
+ * Returns a view on the values of the map.\r
+ *\r
+ * @return a <code>Collection</code> value\r
+ */\r
+ public Collection<V> values() {\r
+\r
+ Collection<V> result = new ArrayList<V>();\r
+\r
+ for (int i = _set.length; i-- > 0;) {\r
+ if(_set[i] != null && _set[i] != REMOVED && _set[i] != FREE) {\r
+ result.add((V)_values[i]);\r
+ }\r
+ }\r
+\r
+ return result;\r
+ \r
+ }\r
+\r
+ /**\r
+ * returns a Set view on the keys of the map.\r
+ *\r
+ * @return a <code>Set</code> value\r
+ */\r
+ public Set<K> keySet() {\r
+ throw new UnsupportedOperationException();\r
+ }\r
+\r
+ /**\r
+ * Returns a Set view on the entries of the map.\r
+ *\r
+ * @return a <code>Set</code> value\r
+ */\r
+ public Set<Map.Entry<K,V>> entrySet() {\r
+ throw new UnsupportedOperationException();\r
+ }\r
+\r
+ /**\r
+ * checks for the presence of <tt>val</tt> in the values of the map.\r
+ *\r
+ * @param val an <code>Object</code> value\r
+ * @return a <code>boolean</code> value\r
+ */\r
+ public boolean containsValue(Object val) {\r
+ Object[] set = _set;\r
+ V[] vals = _values;\r
+\r
+ // special case null values so that we don't have to\r
+ // perform null checks before every call to equals()\r
+ if (null == val) {\r
+ for (int i = vals.length; i-- > 0;) {\r
+ if ((set[i] != FREE && set[i] != REMOVED) &&\r
+ val == vals[i]) {\r
+ return true;\r
+ }\r
+ }\r
+ } else {\r
+ for (int i = vals.length; i-- > 0;) {\r
+ if ((set[i] != FREE && set[i] != REMOVED) &&\r
+ (val == vals[i] || val.equals(vals[i]))) {\r
+ return true;\r
+ }\r
+ }\r
+ } // end of else\r
+ return false;\r
+ }\r
+\r
+ /**\r
+ * checks for the present of <tt>key</tt> in the keys of the map.\r
+ *\r
+ * @param key an <code>Object</code> value\r
+ * @return a <code>boolean</code> value\r
+ */\r
+ public boolean containsKey(Object key) {\r
+ return contains(key);\r
+ }\r
+\r
+ /**\r
+ * copies the key/value mappings in <tt>map</tt> into this map.\r
+ *\r
+ * @param map a <code>Map</code> value\r
+ */\r
+ public void putAll(Map<? extends K, ? extends V> map) {\r
+ ensureCapacity(map.size());\r
+ // could optimize this for cases when map instanceof THashMap\r
+ for (Iterator<? extends Map.Entry<? extends K,? extends V>> i = map.entrySet().iterator(); i.hasNext();) {\r
+ Map.Entry<? extends K,? extends V> e = i.next();\r
+ put(e.getKey(),e.getValue());\r
+ }\r
+ }\r
+ \r
+} // THashMap\r