omero.api

Interface _ExporterOperationsNC

All Superinterfaces:

_ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperationsNC

All Known Subinterfaces:

Exporter

All Known Implementing Classes:

_ExporterDisp, _ExporterTie

public interface _ExporterOperationsNC
extends _StatefulServiceInterfaceOperationsNC

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

Method Summary

Modifier and Type	Method and Description
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	generateTiff_async(AMD_Exporter_generateTiff __cb) Generates an OME-TIFF file.
void	generateXml_async(AMD_Exporter_generateXml __cb) Generates an OME-XML file.
void	read_async(AMD_Exporter_read __cb, long position, int length) Returns length bytes from the output file.

Methods inherited from interface omero.api._StatefulServiceInterfaceOperationsNC

activate_async, close_async, getCurrentEventContext_async, passivate_async

Method Detail

addImage_async

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

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

generateXml_async

void generateXml_async(AMD_Exporter_generateXml __cb)
                throws ServerError

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

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

generateTiff_async

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.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

read_async

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.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError