omero.cmd.graphs

Class SkipHeadI

java.lang.Object

Ice.ObjectImpl

omero.cmd.Request

omero.cmd.GraphModify2

omero.cmd.SkipHead

omero.cmd.graphs.SkipHeadI

All Implemented Interfaces:

Ice.Object, Serializable, Cloneable, IRequest

public class SkipHeadI
extends omero.cmd.SkipHead
implements IRequest

The skip-head request performs the wrapped request twice: once in dry run mode to discover from which model objects to start, and then actually starting from those objects.

Since:

5.1.0

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from class omero.cmd.SkipHead

__ids, request, serialVersionUID, startFrom

Fields inherited from class omero.cmd.GraphModify2

childOptions, dryRun, targetObjects

Constructor Summary

Constructors

Constructor and Description
SkipHeadI(GraphPathBean graphPathBean, GraphRequestFactory graphRequestFactory) Construct a new skip-head request; called from GraphRequestFactory.getRequest(Class).

Method Summary

Methods

Modifier and Type	Method and Description
void	buildResponse(int step, Object object) Post-transaction chance to map from the return value of IRequest.step(int) to a Response object.
void	finish() Method within the transaction boudnaries after all processing has occurred.
Map<String,String>	getCallContext() Returns the desired call context for this request.
omero.cmd.Response	getResponse() Returns the current response value.
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.SkipHead

__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

SkipHeadI

public SkipHeadI(GraphPathBean graphPathBean,
         GraphRequestFactory graphRequestFactory)

Construct a new skip-head request; called from GraphRequestFactory.getRequest(Class).

Parameters:

graphPathBean - the graph path bean to use

graphRequestFactory - a means of instantiating the sub-request

Throws:

GraphException - if the request was not of an appropriate type

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

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 {@link #step(int)} method will be called. The {@link 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

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

Returns:

Throws:

HandleI.Cancel

finish

public void finish()

Description copied from interface: IRequest

Method within the transaction boudnaries 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

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