Package omero.grid

Class _InteractiveProcessorDisp

java.lang.Object

Ice.ObjectImpl

omero.grid._InteractiveProcessorDisp

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _InteractiveProcessorOperations, _InteractiveProcessorOperationsNC, InteractiveProcessor

Direct Known Subclasses:

_InteractiveProcessorTie

public abstract class _InteractiveProcessorDisp
extends Ice.ObjectImpl
implements InteractiveProcessor

Client facing interface to the background processing framework. If a user needs interactivity, one of these processors should be acquired from the ServiceFactory. Otherwise, a Job can be submitted via JobHandle.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String[]	__ids
static long	serialVersionUID

Fields inherited from interface omero.grid.InteractiveProcessor

ice_staticId

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor	Description
_InteractiveProcessorDisp()

Method Summary

Modifier and Type	Method	Description
static Ice.DispatchStatus	___execute(InteractiveProcessor __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___expires(InteractiveProcessor __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getJob(InteractiveProcessor __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getResults(InteractiveProcessor __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___params(InteractiveProcessor __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setDetach(InteractiveProcessor __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___stop(InteractiveProcessor __obj, IceInternal.Incoming __inS, Ice.Current __current)
Ice.DispatchStatus	__dispatch(IceInternal.Incoming in, Ice.Current __current)
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
ProcessPrx	execute(RMap inputs)	Executes an instance of the job returned by getJob() using the given map as inputs.
long	expires()	Returns the system clock time in milliseconds since the epoch at which this processor will be reaped.
Job	getJob()	Returns the job which defines this processor.
RMap	getResults(ProcessPrx proc)	Retrieve the results for the given process.
protected void	ice_copyStateFrom(Ice.Object __obj)
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()
JobParams	params()	Retrieves the parameters needed to be passed in an execution and the results which will be passed back out.
boolean	setDetach(boolean detach)	Sets whether or not cancel will be called on the current Process on stop.
void	stop()	Clears the current execution of Job from the processor to prepare for another execution.

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __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

Methods inherited from interface omero.grid._InteractiveProcessorOperations

execute, expires, getJob, getResults, params, setDetach, stop

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_InteractiveProcessorDisp

public _InteractiveProcessorDisp()

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

execute

public final ProcessPrx execute(RMap inputs)
                         throws ServerError

Executes an instance of the job returned by getJob() using the given map as inputs.

Specified by:

execute in interface _InteractiveProcessorOperationsNC

Throws:

ServerError

expires

public final long expires()

Returns the system clock time in milliseconds since the epoch at which this processor will be reaped.

Specified by:

expires in interface _InteractiveProcessorOperationsNC

getJob

public final Job getJob()

Returns the job which defines this processor. This may be only the last job associated with the processor if execute is called multiple times.

Specified by:

getJob in interface _InteractiveProcessorOperationsNC

getResults

public final RMap getResults(ProcessPrx proc)
                      throws ServerError

Retrieve the results for the given process. This will throw an ApiUsageException if called before the process has returned. Use either process.poll() or process.wait() or a ProcessCallback to wait for completion before calling. If the user has not overridden or disabled the output values "stdout" and "stderr", these will be filled with the OriginalFile instances uploaded after completion under the key values of the same name.

Specified by:

getResults in interface _InteractiveProcessorOperationsNC

Throws:

ServerError

params

public final JobParams params()
                       throws ServerError

Retrieves the parameters needed to be passed in an execution and the results which will be passed back out. This method is guaranteed to return a non-null value or throw an exception.

Specified by:

params in interface _InteractiveProcessorOperationsNC

Throws:

ServerError

setDetach

public final boolean setDetach(boolean detach)
                        throws ServerError

Sets whether or not cancel will be called on the current Process on stop. If detach is true, then the Process will continue running. Otherwise, _ProcessOperations.cancel(Ice.Current) will be called, before preparing for another run. false by default

Specified by:

setDetach in interface _InteractiveProcessorOperationsNC

Throws:

ServerError

stop

public final void stop()
                throws ServerError

Clears the current execution of Job from the processor to prepare for another execution. cancel() will be called on the current Process if detach is set to false.

Specified by:

stop in interface _InteractiveProcessorOperationsNC

Throws:

ServerError

___expires

public static Ice.DispatchStatus ___expires(InteractiveProcessor __obj,
                                            IceInternal.Incoming __inS,
                                            Ice.Current __current)

___getJob

public static Ice.DispatchStatus ___getJob(InteractiveProcessor __obj,
                                           IceInternal.Incoming __inS,
                                           Ice.Current __current)

___params

public static Ice.DispatchStatus ___params(InteractiveProcessor __obj,
                                           IceInternal.Incoming __inS,
                                           Ice.Current __current)

___execute

public static Ice.DispatchStatus ___execute(InteractiveProcessor __obj,
                                            IceInternal.Incoming __inS,
                                            Ice.Current __current)

___getResults

public static Ice.DispatchStatus ___getResults(InteractiveProcessor __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___setDetach

public static Ice.DispatchStatus ___setDetach(InteractiveProcessor __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___stop

public static Ice.DispatchStatus ___stop(InteractiveProcessor __obj,
                                         IceInternal.Incoming __inS,
                                         Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:

__dispatch in interface Ice.Object

Overrides:

__dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl