Changeset 1024

Timestamp:

10/09/06 15:25:26 (2 years ago)

Author:

jmoore

Message:

#334 Merged RenderingEngineImpl? into RenderingBean? (also for #212 and #326)

Location:

trunk/components

Files:

• common/src/omeis/providers/re/RenderingEngine.java (modified) (2 diffs)
• rendering/src/omeis/providers/re/RenderingEngineImpl.java (deleted)
• server/resources/ome/services/service-ome.api.IThumb.xml (modified) (1 diff)
• server/resources/ome/services/service-omeis.providers.re.RenderingEngine.xml (modified) (2 diffs)
• server/src/ome/services/RenderingBean.java (modified) (8 diffs)

trunk/components/common/src/omeis/providers/re/RenderingEngine.java

@@ -43 +43 @@
 import ome.model.enums.Family;
 import ome.model.enums.RenderingModel;
+import ome.model.meta.Event;
+import ome.system.EventContext;
 import ome.system.SelfConfigurableService;
 import omeis.providers.re.codomain.CodomainMapContext;
@@ -115 +117 @@
         public void load();
     
+        /** Returns the current {@link EventContext} for this instance. This is
+         * useful for later identifying changes made by this {@link Event}.
+         */
+        public EventContext getCurrentEventContext();
+        
         /**
      * Specifies the model that dictates how transformed raw data has to be 

trunk/components/server/resources/ome/services/service-ome.api.IThumb.xml

@@ -38 +38 @@
   <bean parent="level2" id="internal:ome.api.IThumb" class="ome.logic.ThumbImpl">
     <property name="ioService" ref="/OME/OMEIS/Thumbs"/>
-    <property name="renderingEngine" ref="internal:ome.services.RenderingWrapper"/>
+    <property name="renderingEngine" ref="internal:omeis.providers.re.RenderingEngine"/>
     <property name="scaleService" ref="internal:ome.api.IScale"/>
   </bean>

trunk/components/server/resources/ome/services/service-omeis.providers.re.RenderingEngine.xml

@@ -36 +36 @@
 <beans> 
 
-  <bean singleton="false" parent="binary"
+  <bean singleton="false" parent="level2"
         id="internal:omeis.providers.re.RenderingEngine" 
-     class="omeis.providers.re.RenderingEngineImpl">
+     class="ome.services.RenderingBean">
+        <!-- following copied from parent="binary" -->
+    <property name="pixelsMetadata" ref="internal:ome.api.IPixels"/>
+    <property name="pixelsData"     ref="/OME/OMEIS/Pixels"/>
   </bean>
 
@@ -46 +49 @@
   </bean>
 
-  <bean singleton="false" parent="level2"
-        id="internal:ome.services.RenderingWrapper" 
-     class="ome.services.RenderingBean">
-     <property name="delegate" ref="internal:omeis.providers.re.RenderingEngine"/>
-  </bean>
-  
-  <bean id="managed:ome.services.RenderingWrapper" parent="managedService">
-    <property name="proxyInterfaces" value="ome.services.RenderingWrapper"/>
-    <property name="target" ref="internal:omeis.providers.re.RenderingEngine"/>
-  </bean>
 </beans>

trunk/components/server/src/ome/services/RenderingBean.java

@@ -31 +31 @@
 
 // Java imports
+import java.io.IOException;
 import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
 
 import javax.annotation.PostConstruct;
@@ -48 +50 @@
 
 // Third-party libraries
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.jboss.annotation.ejb.LocalBinding;
 import org.jboss.annotation.ejb.RemoteBinding;
@@ -53 +57 @@
 import org.jboss.annotation.security.SecurityDomain;
 import org.jboss.ejb3.cache.NoPassivationCache;
+import org.springframework.transaction.annotation.Transactional;
 
 // Application-internal dependencies
 import ome.annotations.RevisionDate;
 import ome.annotations.RevisionNumber;
+import ome.api.IPixels;
 import ome.api.ServiceInterface;
+import ome.conditions.ApiUsageException;
+import ome.conditions.InternalException;
+import ome.conditions.ResourceError;
+import ome.conditions.ValidationException;
+import ome.io.nio.PixelBuffer;
+import ome.io.nio.PixelsService;
 import ome.logic.AbstractLevel2Service;
 import ome.model.IObject;
 import ome.model.core.Channel;
 import ome.model.core.Pixels;
+import ome.model.display.ChannelBinding;
 import ome.model.display.QuantumDef;
+import ome.model.display.RenderingDef;
 import ome.model.enums.Family;
 import ome.model.enums.RenderingModel;
+import ome.system.EventContext;
+import ome.system.SimpleEventContext;
 import ome.util.ShallowCopy;
 
 import omeis.providers.re.RGBBuffer;
+import omeis.providers.re.Renderer;
 import omeis.providers.re.RenderingEngine;
-import omeis.providers.re.RenderingEngineImpl;
 import omeis.providers.re.codomain.CodomainMapContext;
 import omeis.providers.re.data.PlaneDef;
-
-interface RenderingWrapper extends RenderingEngine {}
+import omeis.providers.re.quantum.QuantizationException;
 
 /**
- * Provides the {@link RenderingEngine} service. This class is a serializable 
- * wrapper around {@link RenderingEngineImpl}.
+ * Provides the {@link RenderingEngine} service. This class is an Adapter to
+ * wrap the {@link Renderer} so to make it thread-safe.
+ * <p>
+ * The multi-threaded design of this component is based on dynamic locking and
+ * confinement techiniques. All access to the component's internal parts happens
+ * through a <code>RenderingEngineImpl</code> object, which is fully
+ * synchronized. Internal parts are either never leaked out or given away only
+ * if read-only objects. (The only exception are the {@link CodomainMapContext}
+ * objects which are not read-only but are copied upon every method invocation
+ * so to maintain safety.)
+ * </p>
+ * <p>
+ * Finally the {@link RenderingEngine} component doesn't make use of constructs
+ * that could compromise liveness.
+ * </p>
  * 
- * @author  Josh Moore, josh.moore at gmx.de
+ * @author Jean-Marie Burel &nbsp;&nbsp;&nbsp;&nbsp; <a
+ *         href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
+ * @author <br>
+ *         Andrea Falconi &nbsp;&nbsp;&nbsp;&nbsp; <a
+ *         href="mailto:a.falconi@dundee.ac.uk"> a.falconi@dundee.ac.uk</a>
+ * @version 2.2 <small> (<b>Internal version:</b> $Revision: 1.4 $ $Date:
+ *          2005/07/05 16:13:52 $) </small>
+ * @since OME2.2
+ * @author Andrea Falconi, a.falconi at dundee.ac.uk
+ * @author Chris Allan, callan at blackcat.ca
+ * @author Jean-Marie Burel, j.burel at dundee.ac.uk
+ * @author Josh Moore, josh.moore at gmx.de
  * @version $Revision$, $Date$
- * @since   3.0-M3
+ * @see RenderingEngine
+ * @since 3.0-M3
  */
 @RevisionDate("$Date$")
 @RevisionNumber("$Revision$")
