icy.sequence

Interface SequenceIdImporter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ImageProvider

All Known Subinterfaces:

SequenceFileImporter

All Known Implementing Classes:

LociImporterPlugin, PluginSequenceFileImporter, PluginSequenceIdImporter, SequenceFileGroupImporter

public interface SequenceIdImporter
extends ImageProvider, java.io.Closeable

Sequence importer interface.
Used to define a specific Sequence importer.
Can take any resource type identified by an ID and should be able to give multiple level access to the image data.
See details about the image data access implementation with the ImageProvider interface and AbstractImageProvider abstract class helper. Note that you have SequenceFileImporter interface which allow to import Sequence from file(s).

Author:

Stephane

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAG_METADATA_ALL Flag to indicate we want to load all possible metadata
static int	FLAG_METADATA_MASK
static int	FLAG_METADATA_MINIMUM Flag to indicate we want to load only mandatory metadata informations (faster metadata loading)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the image which has been previously opened with open(String, int) method.
java.lang.String	getOpened()
boolean	open(java.lang.String id, int flags) Open the image designed by the specified id to allow image data / metadata access.

Methods inherited from interface icy.image.ImageProvider

getImage, getImage, getImage, getImage, getImage, getImage, getMetaData, getOMEXMLMetaData, getPixels, getThumbnail, getTileHeight, getTileWidth, isResolutionAvailable

Field Detail

FLAG_METADATA_MASK

static final int FLAG_METADATA_MASK

See Also:

Constant Field Values

FLAG_METADATA_MINIMUM

static final int FLAG_METADATA_MINIMUM

Flag to indicate we want to load only mandatory metadata informations (faster metadata loading)

See Also:

Constant Field Values

FLAG_METADATA_ALL

static final int FLAG_METADATA_ALL

Flag to indicate we want to load all possible metadata

See Also:

Constant Field Values

Method Detail

getOpened

java.lang.String getOpened()

Returns:

The id of the image currently opened or null otherwise.

See Also:

open(String, int), close()

open

boolean open(java.lang.String id,
           int flags)
             throws UnsupportedFormatException,
                    java.io.IOException

Open the image designed by the specified id to allow image data / metadata access.
Calling this method will automatically close the previous opened image.
Don't forget to call close() to close the image when you're done.

Parameters:

id - Image id, it can be a file path or URL or whatever depending the internal import method.

flags - operation flag:

FLAG_METADATA_MINIMUM = load minimum metadata informations

FLAG_METADATA_ALL = load all metadata informations

Returns:

true if the operation has succeeded and false otherwise.

Throws:

UnsupportedFormatException

java.io.IOException

close

void close()
           throws java.io.IOException

Close the image which has been previously opened with open(String, int) method.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException