Package omero.api

Interface ExporterPrx

  • All Superinterfaces:
    Ice.ObjectPrx, ServiceInterfacePrx, StatefulServiceInterfacePrx
    All Known Implementing Classes:
    ExporterPrxHelper
    public interface ExporterPrx
extends StatefulServiceInterfacePrx
    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 Detail

      • addImage

        void addImage​(long id)
       throws ServerError
        Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().
        Throws:
        ServerError

      • addImage

        void addImage​(long id,
              java.util.Map<java.lang.String,​java.lang.String> __ctx)
       throws ServerError
        Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().
        Parameters:
        __ctx - The Context map to send with the invocation.
        Throws:
        ServerError

      • begin_addImage

        Ice.AsyncResult begin_addImage​(long id)
        Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().
        Returns:
        The asynchronous result object.

      • begin_addImage

        Ice.AsyncResult begin_addImage​(long id,
                               java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_addImage

        Ice.AsyncResult begin_addImage​(long id,
                               Ice.Callback __cb)
        Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_addImage

        Ice.AsyncResult begin_addImage​(long id,
                               java.util.Map<java.lang.String,​java.lang.String> __ctx,
                               Ice.Callback __cb)
        Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_addImage

        Ice.AsyncResult begin_addImage​(long id,
                               Callback_Exporter_addImage __cb)
        Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_addImage

        Ice.AsyncResult begin_addImage​(long id,
                               java.util.Map<java.lang.String,​java.lang.String> __ctx,
                               Callback_Exporter_addImage __cb)
        Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_addImage

        void end_addImage​(Ice.AsyncResult __result)
           throws ServerError
        Adds a single image with basic metadata to the Exporter for inclusion on the next call to getBytes().
        Parameters:
        __result - The asynchronous result object.
        Throws:
        ServerError

      • generateXml

        long generateXml()
          throws ServerError
        Generates an OME-XML file. The return value is the length of the file produced.
        Throws:
        ServerError

      • generateXml

        long generateXml​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
          throws ServerError
        Generates an OME-XML file. The return value is the length of the file produced.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Throws:
        ServerError

      • begin_generateXml

        Ice.AsyncResult begin_generateXml()
        Generates an OME-XML file. The return value is the length of the file produced.
        Returns:
        The asynchronous result object.

      • begin_generateXml

        Ice.AsyncResult begin_generateXml​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Generates an OME-XML file. The return value is the length of the file produced.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_generateXml

        Ice.AsyncResult begin_generateXml​(Ice.Callback __cb)
        Generates an OME-XML file. The return value is the length of the file produced.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_generateXml

        Ice.AsyncResult begin_generateXml​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                                  Ice.Callback __cb)
        Generates an OME-XML file. The return value is the length of the file produced.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_generateXml

        Ice.AsyncResult begin_generateXml​(Callback_Exporter_generateXml __cb)
        Generates an OME-XML file. The return value is the length of the file produced.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_generateXml

        Ice.AsyncResult begin_generateXml​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                                  Callback_Exporter_generateXml __cb)
        Generates an OME-XML file. The return value is the length of the file produced.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_generateXml

        long end_generateXml​(Ice.AsyncResult __result)
              throws ServerError
        Generates an OME-XML file. The return value is the length of the file produced.
        Parameters:
        __result - The asynchronous result object.
        Throws:
        ServerError

      • generateTiff

        long generateTiff()
           throws ServerError
        Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.
        Throws:
        ServerError

      • generateTiff

        long generateTiff​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
           throws ServerError
        Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Throws:
        ServerError

      • begin_generateTiff

        Ice.AsyncResult begin_generateTiff()
        Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.
        Returns:
        The asynchronous result object.

      • begin_generateTiff

        Ice.AsyncResult begin_generateTiff​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_generateTiff

        Ice.AsyncResult begin_generateTiff​(Ice.Callback __cb)
        Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_generateTiff

        Ice.AsyncResult begin_generateTiff​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                                   Ice.Callback __cb)
        Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_generateTiff

        Ice.AsyncResult begin_generateTiff​(Callback_Exporter_generateTiff __cb)
        Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_generateTiff

        Ice.AsyncResult begin_generateTiff​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                                   Callback_Exporter_generateTiff __cb)
        Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_generateTiff

        long end_generateTiff​(Ice.AsyncResult __result)
               throws ServerError
        Generates an OME-TIFF file. The return value is the length of the file produced. This method ends configuration.
        Parameters:
        __result - The asynchronous result object.
        Throws:
        ServerError

      • read

        byte[] read​(long position,
            int length)
     throws ServerError
        Returns length bytes from the output file. The file can be safely read until reset() is called.
        Throws:
        ServerError

      • read

        byte[] read​(long position,
            int length,
            java.util.Map<java.lang.String,​java.lang.String> __ctx)
     throws ServerError
        Returns length bytes from the output file. The file can be safely read until reset() is called.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Throws:
        ServerError

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length)
        Returns length bytes from the output file. The file can be safely read until reset() is called.
        Returns:
        The asynchronous result object.

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length,
                           java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Returns length bytes from the output file. The file can be safely read until reset() is called.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length,
                           Ice.Callback __cb)
        Returns length bytes from the output file. The file can be safely read until reset() is called.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length,
                           java.util.Map<java.lang.String,​java.lang.String> __ctx,
                           Ice.Callback __cb)
        Returns length bytes from the output file. The file can be safely read until reset() is called.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length,
                           Callback_Exporter_read __cb)
        Returns length bytes from the output file. The file can be safely read until reset() is called.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length,
                           java.util.Map<java.lang.String,​java.lang.String> __ctx,
                           Callback_Exporter_read __cb)
        Returns length bytes from the output file. The file can be safely read until reset() is called.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_read

        byte[] end_read​(Ice.AsyncResult __result)
         throws ServerError
        Returns length bytes from the output file. The file can be safely read until reset() is called.
        Parameters:
        __result - The asynchronous result object.
        Throws:
        ServerError