Package omero.cmd.graphs
Class SkipHeadI
- java.lang.Object
-
- Ice.ObjectImpl
-
- omero.cmd.Request
-
- omero.cmd.GraphQuery
-
- omero.cmd.GraphModify2
-
- omero.cmd.SkipHead
-
- omero.cmd.graphs.SkipHeadI
-
- All Implemented Interfaces:
Ice.Object
,java.io.Serializable
,java.lang.Cloneable
,ome.services.util.ReadOnlyStatus.IsAware
,IRequest
public class SkipHeadI extends SkipHead implements IRequest, ome.services.util.ReadOnlyStatus.IsAware
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
- 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
-
Fields inherited from class omero.cmd.GraphQuery
targetObjects
-
-
Constructor Summary
Constructors Constructor Description SkipHeadI(ome.services.graphs.GraphPathBean graphPathBean, GraphRequestFactory graphRequestFactory)
Construct a newskip-head
request; called fromGraphRequestFactory.getRequest(Class)
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
buildResponse(int step, java.lang.Object object)
Post-transaction chance to map from the return value ofIRequest.step(int)
to aResponse
object.void
finish()
Method within the transaction boundaries after all processing has occurred.java.util.Map<java.lang.String,java.lang.String>
getCallContext()
Returns the desired call context for this request.Response
getResponse()
Returns the current response value.void
init(Helper helper)
Method called within the transaction boundaries before any processing occurs.boolean
isReadOnly(ome.services.util.ReadOnlyStatus readOnly)
java.lang.Object
step(int step)
Single uncancellable action which will be performed by this IRequest.-
Methods inherited from class omero.cmd.SkipHead
__readImpl, __writeImpl, clone, ice_factory, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId
-
-
-
-
Constructor Detail
-
SkipHeadI
public SkipHeadI(ome.services.graphs.GraphPathBean graphPathBean, GraphRequestFactory graphRequestFactory)
Construct a newskip-head
request; called fromGraphRequestFactory.getRequest(Class)
.- Parameters:
graphPathBean
- the graph path bean to usegraphRequestFactory
- a means of instantiating the sub-request
-
-
Method Detail
-
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 staticMap
as desired.- Specified by:
getCallContext
in interfaceIRequest
- 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 theStatus
object by callingHelper.setSteps(int)
. This count will define how many times theIRequest.step(int)
method will be called. TheHelper
instance passed in contains those resources needed by IRequests to interact with data and should be stored for later use.
-
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 toIRequest.buildResponse(int, Object)
for conversion and storage.- Specified by:
step
in interfaceIRequest
- 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 thrownHandleI.Cancel
will still rollback the current transaction.
-
buildResponse
public void buildResponse(int step, java.lang.Object object)
Description copied from interface:IRequest
Post-transaction chance to map from the return value ofIRequest.step(int)
to aResponse
object.- Specified by:
buildResponse
in interfaceIRequest
- Parameters:
step
- the step numberobject
- 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 interfaceIRequest
- Returns:
- the response to this request
-
isReadOnly
public boolean isReadOnly(ome.services.util.ReadOnlyStatus readOnly)
- Specified by:
isReadOnly
in interfaceome.services.util.ReadOnlyStatus.IsAware
-
-