/*
*
* SchemaCrawler
* http://sourceforge.net/projects/schemacrawler
* Copyright (c) 2000-2009, Sualeh Fatehi.
*
* This library is free software; you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License as published by the Free Software Foundation;
* either version 2.1 of the License, or (at your option) any later version.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
*/
package schemacrawler.schemacrawler;
import schemacrawler.schema.ColumnDataType;
import schemacrawler.schema.DatabaseInfo;
import schemacrawler.schema.JdbcDriverInfo;
import schemacrawler.schema.Procedure;
import schemacrawler.schema.Table;
import schemacrawler.schema.WeakAssociations;
/**
* Handler for SchemaCrawler.
*/
public interface CrawlHandler
{
/**
* Handles the begin of the crawl.
*
* @throws SchemaCrawlerException
* On an exception
*/
void begin()
throws SchemaCrawlerException;
/**
* Handles the end of the crawl.
*
* @throws SchemaCrawlerException
* On an exception
*/
void end()
throws SchemaCrawlerException;
/**
* Handles information on column data types. This method may be called
* more than once, once for each schema.
*
* @param dataType
* Column data type information
* @throws SchemaCrawlerException
* On an exception
*/
void handle(ColumnDataType dataType)
throws SchemaCrawlerException;
/**
* Handles information on the database schema.
*
* @param databaseInfo
* Database information
* @throws SchemaCrawlerException
* On an exception
*/
void handle(DatabaseInfo databaseInfo)
throws SchemaCrawlerException;
/**
* Handles information on the JDBC driver.
*
* @param driverInfo
* JDBC driver information
* @throws SchemaCrawlerException
* On an exception
*/
void handle(JdbcDriverInfo driverInfo)
throws SchemaCrawlerException;
/**
* Provides information on the database schema.
*
* @param procedure
* Procedure information
* @throws SchemaCrawlerException
* On an exception
*/
void handle(Procedure procedure)
throws SchemaCrawlerException;
/**
* Provides information on the database schema.
*
* @param table
* Table information
* @throws SchemaCrawlerException
* On an exception
*/
void handle(Table table)
throws SchemaCrawlerException;
/**
* Provides information on the database schema.
*
* @param weakAssociations
* Table associations information
* @throws SchemaCrawlerException
* On an exception
*/
void handle(WeakAssociations weakAssociations)
throws SchemaCrawlerException;
}