+
 @Stateful
 @Remote(RenderingEngine.class)
@@ -92 +133 @@
 @SecurityDomain("OmeroSecurity")
 @Cache(NoPassivationCache.class)
+@Transactional // TODO previously not here. examine the difference.
 public class RenderingBean extends AbstractLevel2Service 
-    implements RenderingWrapper, Serializable
+    implements RenderingEngine, Serializable
 {
 
-    private static final long serialVersionUID = -4383698215540637038L;
-
-    private transient RenderingEngine delegate;
-
-    public final void setDelegate(RenderingEngine delegate) {
-        throwIfAlreadySet(this.delegate, delegate);
-                this.delegate = delegate;
-        }
+    private static final long serialVersionUID = -4383698215540637039L;
+    
+    private static final Log log = LogFactory.getLog(RenderingBean.class);
     
     @Override
     protected Class<? extends ServiceInterface> getServiceInterface() {
-        return RenderingWrapper.class;
+        return RenderingEngine.class;
+    }
+    
+    // ~ State
+        // =========================================================================
+    
+    /*
+     * LIFECYCLE: 
+     * 1. new() || new(Services[]) 
+     * 2. (lookupX || useX)+ && load  
+     * 3. call methods 
+     * 4. optionally: return to 2.
+     * 5. destroy() 
+     *
+     * TODO: when a setXXX() method is called, when do I reload? always?
+     * or ondirty?
+     */
+
+    /**
+     * Transforms the raw data. Entry point to the unsych parts of the component.
+     * As soon as Renderer is not null, the Engine is ready to use.
+     */
+    private transient Renderer                       renderer;
+    
+    /** The pixels set to the rendering engine is for. */
+    private transient Pixels                         pixelsObj;
+    
+    /** The rendering settings associated to the pixels set. */
+    private transient RenderingDef                   rendDefObj;
+    
+    /** Reference to the service used to retrieve the pixels data. */
+    private transient PixelsService                  pixDataSrv;
+    
+    /** Reference to the service used to retrieve the pixels metadata. */
+    private transient IPixels                        pixMetaSrv;
+    
+    /** read-write lock to prevent READ-calls during WRITE operations. Unneeded
+     * for remote invocations (EJB synchronizes).
+     */
+    private transient ReentrantReadWriteLock         rwl 
+        = new ReentrantReadWriteLock();
+    
+    /** set injector. For use during configuration. Can only be called once. */
+    public void setPixelsMetadata(IPixels metaService)
+    {
+        this.throwIfAlreadySet(this.pixMetaSrv, metaService);
+        pixMetaSrv = metaService;
+    }
+    
+    /** set injector. For use during configuration. Can only be called once. */
+    public void setPixelsData(PixelsService dataService)
+    {
+        throwIfAlreadySet(this.pixDataSrv, dataService);
+        pixDataSrv = dataService;
     }
     
@@ -113 +203 @@
         // =========================================================================
     
+    /** lifecycle method -- {@link PostActivate} and {@link PostConstruct}. 
+     * Delegates to super class */
     @PostActivate
     @PostConstruct
+    @Override
     public void create()
     {
@@ -120 +213 @@
     }
 
+    /** lifecycle method -- {@link PrePassivate}. Disallows all passivation. */
     @PrePassivate
     public void passivate()
@@ -126 +220 @@
     }
     
