omero.api

Interface _ThumbnailStoreOperationsNC

All Superinterfaces:

_ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperationsNC

All Known Subinterfaces:

ThumbnailStore

All Known Implementing Classes:

_ThumbnailStoreDisp, _ThumbnailStoreTie

public interface _ThumbnailStoreOperationsNC
extends _StatefulServiceInterfaceOperationsNC

Provides methods for dealing with thumbnails. Provision is provided to retrieve thumbnails using the on-disk cache (provided by ROMIO) or on the fly.

NOTE: The calling order for the service is as follows:

1. setPixelsId
2. any of the thumbnail accessor methods or resetDefaults

Method Summary

Modifier and Type	Method and Description
void	createThumbnail_async(AMD_ThumbnailStore_createThumbnail __cb, RInt sizeX, RInt sizeY) Creates a thumbnail for a pixels set using a given set of rendering settings (RenderingDef) in the on-disk cache.
void	createThumbnails_async(AMD_ThumbnailStore_createThumbnails __cb) Creates thumbnails for a pixels set using a given set of rendering settings (RenderingDef) in the on-disk cache for every sizeX/sizeY combination already cached.
void	createThumbnailsByLongestSideSet_async(AMD_ThumbnailStore_createThumbnailsByLongestSideSet __cb, RInt size, java.util.List<java.lang.Long> pixelsIds) Creates thumbnails for a number of pixels sets using a given set of rendering settings (RenderingDef) in the on-disk cache.
void	getRenderingDefId_async(AMD_ThumbnailStore_getRenderingDefId __cb) Return the id of the RenderingDef loaded in this instance.
void	getThumbnail_async(AMD_ThumbnailStore_getThumbnail __cb, RInt sizeX, RInt sizeY) Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef).
void	getThumbnailByLongestSide_async(AMD_ThumbnailStore_getThumbnailByLongestSide __cb, RInt size) Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef).
void	getThumbnailByLongestSideDirect_async(AMD_ThumbnailStore_getThumbnailByLongestSideDirect __cb, RInt size) Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef).
void	getThumbnailByLongestSideSet_async(AMD_ThumbnailStore_getThumbnailByLongestSideSet __cb, RInt size, java.util.List<java.lang.Long> pixelsIds) Retrieves a number of thumbnails for pixels sets using given sets of rendering settings (RenderingDef).
void	getThumbnailDirect_async(AMD_ThumbnailStore_getThumbnailDirect __cb, RInt sizeX, RInt sizeY) Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef).
void	getThumbnailForSectionByLongestSideDirect_async(AMD_ThumbnailStore_getThumbnailForSectionByLongestSideDirect __cb, int theZ, int theT, RInt size) Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef) for a particular section.
void	getThumbnailForSectionDirect_async(AMD_ThumbnailStore_getThumbnailForSectionDirect __cb, int theZ, int theT, RInt sizeX, RInt sizeY) Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef) for a particular section.
void	getThumbnailSet_async(AMD_ThumbnailStore_getThumbnailSet __cb, RInt sizeX, RInt sizeY, java.util.List<java.lang.Long> pixelsIds) Retrieves a number of thumbnails for pixels sets using given sets of rendering settings (RenderingDef).
void	getThumbnailWithoutDefault_async(AMD_ThumbnailStore_getThumbnailWithoutDefault __cb, RInt sizeX, RInt sizeY) Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef).
void	isInProgress_async(AMD_ThumbnailStore_isInProgress __cb) This returns the last available in progress state for a thumbnail.
void	resetDefaults_async(AMD_ThumbnailStore_resetDefaults __cb) Resets the rendering definition for the active pixels set to its default settings.
void	setPixelsId_async(AMD_ThumbnailStore_setPixelsId __cb, long pixelsId) This method manages the state of the service; it must be invoked before using any other methods.
void	setRenderingDefId_async(AMD_ThumbnailStore_setRenderingDefId __cb, long renderingDefId) This method manages the state of the service; it should be invoked directly after setPixelsId.
void	thumbnailExists_async(AMD_ThumbnailStore_thumbnailExists __cb, RInt sizeX, RInt sizeY) Checks if a thumbnail of a particular size exists for a pixels set.

Methods inherited from interface omero.api._StatefulServiceInterfaceOperationsNC

activate_async, close_async, getCurrentEventContext_async, passivate_async

Method Detail

setPixelsId_async

void setPixelsId_async(AMD_ThumbnailStore_setPixelsId __cb,
                       long pixelsId)
                throws ServerError

This method manages the state of the service; it must be invoked before using any other methods. As the ThumbnailStore relies on the RenderingEngine, a valid rendering definition must be available for it to work.

Parameters:

__cb - The callback object for the operation.

pixelsId - an Pixels id.

Throws:

ApiUsageException - if no pixels object exists with the ID pixelsId.

ServerError

isInProgress_async

void isInProgress_async(AMD_ThumbnailStore_isInProgress __cb)
                 throws ServerError

This returns the last available in progress state for a thumbnail. Its return value is only expected to be valid after the call to any of the individual thumbnail retrieval methods.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

setRenderingDefId_async

void setRenderingDefId_async(AMD_ThumbnailStore_setRenderingDefId __cb,
                             long renderingDefId)
                      throws ServerError

This method manages the state of the service; it should be invoked directly after setPixelsId. If it is not invoked with a valid rendering definition ID before using the thumbnail accessor methods execution continues as if renderingDefId were set to null.

Parameters:

__cb - The callback object for the operation.

renderingDefId - an RenderingDef id. null specifies the user's currently active rendering settings to be used.

Throws:

ValidationException - if no rendering definition exists with the ID renderingDefId.

ServerError

getRenderingDefId_async

void getRenderingDefId_async(AMD_ThumbnailStore_getRenderingDefId __cb)
                      throws ServerError

Return the id of the RenderingDef loaded in this instance.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getThumbnail_async

void getThumbnail_async(AMD_ThumbnailStore_getThumbnail __cb,
                        RInt sizeX,
                        RInt sizeY)
                 throws ServerError

Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef). If the thumbnail exists in the on-disk cache it will be returned directly, otherwise it will be created as in getThumbnailDirect, placed in the on-disk cache and returned. If the thumbnail is missing, a clock will be returned to signify that the thumbnail is yet to be generated.

Parameters:

__cb - The callback object for the operation.

sizeX - the X-axis width of the thumbnail. null specifies the default size of 48.

sizeY - the Y-axis width of the thumbnail. null specifies the default size of 48.

Throws:

ApiUsageException - if:

• sizeX is greater than pixels.sizeX
• sizeX is negative
• sizeY is greater than pixels.sizeY
• sizeY is negative
• setPixelsId has not yet been called

ServerError

getThumbnailWithoutDefault_async

void getThumbnailWithoutDefault_async(AMD_ThumbnailStore_getThumbnailWithoutDefault __cb,
                                      RInt sizeX,
                                      RInt sizeY)
                               throws ServerError

Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef). If the thumbnail exists in the on-disk cache it will be returned directly, otherwise it will be created as in getThumbnailDirect, placed in the on-disk cache and returned. If the thumbnail is still to be generated, an empty array will be returned.

Parameters:

__cb - The callback object for the operation.

sizeX - the X-axis width of the thumbnail. null specifies the default size of 48.

sizeY - the Y-axis width of the thumbnail. null specifies the default size of 48.

Throws:

ApiUsageException - if:

• sizeX is greater than pixels.sizeX
• sizeX is negative
• sizeY is greater than pixels.sizeY
• sizeY is negative
• setPixelsId has not yet been called

ServerError

getThumbnailSet_async

void getThumbnailSet_async(AMD_ThumbnailStore_getThumbnailSet __cb,
                           RInt sizeX,
                           RInt sizeY,
                           java.util.List<java.lang.Long> pixelsIds)
                    throws ServerError

