icy.file

Interface FileImporter

All Known Implementing Classes:

PluginFileImporter

public interface FileImporter

File importer interface.
The importer is directly integrated in the classic Open command menu and can open any file type except image (use the SequenceFileImporter interface for image file).
It is from his responsibility to make the opened file available in the application.

Author:

Stephane

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.
boolean	load(java.lang.String path, FileFrame loadingFrame) Load the specified file and returns true if the operation succeed.

Method Detail

acceptFile

boolean acceptFile(java.lang.String path)

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

getFileFilters

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

Return the supported FileFilter for this importer.

load

boolean load(java.lang.String path,
           FileFrame loadingFrame)
             throws UnsupportedFormatException,
                    java.io.IOException

Load the specified file and returns true if the operation succeed.
The method is free to handle the way it makes the opened file available in the application.

Parameters:

path - File to load.

loadingFrame - Frame where to display the loading progression (can be null if no progression wanted)

Returns:

true if the operation succeed

Throws:

UnsupportedFormatException

java.io.IOException