Content of file ImageModelCache.java.html

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../../jacoco-resources/report.gif" type="image/gif"/><title>ImageModelCache.java</title><link rel="stylesheet" href="../../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../../index.html" class="el_report">Mistral Processor</a> &gt; <a href="../index.html" class="el_bundle">image-core</a> &gt; <a href="index.source.html" class="el_package">it.tidalwave.image</a> &gt; <span class="el_source">ImageModelCache.java</span></div><h1>ImageModelCache.java</h1><pre class="source lang-java linenums">/*
 * *********************************************************************************************************************
 *
 * Mistral: open source imaging engine
 * http://tidalwave.it/projects/mistral
 *
 * Copyright (C) 2003 - 2023 by Tidalwave s.a.s. (http://tidalwave.it)
 *
 * *********************************************************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); 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 &quot;AS IS&quot; 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.
 *
 * *********************************************************************************************************************
 *
 * git clone https://bitbucket.org/tidalwave/mistral-src
 * git clone https://github.com/tidalwave-it/mistral-src
 *
 * *********************************************************************************************************************
 */
package it.tidalwave.image;

import java.io.Serializable;

/***********************************************************************************************************************
 *
 * A cache of ImageModels used for distributed computing. The purpose of the
 * cache is - quite obviously - to reduce the need for moving image through the
 * network among different computing nodes. 
 *
 * @author Fabrizio Giudici
 *
 **********************************************************************************************************************/
public abstract class ImageModelCache
  {
    /**
     * The default class.
     */
<span class="fc" id="L45">    private static Class&lt;? extends ImageModelCache&gt; defaultClass = DefaultImageModelCache.class;</span>

    /**
     * The singleton instance.
     */
    private static ImageModelCache instance;

    /*******************************************************************************************************************
     *
     *
     ******************************************************************************************************************/
    protected ImageModelCache()
<span class="fc" id="L57">      {</span>
<span class="fc" id="L58">      }</span>

    /*******************************************************************************************************************
     *
     * Sets the default implementation of the cache for the local VM.
     *
     * @param  defaultClass           the implementation class
     * @throws IllegalStateException  if a cache has been already instantiated
     *
     ******************************************************************************************************************/
    public static void setDefault (final Class&lt;? extends ImageModelCache&gt; defaultClass)
      {
//        if (instance != null)
//          {
//            throw new IllegalStateException(&quot;A local cache has been already instantiated&quot;);
//          }

<span class="nc" id="L75">        ImageModelCache.defaultClass = defaultClass;</span>
<span class="nc" id="L76">        instance = null;</span>
<span class="nc" id="L77">      }</span>

    /*******************************************************************************************************************
     *
     * Returns the default instance of the cache on the local VM.
     *
     * @return the local cache
     *
     ******************************************************************************************************************/
    public static synchronized ImageModelCache getInstance() // FIXME: rename to getDefault(), it's no more a singleton
      {
        try
          {
<span class="fc bfc" id="L90" title="All 2 branches covered.">            if (instance == null)</span>
              {
<span class="fc" id="L92">                instance = defaultClass.newInstance();</span>
              }

<span class="fc" id="L95">            return instance;</span>
          }
<span class="nc" id="L97">        catch (Exception e)</span>
          {
<span class="nc" id="L99">            throw new RuntimeException(e);</span>
          }
      }

    /*******************************************************************************************************************
     *
     * Adds an ImageModel to the cache. The image is always added only in the
     * local cache. Remote caches will pull the images they lack on demand.
     *
     * @param  imageModel  the ImageModel to add
     *
     ******************************************************************************************************************/
    public abstract void store (ImageModel imageModel);

    /*******************************************************************************************************************
     *
     * Updates an ImageModel in the cache. This means that all remote copies of
     * this image will be invalidated.
     *
     * TODO: should investigate more complex cases. Maybe the remote workers
should investigate more complex cases. Maybe the remote workers
* still want to work with a remote snapshot. Include versioning instead of * invalidating? * * @param imageModel the ImageModel to update * ******************************************************************************************************************/ public abstract void update (ImageModel imageModel); /******************************************************************************************************************* * * Removes an ImageModel from the cache. According to the value of the * &lt;code&gt;remote&lt;/code&gt; parameter, the operation is performed only locally * or also to remote caches. * * @param id the id of the ImageModel to remove * @param remove true if the operation must be performed also remotely * ******************************************************************************************************************/ public abstract void remove (Serializable id, boolean remote); /******************************************************************************************************************* * * Finds an ImageModel in the cache. According to the value of the * &lt;code&gt;remote&lt;/code&gt; parameter, the search is performed only locally * or also to remote caches. * * @param id the id of the ImageModel to remove * @param remove true if the operation must be performed also remotely * ******************************************************************************************************************/ public abstract ImageModel retrieve (Serializable id, boolean remote); /******************************************************************************************************************* * * Returns true if there's a local copy with the given id. * * @param id the id of the ImageModel to remove * @return true if there's a local copy * ******************************************************************************************************************/ public abstract boolean contains (Serializable id); } </pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.7.202105040129</span></div></body></html>