DatabaseImporter.java

/*
Copyright 2008-2010 Gephi
Authors : Mathieu Bastian <mathieu.bastian@gephi.org>
Website : http://www.gephi.org

This file is part of Gephi.

Gephi is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

Gephi is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with Gephi.  If not, see <http://www.gnu.org/licenses/>.
*/
package org.gephi.io.importer.spi;

import org.gephi.io.importer.api.Database;
import org.gephi.io.importer.api.ImportController;

/**
 * Importers interface for importing data from database sources.
 *
 * @author Mathieu Bastian
 * @see ImportController
 */
public interface DatabaseImporter extends Importer {

    /**
     * Sets the database description, connexion details and queries
     * @param database  the database that is to be used to import
     */
    public void setDatabase(Database database);

    /**
     * Returns the current database description, connexion details and queries
     * @return         the database that is to be used to import
     */
    public Database getDatabase();
}