EDIT

package eu.etaxonomy.cdm.api.cache;

import java.util.UUID;

import net.sf.ehcache.config.CacheConfiguration;

import net.sf.ehcache.config.SizeOfPolicyConfiguration;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.stereotype.Component;

import eu.etaxonomy.cdm.api.service.ITermService;

import eu.etaxonomy.cdm.model.common.CdmBase;

import eu.etaxonomy.cdm.model.common.DefinedTermBase;

import eu.etaxonomy.taxeditor.remoting.cache.CacheLoader;

import eu.etaxonomy.taxeditor.remoting.cache.CdmTransientEntityCacher;

import eu.etaxonomy.taxeditor.service.TermServiceRequestExecutor;

/**

 * Class which uses CDM services to cache cdm entities

 *

 * FIXME: Currently only handles terms entities. It would be

 *        interesting to have a generic method which finds the

 *        correct service to load / cache the entity.

 *

 * @author cmathew

 *

 * @param <T>

 */

@Component

public class CdmServiceCacher extends CdmCacher{

    @Autowired

    ITermService termService;

    private CacheLoader cacheLoader;

    @Override

    protected void setup() {

        DefinedTermBase.setCacher(this);

        CdmTransientEntityCacher.setDefaultCacher(this);

        TermServiceRequestExecutor.setDefaultCacher(this);

        cacheLoader = new CacheLoader(this);

    }

    @Override

    protected CacheConfiguration getDefaultCacheConfiguration() {

        // For a better understanding on how to size caches, refer to

        // http://ehcache.org/documentation/configuration/cache-size

        SizeOfPolicyConfiguration sizeOfConfig = new SizeOfPolicyConfiguration();

        sizeOfConfig.setMaxDepth(100);

        sizeOfConfig.setMaxDepthExceededBehavior("abort");

        return new CacheConfiguration(DEFAULT_CACHE_NAME, 0)

        .eternal(true)

        .statistics(true)

        .sizeOfPolicy(sizeOfConfig)

        .overflowToOffHeap(false);

    }

    @Override

    protected CdmBase findByUuid(UUID uuid) {

        CdmBase term = termService.findWithoutFlush(uuid);

        return load(term);

    }

    /* (non-Javadoc)

     * @see eu.etaxonomy.cdm.model.ICdmCacher#isCachable(eu.etaxonomy.cdm.model.common.CdmBase)

     */

    @Override

    public boolean isCachable(CdmBase cdmEntity) {

        if(cdmEntity != null && cdmEntity instanceof DefinedTermBase) {

            return true;

        }

        return false;

    }

    /* (non-Javadoc)

     * @see eu.etaxonomy.cdm.api.cache.CdmCacher#load(eu.etaxonomy.cdm.model.common.CdmBase)

     */

    @Override

    public CdmBase load(CdmBase cdmEntity) {

        CdmBase cachedCdmEntity = getFromCache(cdmEntity);

        // NOTE : only when no cached cdm entity exists we

        // load the entire sub-graph, which means that the

        // sub-graph is never updated if the input

        // cdm entity graph is newer

        if(cachedCdmEntity == null && isCachable(cdmEntity)) {

            cachedCdmEntity =  cacheLoader.load(cdmEntity, true, false);

        }

        return cachedCdmEntity;

    }

}