Retrieves a number of thumbnails for pixels sets using given sets of rendering settings (RenderingDef). If the thumbnails exist in the on-disk cache they will be returned directly, otherwise they will be created as in getThumbnailDirect, placed in the on-disk cache and returned. Unlike the other thumbnail retrieval methods, this method may be called without first calling setPixelsId.

Parameters:

__cb - The callback object for the operation.

sizeX - the X-axis width of the thumbnail. null specifies the default size of 48.

sizeY - the Y-axis width of the thumbnail. null specifies the default size of 48.

pixelsIds - the Pixels sets to retrieve thumbnails for.

Throws:

ServerError

getThumbnailByLongestSideSet_async

void getThumbnailByLongestSideSet_async(AMD_ThumbnailStore_getThumbnailByLongestSideSet __cb,
                                        RInt size,
                                        java.util.List<java.lang.Long> pixelsIds)
                                 throws ServerError

Retrieves a number of thumbnails for pixels sets using given sets of rendering settings (RenderingDef). If the Thumbnails exist in the on-disk cache they will be returned directly, otherwise they will be created as in getThumbnailByLongestSideDirect. The longest side of the image will be used to calculate the size for the smaller side in order to keep the aspect ratio of the original image. Unlike the other thumbnail retrieval methods, this method may be called without first calling setPixelsId.

Parameters:

__cb - The callback object for the operation.

size - the size of the longest side of the thumbnail requested. null specifies the default size of 48.

pixelsIds - the Pixels sets to retrieve thumbnails for.

Throws:

ServerError

getThumbnailByLongestSide_async

void getThumbnailByLongestSide_async(AMD_ThumbnailStore_getThumbnailByLongestSide __cb,
                                     RInt size)
                              throws ServerError

Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef). If the thumbnail exists in the on-disk cache it will be returned directly, otherwise it will be created as in getThumbnailDirect, placed in the on-disk cache and returned. The longest side of the image will be used to calculate the size for the smaller side in order to keep the aspect ratio of the original image.

Parameters:

__cb - The callback object for the operation.

size - the size of the longest side of the thumbnail requested. null specifies the default size of 48.

Throws:

ApiUsageException - if:

• size is greater than pixels.sizeX and pixels.sizeY
• setPixelsId has not yet been called

ServerError

getThumbnailByLongestSideDirect_async

void getThumbnailByLongestSideDirect_async(AMD_ThumbnailStore_getThumbnailByLongestSideDirect __cb,
                                           RInt size)
                                    throws ServerError

Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef). The Thumbnail will always be created directly, ignoring the on-disk cache. The longest side of the image will be used to calculate the size for the smaller side in order to keep the aspect ratio of the original image.

Parameters:

__cb - The callback object for the operation.

size - the size of the longest side of the thumbnail requested. null specifies the default size of 48.

Throws:

ApiUsageException - if:

• size is greater than pixels.sizeX and pixels.sizeY
• setPixelsId has not yet been called

ServerError

getThumbnailDirect_async

void getThumbnailDirect_async(AMD_ThumbnailStore_getThumbnailDirect __cb,
                              RInt sizeX,
                              RInt sizeY)
                       throws ServerError

Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef). The Thumbnail will always be created directly, ignoring the on-disk cache.

Parameters:

__cb - The callback object for the operation.

sizeX - the X-axis width of the thumbnail. null specifies the default size of 48.

sizeY - the Y-axis width of the thumbnail. null specifies the default size of 48.

Throws:

ApiUsageException - if:

• sizeX is greater than pixels.sizeX
• sizeX is negative
• sizeY is greater than pixels.sizeY
• sizeY is negative
• setPixelsId has not yet been called

ServerError

getThumbnailForSectionDirect_async

void getThumbnailForSectionDirect_async(AMD_ThumbnailStore_getThumbnailForSectionDirect __cb,
                                        int theZ,
                                        int theT,
                                        RInt sizeX,
                                        RInt sizeY)
                                 throws ServerError

Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef) for a particular section. The Thumbnail will always be created directly, ignoring the on-disk cache.

Parameters:

__cb - The callback object for the operation.

theZ - the optical section (offset across the Z-axis) to use.

