fiftyone.pipeline.engines.caching.DataKeyedCacheBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pipeline.engines Show documentation
Shared base functionality for implementing engines for the 51Degrees Pipeline API
There is a newer version: 4.4.61
/* *********************************************************************
 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
 * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
 *
 * This Original Work is licensed under the European Union Public Licence
 * (EUPL) v.1.2 and is subject to its terms as set out below.
 *
 * If a copy of the EUPL was not distributed with this file, You can obtain
 * one at https://opensource.org/licenses/EUPL-1.2.
 *
 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
 * amended by the European Commission) shall be deemed incompatible for
 * the purposes of the Work and the provisions of the compatibility
 * clause in Article 5 of the EUPL shall not apply.
 *
 * If using the Work as, or as part of, a network application, by
 * including the attribution notice(s) required under Article 5 of the EUPL
 * in the end user terms of the application under an appropriate heading,
 * such notice(s) shall fulfill the requirements of that article.
 * ********************************************************************* */

package fiftyone.pipeline.engines.caching;

import fiftyone.caching.PutCache;
import fiftyone.pipeline.core.data.DataKey;
import fiftyone.pipeline.core.data.EvidenceKeyFilter;
import fiftyone.pipeline.core.data.FlowData;
import fiftyone.pipeline.engines.configuration.CacheConfiguration;

import java.io.IOException;

/**
 * Abstract base class for caches that use {@link FlowData} as the key.
 * Internally, the cache actually uses a {@link DataKey} instance derived from
 * {@link FlowData}.
 * @see Specification
 * @param  the type of data to store in the cache
 */
public abstract class DataKeyedCacheBase implements DataKeyedCache {

    /**
     * The cache that is actually used to store the data internally.
     */
    private PutCache internalCache;

    /**
     * Construct a new instance.
     * @param configuration the cache configuration to use when creating the
     *                      internal cache
     */
    public DataKeyedCacheBase(CacheConfiguration configuration) {
        try {
            internalCache = (PutCache) configuration
                .getCacheBuilder()
                .build(internalCache, configuration.getSize());
        } catch (ClassCastException e) {
            throw new ClassCastException(
                "Cache builder '" +
                    configuration.getCacheBuilder().getClass().getSimpleName() +
                    "' does not produce caches conforming to 'PutCache'");
        }
    }

    /**
     * Returns the {@link EvidenceKeyFilter} to use when generating a key from
     * {@link FlowData} instances. Only evidence values that the filter includes
     * will be used to create the key.
     * @return an {@link EvidenceKeyFilter} instance
     */
    protected abstract EvidenceKeyFilter getFilter();

    @Override
    public V get(FlowData flowData) {
        return internalCache.get(flowData.generateKey(getFilter()));
    }

    @Override
    public void put(FlowData flowData, V value) {
        internalCache.put(flowData.generateKey(getFilter()), value);
    }

    @Override
    public void close() throws IOException {
        internalCache.close();
    }
}