/*
* eXist Open Source Native XML Database
* Copyright (C) 2001-06 Wolfgang M. Meier
* wolfgang@exist-db.org
* http://exist.sourceforge.net
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* $Id$
*/
package org.exist.util.hashtable;
import java.util.Iterator;
/**
* A hashtable which maps int keys to object values.
*
* @author Stephan Körnig
* @author Wolfgang Meier (wolfgang@exist-db.org)
*/
public class Int2ObjectHashMap extends AbstractHashtable {
protected int[] keys;
protected Object[] values;
protected double growthFactor = 1.5;
public Int2ObjectHashMap() {
super();
keys = new int[tabSize];
values = new Object[tabSize];
}
public Int2ObjectHashMap(int iSize) {
this(iSize, 1.5);
}
public Int2ObjectHashMap(int iSize, double growth) {
super(iSize);
keys = new int[tabSize];
values = new Object[tabSize];
growthFactor = growth;
}
public void clear() {
items = 0;
keys = new int[tabSize];
values = new Object[tabSize];
}
/**
* Puts a new key/value pair into the hashtable.
*
* If the key does already exist, just the value is updated.
*
* @param key
* @param value
*/
public void put(int key, Object value) {
try {
insert(key, value);
} catch (HashtableOverflowException e) {
int[] copyKeys = keys;
Object[] copyValues = values;
// enlarge the table with a prime value
tabSize = (int) nextPrime((int) (tabSize * growthFactor));
keys = new int[tabSize];
values = new Object[tabSize];
items = 0;
for (int k = 0; k < copyValues.length; k++) {
if (copyValues[k] != null && copyValues[k] != REMOVED)
put(copyKeys[k], copyValues[k]);
}
put(key, value);
}
}
public Object get(int key) {
int idx = hash(key) % tabSize;
if (idx < 0)
idx *= -1;
if (values[idx] == null)
return null; // key does not exist
else if (keys[idx] == key) {
if (values[idx] == REMOVED)
return null;
return values[idx];
}
int rehashVal = rehash(idx);
for (int i = 0; i < tabSize; i++) {
idx = (idx + rehashVal) % tabSize;
if (values[idx] == null) {
return null; // key not found
} else if (keys[idx] == key) {
if (values[idx] == REMOVED)
return null;
return values[idx];
}
}
return null;
}
public boolean containsKey(int key) {
int idx = hash(key) % tabSize;
if (idx < 0)
idx *= -1;
if (values[idx] == null)
return false; // key does not exist
else if (keys[idx] == key) {
if (values[idx] == REMOVED)
return false;
return true;
}
int rehashVal = rehash(idx);
for (int i = 0; i < tabSize; i++) {
idx = (idx + rehashVal) % tabSize;
if (values[idx] == null) {
return false; // key not found
} else if (keys[idx] == key) {
if (values[idx] == REMOVED)
return false;
return true;
}
}
return false;
}
public Object remove(int key) {
int idx = hash(key) % tabSize;
if (idx < 0)
idx *= -1;
if (values[idx] == null) {
// System.out.println(key + " not found for remove");
return null; // key does not exist
} else if (keys[idx] == key) {
if (values[idx] == REMOVED)
return null; // key has already been removed
Object o = values[idx];
values[idx] = REMOVED;
--items;
return o;
}
int rehashVal = rehash(idx);
for (int i = 0; i < tabSize; i++) {
idx = (idx + rehashVal) % tabSize;
if (values[idx] == null) {
// System.out.println(key + " not found for remove");
return null; // key not found
} else if (keys[idx] == key) {
if (values[idx] == REMOVED)
return null; // key has already been removed
Object o = values[idx];
values[idx] = REMOVED;
--items;
return o;
}
}
return null;
}
public Iterator iterator() {
return new Int2ObjectIterator(Int2ObjectIterator.KEYS);
}
public Iterator valueIterator() {
return new Int2ObjectIterator(Int2ObjectIterator.VALUES);
}
protected void insert(int key, Object value) throws HashtableOverflowException {
if (value == null)
throw new IllegalArgumentException("Illegal value: null");
int idx = hash(key) % tabSize;
if (idx < 0)
idx *= -1;
int bucket = -1;
// look for an empty bucket
if (values[idx] == null) {
keys[idx] = key;
values[idx] = value;
++items;
return;
} else if (values[idx] == REMOVED) {
// remember the bucket, but continue to check
// for duplicate keys
bucket = idx;
} else if (keys[idx] == key) {
// duplicate value
values[idx] = value;
return;
}
int rehashVal = rehash(idx);
int rehashCnt = 1;
for (int i = 0; i < tabSize; i++) {
idx = (idx + rehashVal) % tabSize;
if (values[idx] == REMOVED) {
bucket = idx;
} else if (values[idx] == null) {
if (bucket > -1) {
// store key into the empty bucket first found
idx = bucket;
}
keys[idx] = key;
values[idx] = value;
++items;
return;
} else if (keys[idx] == key) {
// duplicate value
values[idx] = value;
return;
}
++rehashCnt;
}
// should never happen, but just to be sure:
// if the key has not been inserted yet, do it now
if (bucket > -1) {
keys[bucket] = key;
values[bucket] = value;
++items;
return;
}
throw new HashtableOverflowException();
}
protected boolean hasEqualKeys(Int2ObjectHashMap other) {
for(int idx = 0; idx < tabSize; idx++) {
if(values[idx] == null || values[idx] == REMOVED)
continue;
if(!other.containsKey(keys[idx]))
return false;
}
return true;
}
protected int rehash(int iVal) {
int retVal = (iVal + iVal / 2) % tabSize;
if (retVal == 0)
retVal = 1;
return retVal;
}
protected static int hash(int i) {
return i;
}
protected class Int2ObjectIterator extends HashtableIterator {
int idx = 0;
public Int2ObjectIterator(int type) {
super(type);
}
/* (non-Javadoc)
* @see java.util.Iterator#hasNext()
*/
public boolean hasNext() {
if (idx == tabSize)
return false;
while (values[idx] == null || values[idx] == REMOVED) {
++idx;
if (idx == tabSize)
return false;
}
return true;
}
/* (non-Javadoc)
* @see java.util.Iterator#next()
*/
public Object next() {
if (idx == tabSize)
return null;
while (values[idx] == null || values[idx] == REMOVED) {
++idx;
if (idx == tabSize)
return null;
}
if (returnType == VALUES)
return values[idx++];
else
return new Integer(keys[idx++]);
}
/* (non-Javadoc)
* @see org.exist.util.hashtable.AbstractHashtable.HashtableIterator#remove()
*/
public void remove() {
if(idx == 0)
throw new IllegalStateException("remove called before next");
values[idx - 1] = REMOVED;
items--;
}
}
}