/*
* Copyright (c) 2010 Lockheed Martin Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.eurekastreams.server.persistence.mappers.cache;
import java.util.List;
import org.apache.commons.logging.Log;
import org.eurekastreams.commons.logging.LogFactory;
import org.eurekastreams.server.persistence.mappers.DomainMapper;
import org.eurekastreams.server.persistence.mappers.stream.CachedDomainMapper;
/**
* Cache mapper to get a single list from cache.
*
* @param <KeySuffixType>
* suffix type
* @param <CachedValueType>
* type of entry in the result list
*/
public class SingleListValueCacheMapper<KeySuffixType, CachedValueType> extends CachedDomainMapper implements
DomainMapper<KeySuffixType, List<CachedValueType>>
{
/**
* Logger.
*/
private final Log log = LogFactory.make();
/**
* Cache key suffix transformer.
*/
private CacheKeySuffixTransformer<KeySuffixType> keySuffixTransformer;
/**
* Cache key prefix.
*/
private String cacheKeyPrefix;
/**
* Constructor.
*
* @param inCacheKeyPrefix
* the cache key prefix
* @param inKeySuffixTransformer
* the key suffix transformer
*/
public SingleListValueCacheMapper(final String inCacheKeyPrefix,
final CacheKeySuffixTransformer<KeySuffixType> inKeySuffixTransformer)
{
cacheKeyPrefix = inCacheKeyPrefix;
keySuffixTransformer = inKeySuffixTransformer;
}
/**
* Constructor.
*
* @param inKeySuffix
* suffixes to look for in cache
* @return a partial mapper response containing the data found and a new request of the key suffixes not found
*/
public List<CachedValueType> execute(final KeySuffixType inKeySuffix)
{
String cacheKey = cacheKeyPrefix + keySuffixTransformer.transform(inKeySuffix);
log.trace("Looking for cache key: " + cacheKey + " from " + inKeySuffix);
return (List<CachedValueType>) getCache().getList(cacheKey);
}
}