Package omero.api

Interface Exporter

All Superinterfaces:

_ExporterOperations, _ExporterOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperations, _StatefulServiceInterfaceOperationsNC, Ice.Object, ServiceInterface, StatefulServiceInterface

All Known Implementing Classes:

_ExporterDisp, _ExporterTie

public interface Exporter
extends Ice.Object, _ExporterOperations, _ExporterOperationsNC, StatefulServiceInterface

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ice_staticId
static long	serialVersionUID

Method Summary

Methods inherited from interface omero.api._ExporterOperations

addImage_async, generateTiff_async, generateXml_async, read_async

Methods inherited from interface omero.api._ExporterOperationsNC

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 omero.api._StatefulServiceInterfaceOperationsNC

activate_async, close_async, getCurrentEventContext_async, passivate_async

Methods inherited from interface Ice.Object

__dispatch, __read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

ice_staticId

static final java.lang.String ice_staticId

See Also:

Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values