omero.cmd.graphs

Class Chgrp2I

java.lang.Object

Ice.ObjectImpl

omero.cmd.Request

omero.cmd.GraphQuery

omero.cmd.GraphModify2

omero.cmd.Chgrp2

omero.cmd.graphs.Chgrp2I

All Implemented Interfaces:

Ice.Object, Serializable, Cloneable, WrappableRequest<omero.cmd.Chgrp2>, IRequest

public class Chgrp2I
extends omero.cmd.Chgrp2
implements IRequest, WrappableRequest<omero.cmd.Chgrp2>

Request to move model objects to a different experiment group, replacing version 5.0's ChgrpI.

Since:

5.1.0

Author:

m.t.b.carroll@dundee.ac.uk

See Also:

Serialized Form

Field Summary

Fields inherited from class omero.cmd.Chgrp2

__ids, groupId, serialVersionUID

Fields inherited from class omero.cmd.GraphModify2

childOptions, dryRun

Fields inherited from class omero.cmd.GraphQuery

targetObjects

Constructor Summary

Constructors

Constructor and Description
Chgrp2I(ACLVoter aclVoter, Roles securityRoles, SystemTypes systemTypes, GraphPathBean graphPathBean, Deletion deletionInstance, Set<Class<? extends IObject>> targetClasses, GraphPolicy graphPolicy, com.google.common.collect.SetMultimap<String,String> unnullable, ApplicationContext applicationContext) Deprecated. from OMERO 5.4 the systemTypes argument is no longer included

Method Summary

Modifier and Type	Method and Description
void	adjustGraphPolicy(com.google.common.base.Function<GraphPolicy,GraphPolicy> adjuster) Transform the currently applicable graph policy for this request by the given function.
void	buildResponse(int step, Object object) Post-transaction chance to map from the return value of IRequest.step(int) to a Response object.
void	copyFieldsTo(omero.cmd.Chgrp2 request) Copy the fields of this request to that of the given request.
void	finish() Method within the transaction boundaries after all processing has occurred.
GraphPolicy.Action	getActionForStarting()
Map<String,String>	getCallContext() Returns the desired call context for this request.
omero.cmd.Response	getResponse() Returns the current response value.
Map<String,List<Long>>	getStartFrom(omero.cmd.Response response) From the response of the head-skipping request, determine which model objects are the targets of the operation.
int	getStepProvidingCompleteResponse() Get the step of this request that suffices for assembling the request's response.
void	init(Helper helper) Method called within the transaction boundaries before any processing occurs.
Object	step(int step) Single uncancellable action which will be performed by this IRequest.

Methods inherited from class omero.cmd.Chgrp2

__readImpl, __writeImpl, ice_factory, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __collocDispatch, __dispatch, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Chgrp2I

public Chgrp2I(ACLVoter aclVoter,
               Roles securityRoles,
               SystemTypes systemTypes,
               GraphPathBean graphPathBean,
               Deletion deletionInstance,
               Set<Class<? extends IObject>> targetClasses,
               GraphPolicy graphPolicy,
               com.google.common.collect.SetMultimap<String,String> unnullable,
               ApplicationContext applicationContext)

Deprecated. from OMERO 5.4 the systemTypes argument is no longer included

Construct a new chgrp request; called from GraphRequestFactory.getRequest(Class).

Parameters:

aclVoter - ACL voter for permissions checking

securityRoles - the security roles

systemTypes - for identifying the system types

graphPathBean - the graph path bean to use

deletionInstance - a deletion instance for deleting files

targetClasses - legal target object classes for chgrp

graphPolicy - the graph policy to apply for chgrp

unnullable - properties that, while nullable, may not be nulled by a graph traversal operation

applicationContext - the OMERO application context from Spring

Method Detail

getCallContext

public Map<String,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 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,
                          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 omero.cmd.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

copyFieldsTo

public void copyFieldsTo(omero.cmd.Chgrp2 request)

Description copied from interface: WrappableRequest

Copy the fields of this request to that of the given request.

Specified by:

copyFieldsTo in interface WrappableRequest<omero.cmd.Chgrp2>

Parameters:

request - the target of the field copy

adjustGraphPolicy

public void adjustGraphPolicy(com.google.common.base.Function<GraphPolicy,GraphPolicy> adjuster)

Description copied from interface: WrappableRequest

Transform the currently applicable graph policy for this request by the given function. Must be called before IRequest.init(omero.cmd.Helper).

Specified by:

adjustGraphPolicy in interface WrappableRequest<omero.cmd.Chgrp2>

Parameters:

adjuster - a transformation function for graph policies

getStepProvidingCompleteResponse

public int getStepProvidingCompleteResponse()

Description copied from interface: WrappableRequest

Get the step of this request that suffices for assembling the request's response. It is presumed that checking the permissibility of the planned operation occurs afterward.

Specified by:

getStepProvidingCompleteResponse in interface WrappableRequest<omero.cmd.Chgrp2>

Returns:

a step number

getActionForStarting

public GraphPolicy.Action getActionForStarting()

Specified by:

getActionForStarting in interface WrappableRequest<omero.cmd.Chgrp2>

Returns:

the action associated with nodes qualifying as start objects

getStartFrom

public Map<String,List<Long>> getStartFrom(omero.cmd.Response response)

Description copied from interface: WrappableRequest

From the response of the head-skipping request, determine which model objects are the targets of the operation.

Specified by:

getStartFrom in interface WrappableRequest<omero.cmd.Chgrp2>

Parameters:

response - the head-skipping request's response

Returns:

the model objects to target