+    /** lifecycle method -- {@link PreDestroy}. Nulls {@link Renderer} instance
+     * and delegates to super class with {@link ReentrantReadWriteLock write lock}
+     */
     @PreDestroy
+    @Override
     public void destroy()
     {
-        super.destroy();
-        delegate = null;
-    }
-    
-    // ~ DELEGATION
-    // =========================================================================
-
+        rwl.writeLock().lock();
+
+        try {
+            renderer = null; // marks as unready. all other state is marked transient.
+            super.destroy();
+        } finally {
+            rwl.writeLock().unlock();
+        }
+    }
+    
+    /*
+     * SETTERS for use in dependency injection. All invalidate the current
+     * renderer. Only possible with the WriteLock so no possibility of
+     * corrupting data.
+     * 
+     * a.k.a. STATE-MANAGEMENT
+     */
+    
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#lookupPixels(long)
+     */
     @RolesAllowed("user")
     @TransactionAttribute(REQUIRED)
-    public void lookupPixels(long arg0)
-    {
-        delegate.lookupPixels(arg0);
-    }
-
+    public void lookupPixels(long pixelsId)
+    {
+        rwl.writeLock().lock();
+
+        try {
+
+            this.pixelsObj = pixMetaSrv.retrievePixDescription(pixelsId); 
+            this.renderer = null;
+
+            if ( pixelsObj == null )
+                throw new ValidationException(
+                        "Pixels object with id "+pixelsId+" not found.");
+            
+        } finally {
+            rwl.writeLock().unlock();
+        }
+        
+        if (log.isDebugEnabled())
+            log.debug("lookupPixels for id "+pixelsId+" succeeded: "+this.pixelsObj);
+    }
+
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#lookupRenderingDef(long)
+     */
     @RolesAllowed("user")
     @TransactionAttribute(REQUIRED)
