icy.file

Interface SequenceFileImporter

All Superinterfaces:

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

All Known Implementing Classes:

LociImporterPlugin, PluginSequenceFileImporter, SequenceFileGroupImporter

public interface SequenceFileImporter
extends SequenceIdImporter

Sequence file importer interface.
The importer is directly integrated in the classic Open command menu and in the Loader class to open Sequence.
Can take any resource type identified by a file 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.

Author:

Stephane

See Also:

SequenceIdImporter

Field Summary

Fields inherited from interface icy.sequence.SequenceIdImporter

FLAG_METADATA_ALL, FLAG_METADATA_MASK, FLAG_METADATA_MINIMUM

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptFile(java.lang.String path) Return true if the specified file can be opened by the importer
java.util.List<javax.swing.filechooser.FileFilter>	getFileFilters() Return the supported FileFilter for this importer.
java.lang.String	getOpened()
boolean	open(java.lang.String path, int flags) Open the image designed by the specified file path to allow image data / metadata access.

Methods inherited from interface icy.sequence.SequenceIdImporter

close

Methods inherited from interface icy.image.ImageProvider

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

Method Detail

acceptFile

boolean acceptFile(java.lang.String path)

Return true if the specified file can be opened by the importer

getOpened

java.lang.String getOpened()

Specified by:

getOpened in interface SequenceIdImporter

Returns:

The path of the image file of the image currently opened or null otherwise.
Note that path is always returned in generic java path style (see FileUtil.getGenericPath(String) method).

See Also:

open(String, int), SequenceIdImporter.close()

open

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

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

Specified by:

open in interface SequenceIdImporter

Parameters:

path - Path of the image file to open.

flags - operation flag:

SequenceIdImporter.FLAG_METADATA_MINIMUM = load minimum metadata informations

SequenceIdImporter.FLAG_METADATA_ALL = load all metadata informations

Returns:

true if the operation has succeeded and false otherwise.

Throws:

UnsupportedFormatException

java.io.IOException

getFileFilters

java.util.List<javax.swing.filechooser.FileFilter> getFileFilters()

Return the supported FileFilter for this importer.