001/*
002 * Copyright 2010-2015 Institut Pasteur.
003 * 
004 * This file is part of Icy.
005 * 
006 * Icy is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 * 
011 * Icy is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
014 * GNU General Public License for more details.
015 * 
016 * You should have received a copy of the GNU General Public License
017 * along with Icy. If not, see <http://www.gnu.org/licenses/>.
018 */
019package icy.file;
020
021import icy.sequence.Sequence;
022
023/**
024 * Importer interface.<br>
025 * Used to define a specific importer visible in the <b>Import</b> section.<br>
026 * Note that you have {@link FileImporter} and {@link SequenceFileImporter} interfaces
027 * which allow to import resources from file or {@link Sequence} from file.
028 * 
029 * @author Stephane
030 */
031public interface Importer
032{
033    /**
034     * Launch the importer.<br>
035     * The importer is responsible to handle its own UI and load the wanted resource.
036     * 
037     * @return <code>true</code> if the operation succeed
038     */
039    public boolean load() throws Exception;
040}