omero.api

Class _ExporterDisp

java.lang.Object

Ice.ObjectImpl

omero.api._ExporterDisp

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _ExporterOperations, _ExporterOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperations, _StatefulServiceInterfaceOperationsNC, Exporter, ServiceInterface, StatefulServiceInterface

Direct Known Subclasses:

_ExporterTie

public abstract class _ExporterDisp
extends Ice.ObjectImpl
implements Exporter

Stateful service for generating OME-XML or OME-TIFF from data stored in OMERO. Intended usage:

 

 ExporterPrx e = sf.createExporter();

 // Exporter is currently in the <i>configuration</i> state
 // Objects can be added by id which should be present
 // in the output.

 e.addImage(1);


 // As soon as a generate method is called, the objects
 // added to the Exporter are converted to the specified
 // format. The length of the file produced is returned.
 // No more objects can be added to the Exporter, nor can
 // another generate method be called.

 long length = e.generateTiff();

 // As soon as the server-side file is generated, read()
 // can be called to get file segments. To create another
 // file, create a second Exporter. Be sure to close all
 // Exporter instances.

 long read = 0
 byte\[] buf;
 while (true) {
 buf = e.read(read, 1000000);
 // Store to file locally here
 if (buf.length < 1000000) {
 break;
 }
 read += buf.length;
 }
 e.close();
 
 

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from interface omero.api.Exporter

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_ExporterDisp()

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___addImage(Exporter __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___generateTiff(Exporter __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___generateXml(Exporter __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___read(Exporter __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)
void	activate_async(AMD_StatefulServiceInterface_activate __cb) Load a service implementation from disk if it was previously passivated.
void	addImage_async(AMD_Exporter_addImage __cb, long id) Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().
void	close_async(AMD_StatefulServiceInterface_close __cb) Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter.
void	generateTiff_async(AMD_Exporter_generateTiff __cb) Generates an OME-TIFF file.
void	generateXml_async(AMD_Exporter_generateXml __cb) Generates an OME-XML file.
void	getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb) To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.
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()
void	passivate_async(AMD_StatefulServiceInterface_passivate __cb) Causes the blitz server to store the service implementation to disk to free memory.
void	read_async(AMD_Exporter_read __cb, long position, int length) Returns length bytes from the output file.

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.api._ExporterOperations

addImage_async, generateTiff_async, generateXml_async, read_async

Methods inherited from interface omero.api._StatefulServiceInterfaceOperations

activate_async, close_async, getCurrentEventContext_async, passivate_async

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

_ExporterDisp

public _ExporterDisp()

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()

addImage_async

public final void addImage_async(AMD_Exporter_addImage __cb,
                                 long id)
                          throws ServerError

Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().

Specified by:

addImage_async in interface _ExporterOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

generateTiff_async

public final void generateTiff_async(AMD_Exporter_generateTiff __cb)
                              throws ServerError

Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.

Specified by:

generateTiff_async in interface _ExporterOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

generateXml_async

public final void generateXml_async(AMD_Exporter_generateXml __cb)
                             throws ServerError

Generates an OME-XML file. The return value is the length of the file produced.

Specified by:

generateXml_async in interface _ExporterOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

read_async

public final void read_async(AMD_Exporter_read __cb,
                             long position,
                             int length)
                      throws ServerError

Returns length bytes from the output file. The file can be safely read until reset() is called.

Specified by:

read_async in interface _ExporterOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

activate_async

public final void activate_async(AMD_StatefulServiceInterface_activate __cb)
                          throws ServerError

Load a service implementation from disk if it was previously passivated. It is unnecessary to call this method since activation happens automatically, but calling this may prevent a short lapse when the service is first accessed after passivation. It is safe to call this method at any time, even when the service is not passivated.

Specified by:

activate_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

close_async

public final void close_async(AMD_StatefulServiceInterface_close __cb)
                       throws ServerError

Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter. Any further method calls will fail with a Ice::NoSuchObjectException. Note: with JavaEE, the close method was called publicly, and internally this called destroy(). As of the OmeroBlitz migration, this functionality has been combined.

Specified by:

close_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getCurrentEventContext_async

public final void getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb)
                                        throws ServerError

To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.

Specified by:

getCurrentEventContext_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

passivate_async

public final void passivate_async(AMD_StatefulServiceInterface_passivate __cb)
                           throws ServerError

Causes the blitz server to store the service implementation to disk to free memory. This is typically done automatically by the server when a pre-defined memory limit is reached, but can be used by the client if it clear that a stateful service will not be used for some time. Activation will happen automatically whether passivation was done manually or automatically.

Specified by:

passivate_async in interface _StatefulServiceInterfaceOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

___addImage

public static Ice.DispatchStatus ___addImage(Exporter __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___generateXml

public static Ice.DispatchStatus ___generateXml(Exporter __obj,
                                                IceInternal.Incoming __inS,
                                                Ice.Current __current)

___generateTiff

public static Ice.DispatchStatus ___generateTiff(Exporter __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___read

public static Ice.DispatchStatus ___read(Exporter __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