-    public void lookupRenderingDef(long arg0)
-    {
-        delegate.lookupRenderingDef(arg0);
-    }
-    
+    public void lookupRenderingDef(long pixelsId)
+    {
+        rwl.writeLock().lock();
+        
+        try {
+            this.rendDefObj = pixMetaSrv.retrieveRndSettings(pixelsId);
+            this.renderer = null;
+            
+            if ( rendDefObj == null )
+                throw new ValidationException(
+                        "RenderingDef for Pixels="+pixelsId+" not found.");
+        } finally {
+            rwl.writeLock().unlock();
+        }
+        
+        if (log.isDebugEnabled())
+            log.debug("lookupRenderingDef for Pixels="+pixelsId+" succeeded: "+this.rendDefObj);
+        
+    }
+    
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#load()
+     */
     @RolesAllowed("user")
     @TransactionAttribute(REQUIRED)
     public void load()
     {
-        delegate.load();
-    }
-    
-    // -------------------------------------------------------------------------
-    
-    @RolesAllowed("user") 
-    public RGBBuffer render(PlaneDef arg0)
-    {
-        return delegate.render(arg0);
-    }
-    
-    // -------------------------------------------------------------------------
-    
+        rwl.writeLock().lock();
+
+        try {
+
+            errorIfNullPixels();
+
+            /*
+             * TODO we could also allow for setting of the buffer! perhaps
+             * better caching, etc.
+             */
+            PixelBuffer buffer = pixDataSrv.getPixelBuffer(pixelsObj);
+            
+            renderer = new Renderer(pixMetaSrv, pixelsObj, rendDefObj, buffer);
+        } finally {
+            rwl.writeLock().unlock();
+        }
+    } 
+
+    /** Implemented as specified by the {@link RenderingEngine} interface. TODO
+     * @see RenderingEngine#getCurrentEventContext()
+     */
+    @RolesAllowed("user")
+    @TransactionAttribute(REQUIRED)
+    public EventContext getCurrentEventContext()
+    {
+        return new SimpleEventContext( getSecuritySystem().getEventContext() );
+    }
+    
+    /*
+     * DELEGATING METHODS ==================================================
+     *  
+     *  All following methods follow the pattern:
+     *   1) get read or write lock
+     *      try {
+     *   2)   error on null 
+     *   3)   delegate method to renderer/renderingObj/pixelsObj
+     *      } finally {
+     *   4)   release lock
+     *      }
+     *  
+     *  TODO for all of these methods it would be good to have an
+     *  interceptor to check for a null renderer value. 
+     *      would have to be JBoss specific 
+     *      or apply at the Renderer level
+     *      or this would have to be a delegate to REngine to Renderer!
+     *      
+     *  @Write || @Read on each. 
+     *  for example 
+     *  see http://www.onjava.com/pub/a/onjava/2004/08/25/aoa.html?page=3
+     *  for asynch. annotations (also @TxSynchronized)
+     *   
+     */
+    
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#render(PlaneDef)
+     */
+    @RolesAllowed("user") 
+    public RGBBuffer render(PlaneDef pd)
+            throws ResourceError, ValidationException
+    {
+        rwl.readLock().lock();
+
+        try {
+            errorIfInvalidState();
+            return renderer.render(pd);
+        } catch (IOException e) {
+            ResourceError re = new ResourceError(
+                    "IO error while rendering:\n"+e.getMessage());
+            re.initCause(e);
+            throw re;
+        } catch (QuantizationException e) {
+            InternalException ie = new InternalException(
+                    "QuantizationException while rendering:\n"+e.getMessage());
+            ie.initCause(e);
+            throw ie;
+        } finally {
+            rwl.readLock().unlock();
+        }
+    }
+    
+    // ~ Settings
+        // =========================================================================
+    
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#resetDefaults()
+     */
     @RolesAllowed("user") 
     public void resetDefaults()
     {
-        delegate.resetDefaults();
-    }
-
+        rwl.writeLock().lock();
+        
+        try {
+            errorIfInvalidState();
+            renderer.resetDefaults();
+        } finally {
+            rwl.writeLock().unlock();
+        }
+    }
+
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#saveCurrentSettings()
+     */
     @RolesAllowed("user") 
     public void saveCurrentSettings()
     {
-        delegate.saveCurrentSettings();
+        rwl.writeLock().lock();
+
+        try {
+            errorIfNullRenderingDef();
+            pixMetaSrv.saveRndSettings(rendDefObj);
+        } finally {
+            rwl.writeLock().unlock();
+        }
         iUpdate.flush();
         iUpdate.commit();
     }
 