theT - the timepoint (offset across the T-axis) to use.

sizeY - the Y-axis width of the thumbnail. null specifies the default size of 48.

Throws:

ApiUsageException - if:

• sizeX is greater than pixels.sizeX
• sizeX is negative
• sizeY is greater than pixels.sizeY
• sizeY is negative
• theZ is out of range
• theT is out of range
• setPixelsId has not yet been called

ServerError

getThumbnailForSectionByLongestSideDirect_async

void getThumbnailForSectionByLongestSideDirect_async(AMD_ThumbnailStore_getThumbnailForSectionByLongestSideDirect __cb,
                                                     int theZ,
                                                     int theT,
                                                     RInt size)
                                              throws ServerError

Retrieves a thumbnail for a pixels set using a given set of rendering settings (RenderingDef) for a particular section. The Thumbnail will always be created directly, ignoring the on-disk cache. The longest side of the image will be used to calculate the size for the smaller side in order to keep the aspect ratio of the original image.

Parameters:

__cb - The callback object for the operation.

theZ - the optical section (offset across the Z-axis) to use.

theT - the timepoint (offset across the T-axis) to use.

Throws:

ApiUsageException - if:

• size is greater than pixels.sizeX and pixels.sizeY
• setPixelsId has not yet been called

ServerError

createThumbnails_async

void createThumbnails_async(AMD_ThumbnailStore_createThumbnails __cb)
                     throws ServerError

Creates thumbnails for a pixels set using a given set of rendering settings (RenderingDef) in the on-disk cache for every sizeX/sizeY combination already cached.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

createThumbnail_async

void createThumbnail_async(AMD_ThumbnailStore_createThumbnail __cb,
                           RInt sizeX,
                           RInt sizeY)
                    throws ServerError

Creates a thumbnail for a pixels set using a given set of rendering settings (RenderingDef) in the on-disk cache.

Parameters:

__cb - The callback object for the operation.

sizeX - the X-axis width of the thumbnail. null specifies the default size of 48.

sizeY - the Y-axis width of the thumbnail. null specifies the default size of 48.

Throws:

ApiUsageException - if:

• sizeX is greater than pixels.sizeX
• sizeX is negative
• sizeY is greater than pixels.sizeY
• sizeY is negative
• setPixelsId has not yet been called

ServerError

createThumbnailsByLongestSideSet_async

void createThumbnailsByLongestSideSet_async(AMD_ThumbnailStore_createThumbnailsByLongestSideSet __cb,
                                            RInt size,
                                            java.util.List<java.lang.Long> pixelsIds)
                                     throws ServerError

Creates thumbnails for a number of pixels sets using a given set of rendering settings (RenderingDef) in the on-disk cache. Unlike the other thumbnail creation methods, this method may be called without first calling setPixelsId. This method will not reset or modify rendering settings in any way. If rendering settings for a pixels set are not present, thumbnail creation for that pixels set will not be performed.

Parameters:

__cb - The callback object for the operation.

size - the size of the longest side of the thumbnail requested. null specifies the default size of 48.

pixelsIds - the Pixels sets to retrieve thumbnails for.

Throws:

ApiUsageException - if:

• size is greater than pixels.sizeX and pixels.sizeY
• size is negative

ServerError

thumbnailExists_async

void thumbnailExists_async(AMD_ThumbnailStore_thumbnailExists __cb,
                           RInt sizeX,
                           RInt sizeY)
                    throws ServerError

Checks if a thumbnail of a particular size exists for a pixels set.

Parameters:

__cb - The callback object for the operation.

sizeX - the X-axis width of the thumbnail. null specifies the default size of 48.

sizeY - the Y-axis width of the thumbnail. null specifies the default size of 48.

Throws:

ApiUsageException - if:

• sizeX is negative
• sizeY is negative
• #setPixelsId has not yet been called

ServerError

resetDefaults_async

void resetDefaults_async(AMD_ThumbnailStore_resetDefaults __cb)
                  throws ServerError

Resets the rendering definition for the active pixels set to its default settings.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError