/*
* 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.domain.propval;
import java.io.Serializable;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.repo.cache.SimpleCache;
import org.alfresco.repo.cache.lookup.EntityLookupCache;
import org.alfresco.repo.cache.lookup.EntityLookupCache.EntityLookupCallbackDAO;
import org.alfresco.repo.domain.CrcHelper;
import org.alfresco.util.Pair;
/**
* Abstract implementation for Property Value DAO.
*
* This provides basic services such as caching, but defers to the underlying implementation
* for CRUD operations.
*
* @author Derek Hulley
* @since 3.3
*/
public abstract class AbstractPropertyValueDAOImpl implements PropertyValueDAO
{
private static final String CACHE_REGION_PROPERTY_CLASS = "PropertyClass";
private static final String CACHE_REGION_PROPERTY_STRING_VALUE = "PropertyStringValue";
private final PropertyClassCallbackDAO propertyClassDaoCallback;
private final PropertyStringValueCallbackDAO propertyStringValueCallback;
/**
* Cache for the property class:
* KEY: ID
* VALUE: Java class
* VALUE KEY: Java class name
*/
private EntityLookupCache, String> propertyClassCache;
/**
* Cache for the property string value:
* KEY: ID
* VALUE: The full string
* VALUE KEY: Short string-crc pair ({@link CrcHelper#getStringCrcPair(String, int, boolean, boolean)})
*/
private EntityLookupCache> propertyStringValueCache;
/**
* Default constructor.
*
* This sets up the DAO accessors to bypass any caching to handle the case where the caches are not
* supplied in the setters.
*/
public AbstractPropertyValueDAOImpl()
{
this.propertyClassDaoCallback = new PropertyClassCallbackDAO();
this.propertyStringValueCallback = new PropertyStringValueCallbackDAO();
this.propertyClassCache = new EntityLookupCache, String>(propertyClassDaoCallback);
this.propertyStringValueCache = new EntityLookupCache>(propertyStringValueCallback);
}
/**
* Set the cache to use for alf_prop_class lookups (optional).
*
* @param propertyClassCache the cache of IDs to property classes
*/
public void setPropertyClassCache(SimpleCache propertyClassCache)
{
this.propertyClassCache = new EntityLookupCache, String>(
propertyClassCache,
CACHE_REGION_PROPERTY_CLASS,
propertyClassDaoCallback);
}
/**
* Set the cache to use for alf_prop_string_value lookups (optional).
*
* @param propertyStringValueCache the cache of IDs to property string values
*/
public void setPropertyStringValueCache(SimpleCache propertyStringValueCache)
{
this.propertyStringValueCache = new EntityLookupCache>(
propertyStringValueCache,
CACHE_REGION_PROPERTY_STRING_VALUE,
propertyStringValueCallback);
}
//================================
// 'alf_prop_class' accessors
//================================
public Pair> getPropertyClass(Long id)
{
Pair> entityPair = propertyClassCache.getByKey(id);
if (entityPair == null)
{
throw new AlfrescoRuntimeException("No property class exists for ID " + id);
}
return entityPair;
}
public Pair> getPropertyClass(Class> value)
{
Pair> entityPair = propertyClassCache.getByValue(value);
return entityPair;
}
public Pair> getOrCreatePropertyClass(Class> value)
{
Pair> entityPair = propertyClassCache.getOrCreateByValue(value);
return entityPair;
}
/**
* Callback for alf_prop_class DAO.
*/
private class PropertyClassCallbackDAO implements EntityLookupCallbackDAO, String>
{
private final Pair> convertEntityToPair(PropertyClassEntity propertyClassEntity)
{
if (propertyClassEntity == null)
{
return null;
}
else
{
return propertyClassEntity.getEntityPair();
}
}
public String getValueKey(Class> value)
{
return value.getName();
}
public Pair> createValue(Class> value)
{
PropertyClassEntity entity = createClass(value);
return convertEntityToPair(entity);
}
public Pair> findByKey(Long key)
{
PropertyClassEntity entity = findClassById(key);
return convertEntityToPair(entity);
}
public Pair> findByValue(Class> value)
{
PropertyClassEntity entity = findClassByValue(value);
return convertEntityToPair(entity);
}
}
protected abstract PropertyClassEntity findClassById(Long id);
protected abstract PropertyClassEntity findClassByValue(Class> value);
protected abstract PropertyClassEntity createClass(Class> value);
//================================
// 'alf_prop_string_value' accessors
//================================
public Pair getPropertyStringValue(Long id)
{
Pair entityPair = propertyStringValueCache.getByKey(id);
if (entityPair == null)
{
throw new AlfrescoRuntimeException("No property class exists for ID " + id);
}
return entityPair;
}
public Pair getPropertyStringValue(String value)
{
Pair entityPair = propertyStringValueCache.getByValue(value);
return entityPair;
}
public Pair getOrCreatePropertyStringValue(String value)
{
Pair entityPair = propertyStringValueCache.getOrCreateByValue(value);
return entityPair;
}
/**
* Callback for alf_prop_string_value DAO.
*/
private class PropertyStringValueCallbackDAO implements EntityLookupCallbackDAO>
{
private final Pair convertEntityToPair(PropertyStringValueEntity propertyStringValueEntity)
{
if (propertyStringValueEntity == null)
{
return null;
}
else
{
return propertyStringValueEntity.getEntityPair();
}
}
public Pair getValueKey(String value)
{
return CrcHelper.getStringCrcPair(value, 128, true, true);
}
public Pair createValue(String value)
{
PropertyStringValueEntity entity = createStringValue(value);
return convertEntityToPair(entity);
}
public Pair findByKey(Long key)
{
PropertyStringValueEntity entity = findStringValueById(key);
return convertEntityToPair(entity);
}
public Pair findByValue(String value)
{
PropertyStringValueEntity entity = findStringValueByValue(value);
return convertEntityToPair(entity);
}
}
protected abstract PropertyStringValueEntity findStringValueById(Long id);
protected abstract PropertyStringValueEntity findStringValueByValue(String value);
protected abstract PropertyStringValueEntity createStringValue(String value);
}