-    // -------------------------------------------------------------------------
-    
-    @RolesAllowed("user") 
-    public double getChannelCurveCoefficient(int arg0)
-    {
-        return delegate.getChannelCurveCoefficient(arg0);
-    }
-
-    @RolesAllowed("user") 
-    public Family getChannelFamily(int arg0)
-    {
-        Family family = delegate.getChannelFamily(arg0);
-        return copyFamily(family);
-    }
-
-    @RolesAllowed("user") 
-    public boolean getChannelNoiseReduction(int arg0)
-    {
-        return delegate.getChannelNoiseReduction(arg0);
-    }
-
-    @RolesAllowed("user") 
-    public double[] getChannelStats(int arg0)
-    {
-        return delegate.getChannelStats(arg0);
-    }
-
-    @RolesAllowed("user") 
-    public double getChannelWindowEnd(int arg0)
-    {
-        return delegate.getChannelWindowEnd(arg0);
-    }
-
-    @RolesAllowed("user") 
-    public double getChannelWindowStart(int arg0)
-    {
-        return delegate.getChannelWindowStart(arg0);
-    }
-
+    //  ~ Renderer Delegation (READ)
+    // =========================================================================
+
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#getChannelCurveCoefficient(int)
+     */
+    @RolesAllowed("user") 
+    public double getChannelCurveCoefficient(int w)
+    {
+        rwl.readLock().lock();
+
+        try {
+            errorIfInvalidState();
+            ChannelBinding[] cb = renderer.getChannelBindings();
+            return cb[w].getCoefficient().doubleValue();
+        } finally {
+            rwl.readLock().unlock();
+        }
+    }
+
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface.
+     * @see RenderingEngine#getChannelFamily(int)
+     */
+    @RolesAllowed("user")
+    public Family getChannelFamily(int w)
+    {
+        rwl.readLock().lock();
+
+        try {
+            errorIfInvalidState();
+            ChannelBinding[] cb = renderer.getChannelBindings();
+            Family family = cb[w].getFamily();
+            return copyFamily(family);
+        } finally {
+            rwl.readLock().unlock();
+        }
+    }
+
+    /**
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#getChannelNoiseReduction(int)
+     */
+    @RolesAllowed("user") 
+    public boolean getChannelNoiseReduction(int w)
+    {
+        rwl.readLock().lock();
+
+        try {
+            errorIfInvalidState();
+            ChannelBinding[] cb = renderer.getChannelBindings();
+            return cb[w].getNoiseReduction().booleanValue();
+        } finally {
+            rwl.readLock().unlock();
+        }
+    }
+
+    /** Implemented as specified by the {@link RenderingEngine} interface. */
+    @RolesAllowed("user") 
+    public double[] getChannelStats(int w)
+    {
+        rwl.readLock().lock();
+
+        try {
+            errorIfInvalidState();
+//            ChannelBinding[] cb = renderer.getChannelBindings();
+//        FIXME
+//        double[] stats = cb[w].getStats(), copy = new double[stats.length];
+//        System.arraycopy(stats, 0, copy, 0, stats.length);
+            return null;
+        } finally {
+            rwl.readLock().unlock();
+        }// FIXME copy;
+        // NOTE: These stats are supposed to be read-only; however we make a
+        // copy to be on the safe side.
+    }
+
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#getChannelWindowEnd(int)
+     */
+    @RolesAllowed("user") 
+    public double getChannelWindowEnd(int w)
+    {
+        rwl.readLock().lock();
+
+        try {
+            errorIfInvalidState();
+            ChannelBinding[] cb = renderer.getChannelBindings();
+            return cb[w].getInputEnd().intValue();
+        } finally {
+            rwl.readLock().unlock();
+        }
+    }
+
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#getChannelWindowStart(int)
+     */
+    @RolesAllowed("user") 
+    public double getChannelWindowStart(int w)
+    {
+        rwl.readLock().lock();
+
+        try {
+            errorIfInvalidState();
+            ChannelBinding[] cb = renderer.getChannelBindings();
+            return cb[w].getInputStart().intValue();
+        } finally {
+            rwl.readLock().unlock();
+        }
+    }
+    
+    /**
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#getRGBA(int)
+     */
+    @RolesAllowed("user") 
+    public int[] getRGBA(int w)
+    {
+
+        rwl.readLock().lock();
+
+        try {
+            errorIfInvalidState();
+            int[] rgba = new int[4];
+            ChannelBinding[] cb = renderer.getChannelBindings();
+            // NOTE: The rgba is supposed to be read-only; however we make a
+            // copy to be on the safe side.
+            rgba[0] = cb[w].getColor().getRed().intValue();
+            rgba[1] = cb[w].getColor().getGreen().intValue();
+            rgba[2] = cb[w].getColor().getBlue().intValue();
+            rgba[3] = cb[w].getColor().getAlpha().intValue();
+            return rgba;
+        } finally {
+            rwl.readLock().unlock();
+        }
+    }
+
+    /** 
+     * Implemented as specified by the {@link RenderingEngine} interface. 
+     * @see RenderingEngine#isActive(int)
+     */
+    @RolesAllowed("user") 
+    public boolean isActive(int w)
+    {
+        rwl.readLock().lock();
+