mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
Entity cache for ID- and value-based lookups backed by DAO
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@15370 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
78
source/java/org/alfresco/repo/cache/MemoryCache.java
vendored
Normal file
78
source/java/org/alfresco/repo/cache/MemoryCache.java
vendored
Normal file
@@ -0,0 +1,78 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2009 Alfresco Software Limited.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU 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 General Public License for more details.
|
||||
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
|
||||
* As a special exception to the terms and conditions of version 2.0 of
|
||||
* the GPL, you may redistribute this Program in connection with Free/Libre
|
||||
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
||||
* FLOSS exception. You should have recieved a copy of the text describing
|
||||
* the FLOSS exception, and it is also available here:
|
||||
* http://www.alfresco.com/legal/licensing"
|
||||
*/
|
||||
package org.alfresco.repo.cache;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.Collection;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* A cache backed by a simple <code>HashMap</code>.
|
||||
* <p>
|
||||
* <b>Note:</b> This cache is not transaction- or thread-safe. Use it for single-threaded tests only.
|
||||
*
|
||||
* @author Derek Hulley
|
||||
* @since 3.2
|
||||
*/
|
||||
public class MemoryCache<K extends Serializable, V extends Object> implements SimpleCache<K, V>
|
||||
{
|
||||
private Map<K, V> map;
|
||||
|
||||
public MemoryCache()
|
||||
{
|
||||
map = new HashMap<K, V>(15);
|
||||
}
|
||||
|
||||
public boolean contains(K key)
|
||||
{
|
||||
return map.containsKey(key);
|
||||
}
|
||||
|
||||
public Collection<K> getKeys()
|
||||
{
|
||||
return map.keySet();
|
||||
}
|
||||
|
||||
public V get(K key)
|
||||
{
|
||||
return map.get(key);
|
||||
}
|
||||
|
||||
public void put(K key, V value)
|
||||
{
|
||||
map.put(key, value);
|
||||
}
|
||||
|
||||
public void remove(K key)
|
||||
{
|
||||
map.remove(key);
|
||||
}
|
||||
|
||||
public void clear()
|
||||
{
|
||||
map.clear();
|
||||
}
|
||||
}
|
||||
184
source/java/org/alfresco/repo/cache/lookup/EntityLookupCache.java
vendored
Normal file
184
source/java/org/alfresco/repo/cache/lookup/EntityLookupCache.java
vendored
Normal file
@@ -0,0 +1,184 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2009 Alfresco Software Limited.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU 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 General Public License for more details.
|
||||
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
|
||||
* As a special exception to the terms and conditions of version 2.0 of
|
||||
* the GPL, you may redistribute this Program in connection with Free/Libre
|
||||
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
||||
* FLOSS exception. You should have recieved a copy of the text describing
|
||||
* the FLOSS exception, and it is also available here:
|
||||
* http://www.alfresco.com/legal/licensing"
|
||||
*/
|
||||
package org.alfresco.repo.cache.lookup;
|
||||
|
||||
import java.io.Serializable;
|
||||
|
||||
import org.alfresco.repo.cache.SimpleCache;
|
||||
import org.alfresco.util.Pair;
|
||||
|
||||
/**
|
||||
* A cache for two-way lookups of database entities. These are characterized by having a unique
|
||||
* key (perhaps a database ID) and a separate unique key that identifies the object.
|
||||
* <p>
|
||||
* The keys must have good <code>equals</code> and </code>hashCode</code> implementations and
|
||||
* must respect the case-sensitivity of the use-case.
|
||||
*
|
||||
* @author Derek Hulley
|
||||
* @since 3.3
|
||||
*/
|
||||
public class EntityLookupCache<K extends Serializable, V extends Object, VK extends Serializable>
|
||||
{
|
||||
private static final String NULL_VALUE = "@@NULL_VALUE@@";
|
||||
|
||||
private final SimpleCache<Serializable, Object> cache;
|
||||
private final EntityLookup<K, V, VK> entityLookup;
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
public EntityLookupCache(SimpleCache cache, EntityLookup<K, V, VK> entityLookup)
|
||||
{
|
||||
this.cache = cache;
|
||||
this.entityLookup = entityLookup;
|
||||
}
|
||||
|
||||
/**
|
||||
* Interface to support lookups of the entities using keys and values.
|
||||
*/
|
||||
public static interface EntityLookup<K1 extends Serializable, V1 extends Object, VK1 extends Serializable>
|
||||
{
|
||||
/**
|
||||
* Resolve the given value into a unique value key that can be used to find the entity's ID.
|
||||
* <p>
|
||||
* Implementations will often return the value itself, provided that the value is both
|
||||
* serializable and has a good <code>equals</code> and <code>hashCode</code>.
|
||||
*
|
||||
* @param value the full value being keyed
|
||||
* @return Returns the business key representing the entity
|
||||
*/
|
||||
VK1 getValueKey(V1 value);
|
||||
|
||||
/**
|
||||
* Find an entity for a given key.
|
||||
*
|
||||
* @param key the key (ID) used to identify the entity
|
||||
* @return Return the entity or <tt>null</tt> if no entity is exists for the ID
|
||||
*/
|
||||
Pair<K1, V1> findByKey(K1 key);
|
||||
|
||||
/**
|
||||
* Find and entity using the given value key. The <code>equals</code> and <code>hashCode</code>
|
||||
* methods of the value object should respect case-sensitivity in the same way that this
|
||||
* lookup treats case-sensitivity i.e. if the <code>equals</code> method is <b>case-sensitive</b>
|
||||
* then this method should look the entity up using a <b>case-sensitive</b> search. Where the
|
||||
* behaviour is configurable,
|
||||
*
|
||||
* @param value the value (business object) used to identify the entity
|
||||
* @return Return the entity or <tt>null</tt> if no entity matches the given value
|
||||
*/
|
||||
Pair<K1, V1> findByValue(V1 value);
|
||||
|
||||
Pair<K1, V1> createValue(V1 value);
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
Pair<K, V> getByKey(K key)
|
||||
{
|
||||
// Look in the cache
|
||||
V value = (V) cache.get(key);
|
||||
if (value != null && value.equals(NULL_VALUE))
|
||||
{
|
||||
// We checked before
|
||||
return null;
|
||||
}
|
||||
else if (value != null)
|
||||
{
|
||||
return new Pair<K, V>(key, value);
|
||||
}
|
||||
// Resolve it
|
||||
Pair<K, V> entityPair = entityLookup.findByKey(key);
|
||||
if (entityPair == null)
|
||||
{
|
||||
// Cache nulls
|
||||
cache.put(key, NULL_VALUE);
|
||||
}
|
||||
else
|
||||
{
|
||||
// Cache the value
|
||||
cache.put(key, entityPair.getSecond());
|
||||
}
|
||||
// Done
|
||||
return entityPair;
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
Pair<K, V> getByValue(V value)
|
||||
{
|
||||
// Get the value key
|
||||
VK valueKey = entityLookup.getValueKey(value);
|
||||
// Look in the cache
|
||||
K key = (K) cache.get(valueKey);
|
||||
// Check if we have looked this up already
|
||||
if (key != null && key.equals(NULL_VALUE))
|
||||
{
|
||||
// We checked before
|
||||
return null;
|
||||
}
|
||||
else if (key != null)
|
||||
{
|
||||
return new Pair<K, V>(key, value);
|
||||
}
|
||||
// Resolve it
|
||||
Pair<K, V> entityPair = entityLookup.findByValue(value);
|
||||
if (entityPair == null)
|
||||
{
|
||||
// Cache a null
|
||||
cache.put(valueKey, NULL_VALUE);
|
||||
}
|
||||
else
|
||||
{
|
||||
// Cache the key
|
||||
cache.put(valueKey, key);
|
||||
}
|
||||
// Done
|
||||
return entityPair;
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
Pair<K, V> getOrCreateByValue(V value)
|
||||
{
|
||||
// Get the value key
|
||||
VK valueKey = entityLookup.getValueKey(value);
|
||||
// Look in the cache
|
||||
K key = (K) cache.get(valueKey);
|
||||
// Check if the value is already mapped to a key
|
||||
if (key != null && !key.equals(NULL_VALUE))
|
||||
{
|
||||
return new Pair<K, V>(key, value);
|
||||
}
|
||||
// Resolve it
|
||||
Pair<K, V> entityPair = entityLookup.findByValue(value);
|
||||
if (entityPair == null)
|
||||
{
|
||||
// Create it
|
||||
entityPair = entityLookup.createValue(value);
|
||||
}
|
||||
key = entityPair.getFirst();
|
||||
// Cache the key and value
|
||||
cache.put(valueKey, key);
|
||||
cache.put(key, value);
|
||||
// Done
|
||||
return entityPair;
|
||||
}
|
||||
}
|
||||
218
source/java/org/alfresco/repo/cache/lookup/EntityLookupCacheTest.java
vendored
Normal file
218
source/java/org/alfresco/repo/cache/lookup/EntityLookupCacheTest.java
vendored
Normal file
@@ -0,0 +1,218 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2009 Alfresco Software Limited.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU 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 General Public License for more details.
|
||||
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
|
||||
* As a special exception to the terms and conditions of version 2.0 of
|
||||
* the GPL, you may redistribute this Program in connection with Free/Libre
|
||||
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
||||
* FLOSS exception. You should have recieved a copy of the text describing
|
||||
* the FLOSS exception, and it is also available here:
|
||||
* http://www.alfresco.com/legal/licensing"
|
||||
*/
|
||||
package org.alfresco.repo.cache.lookup;
|
||||
|
||||
import java.util.Map;
|
||||
import java.util.TreeMap;
|
||||
|
||||
import junit.framework.AssertionFailedError;
|
||||
import junit.framework.TestCase;
|
||||
|
||||
import org.alfresco.repo.cache.MemoryCache;
|
||||
import org.alfresco.repo.cache.SimpleCache;
|
||||
import org.alfresco.repo.cache.lookup.EntityLookupCache.EntityLookup;
|
||||
import org.alfresco.util.Pair;
|
||||
|
||||
/**
|
||||
* A cache for two-way lookups of database entities. These are characterized by having a unique
|
||||
* key (perhaps a database ID) and a separate unique key that identifies the object.
|
||||
* <p>
|
||||
* The keys must have good <code>equals</code> and </code>hashCode</code> implementations and
|
||||
* must respect the case-sensitivity of the use-case.
|
||||
*
|
||||
* @author Derek Hulley
|
||||
* @since 3.3
|
||||
*/
|
||||
public class EntityLookupCacheTest extends TestCase implements EntityLookup<Long, Object, String>
|
||||
{
|
||||
private EntityLookupCache<Long, Object, String> entityLookupCache;
|
||||
private TreeMap<Long, String> database;
|
||||
|
||||
@Override
|
||||
protected void setUp() throws Exception
|
||||
{
|
||||
SimpleCache<Long, Object> cache = new MemoryCache<Long, Object>();
|
||||
entityLookupCache = new EntityLookupCache<Long, Object, String>(cache, this);
|
||||
database = new TreeMap<Long, String>();
|
||||
}
|
||||
|
||||
public void testLookupsUsingIncorrectValue() throws Exception
|
||||
{
|
||||
try
|
||||
{
|
||||
// Keep the "database" empty
|
||||
entityLookupCache.getByValue(this);
|
||||
}
|
||||
catch (AssertionFailedError e)
|
||||
{
|
||||
// Expected
|
||||
}
|
||||
}
|
||||
|
||||
public void testLookupAgainstEmpty() throws Exception
|
||||
{
|
||||
TestValue value = new TestValue("AAA");
|
||||
Pair<Long, Object> entityPair = entityLookupCache.getByValue(value);
|
||||
assertNull(entityPair);
|
||||
assertTrue(database.isEmpty());
|
||||
|
||||
// Now do lookup or create
|
||||
entityPair = entityLookupCache.getOrCreateByValue(value);
|
||||
assertNotNull("Expected a value to be found", entityPair);
|
||||
Long entityId = entityPair.getFirst();
|
||||
assertTrue("Database ID should have been created", database.containsKey(entityId));
|
||||
assertEquals("Database value incorrect", value.val, database.get(entityId));
|
||||
|
||||
// Do lookup or create again
|
||||
entityPair = entityLookupCache.getOrCreateByValue(value);
|
||||
assertNotNull("Expected a value to be found", entityPair);
|
||||
assertEquals("Expected same entity ID", entityId, entityPair.getFirst());
|
||||
|
||||
// Look it up using the value
|
||||
entityPair = entityLookupCache.getByValue(value);
|
||||
assertNotNull("Lookup after create should work", entityPair);
|
||||
|
||||
// Look it up using the ID
|
||||
entityPair = entityLookupCache.getByKey(entityId);
|
||||
assertNotNull("Lookup by key should work after create", entityPair);
|
||||
assertTrue("Looked-up type incorrect", entityPair.getSecond() instanceof TestValue);
|
||||
assertEquals("Looked-up type value incorrect", value, entityPair.getSecond());
|
||||
}
|
||||
|
||||
public void testLookupAgainstExisting() throws Exception
|
||||
{
|
||||
// Put some values in the "database"
|
||||
createValue(new TestValue("AAA"));
|
||||
createValue(new TestValue("BBB"));
|
||||
createValue(new TestValue("CCC"));
|
||||
|
||||
// Look up by value
|
||||
Pair<Long, Object> entityPair = entityLookupCache.getByValue(new TestValue("AAA"));
|
||||
assertNotNull("Expected value to be found", entityPair);
|
||||
assertEquals("ID is incorrect", new Long(1), entityPair.getFirst());
|
||||
|
||||
// Look up by ID
|
||||
entityPair = entityLookupCache.getByKey(new Long(2));
|
||||
assertNotNull("Expected value to be found", entityPair);
|
||||
|
||||
// Do lookup or create
|
||||
entityPair = entityLookupCache.getByValue(new TestValue("CCC"));
|
||||
assertNotNull("Expected value to be found", entityPair);
|
||||
assertEquals("ID is incorrect", new Long(3), entityPair.getFirst());
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper class to represent business object
|
||||
*/
|
||||
private static class TestValue
|
||||
{
|
||||
private final String val;
|
||||
private TestValue(String val)
|
||||
{
|
||||
this.val = val;
|
||||
}
|
||||
@Override
|
||||
public boolean equals(Object obj)
|
||||
{
|
||||
if (obj == null || !(obj instanceof TestValue))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
return val.equals( ((TestValue)obj).val );
|
||||
}
|
||||
@Override
|
||||
public int hashCode()
|
||||
{
|
||||
return val.hashCode();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getValueKey(Object value)
|
||||
{
|
||||
assertNotNull(value);
|
||||
assertTrue(value instanceof TestValue);
|
||||
String dbValue = ((TestValue)value).val;
|
||||
return dbValue;
|
||||
}
|
||||
|
||||
/**
|
||||
* Simulate creation of a new database entry
|
||||
*/
|
||||
@Override
|
||||
public Pair<Long, Object> createValue(Object value)
|
||||
{
|
||||
assertNotNull(value);
|
||||
assertTrue(value instanceof TestValue);
|
||||
String dbValue = ((TestValue)value).val;
|
||||
|
||||
// Get the last key
|
||||
Long lastKey = database.isEmpty() ? null : database.lastKey();
|
||||
Long newKey = null;
|
||||
if (lastKey == null)
|
||||
{
|
||||
newKey = new Long(1);
|
||||
}
|
||||
else
|
||||
{
|
||||
newKey = new Long(lastKey.longValue() + 1);
|
||||
}
|
||||
database.put(newKey, dbValue);
|
||||
return new Pair<Long, Object>(newKey, value);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Pair<Long, Object> findByKey(Long key)
|
||||
{
|
||||
assertNotNull(key);
|
||||
|
||||
String dbValue = database.get(key);
|
||||
if (dbValue == null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
// Make a value object
|
||||
TestValue value = new TestValue(dbValue);
|
||||
return new Pair<Long, Object>(key, value);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Pair<Long, Object> findByValue(Object value)
|
||||
{
|
||||
assertNotNull(value);
|
||||
assertTrue(value instanceof TestValue);
|
||||
String dbValue = ((TestValue)value).val;
|
||||
|
||||
for (Map.Entry<Long, String> entry : database.entrySet())
|
||||
{
|
||||
if (entry.getValue().equals(dbValue))
|
||||
{
|
||||
return new Pair<Long, Object>(entry.getKey(), entry.getValue());
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user