Package omero.cmd.graphs

Class DiskUsage2I

  • All Implemented Interfaces:
    Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.services.util.ReadOnlyStatus.IsAware, IRequest
    public class DiskUsage2I
extends DiskUsage2
implements IRequest, ome.services.util.ReadOnlyStatus.IsAware
    Calculate the disk usage entailed by the given objects.
    Since:
    5.1.0
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      DiskUsage2I​(ome.security.ACLVoter aclVoter, ome.system.Roles securityRoles, ome.services.graphs.GraphPathBean graphPathBean, ome.security.basic.LightAdminPrivileges adminPrivileges, java.util.Set<java.lang.Class<? extends ome.model.IObject>> targetClasses, ome.services.graphs.GraphPolicy graphPolicy)
      Construct a new disk usage request; called from GraphRequestFactory.getRequest(Class).

    • Constructor Detail

      • DiskUsage2I

        public DiskUsage2I​(ome.security.ACLVoter aclVoter,
                   ome.system.Roles securityRoles,
                   ome.services.graphs.GraphPathBean graphPathBean,
                   ome.security.basic.LightAdminPrivileges adminPrivileges,
                   java.util.Set<java.lang.Class<? extends ome.model.IObject>> targetClasses,
                   ome.services.graphs.GraphPolicy graphPolicy)
        Construct a new disk usage request; called from GraphRequestFactory.getRequest(Class).
        Parameters:
        aclVoter - ACL voter for permissions checking
        securityRoles - the security roles
        graphPathBean - the graph path bean to use
        adminPrivileges - the light administrator privileges helper
        targetClasses - legal target object classes for the search
        graphPolicy - the graph policy to apply for the search

    • Method Detail

      • setPixelsService

        public void setPixelsService​(ome.io.nio.PixelsService pixelsService)
        Provided by RequestObjectFactoryRegistry.
        Parameters:
        pixelsService - the pixels service

      • setThumbnailService

        public void setThumbnailService​(ome.io.nio.ThumbnailService thumbnailService)
        Provided by RequestObjectFactoryRegistry.
        Parameters:
        thumbnailService - the thumbnail service

      • getCallContext

        public java.util.Map<java.lang.String,​java.lang.String> getCallContext()
        Description copied from interface: IRequest
        Returns the desired call context for this request. Some request implementations will require "omero.group":"-1" for example and will hard-code that value. Others may permit users to pass in the desired values which will be merged into the static Map as desired.
        Specified by:
        getCallContext in interface IRequest
        Returns:
        the call context for this request

      • init

        public void init​(Helper helper)
        Description copied from interface: IRequest
        Method called within the transaction boundaries before any processing occurs. Implementations must properly initialize the "step" field of the Status object by calling Helper.setSteps(int). This count will define how many times the IRequest.step(int) method will be called. The Helper instance passed in contains those resources needed by IRequests to interact with data and should be stored for later use.
        Specified by:
        init in interface IRequest
        Parameters:
        helper - the helper for this request

      • step

        public java.lang.Object step​(int step)
                      throws HandleI.Cancel
        Description copied from interface: IRequest
        Single uncancellable action which will be performed by this IRequest. The return value can be an ome.model object that is attached to the current thread and transaction. After processing and detachment from the transaction, the object will be passed to IRequest.buildResponse(int, Object) for conversion and storage.
        Specified by:
        step in interface IRequest
        Parameters:
        step - the step number
        Returns:
        an object to be used in building the response
        Throws:
        HandleI.Cancel - if this request is cancelled

      • finish

        public void finish()
        Description copied from interface: IRequest
        Method within the transaction boundaries after all processing has occurred. A thrown HandleI.Cancel will still rollback the current transaction.
        Specified by:
        finish in interface IRequest

      • buildResponse

        public void buildResponse​(int step,
                          java.lang.Object object)
        Description copied from interface: IRequest
        Post-transaction chance to map from the return value of IRequest.step(int) to a Response object.
        Specified by:
        buildResponse in interface IRequest
        Parameters:
        step - the step number
        object - an object to be used in building the response

      • getResponse

        public Response getResponse()
        Description copied from interface: IRequest
        Returns the current response value. This method should be protected by synchronization where necessary, and should never raise an exception. It is also guaranteed to be called so that any state cleanup that is necessary can take place here.
        Specified by:
        getResponse in interface IRequest
        Returns:
        the response to this request

      • isReadOnly

        public boolean isReadOnly​(ome.services.util.ReadOnlyStatus readOnly)
        Specified by:
        isReadOnly in interface ome.services.util.ReadOnlyStatus.IsAware