/*
*
* 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.tools.integration;
import java.io.Writer;
import java.sql.Connection;
import javax.sql.DataSource;
import schemacrawler.crawl.CachingCrawlHandler;
import schemacrawler.main.HelpOptions;
import schemacrawler.main.HelpOptions.CommandHelpType;
import schemacrawler.schema.Catalog;
/**
* An executor that uses a template renderer to render a schema.
*
* @author sfatehi
*/
public abstract class SchemaRenderer
extends SchemaExecutable
{
/**
* Get connection parameters, and creates a connection, and crawls the
* schema.
*
* @param args
* Arguments passed into the program from the command line.
* @throws Exception
* On an exception
*/
public void main(final String[] args)
throws Exception
{
final HelpOptions helpOptions = new HelpOptions("SchemaCrawler - Templating");
helpOptions.setCommandHelpType(CommandHelpType.without_operations);
helpOptions.setResourceOutputOptions("/help/OutputOptions.templating.txt");
executeOnSchema(args, helpOptions);
}
@Override
protected void doExecute(final DataSource dataSource)
throws Exception
{
// Get the entire schema at once
final Connection connection = dataSource.getConnection();
crawlHandler = new CachingCrawlHandler(connection.getCatalog());
super.execute(dataSource);
final Catalog catalog = ((CachingCrawlHandler) crawlHandler).getCatalog();
// Executable-specific work
final Writer writer = toolOptions.getOutputOptions().openOutputWriter();
final String templateName = toolOptions.getOutputOptions()
.getOutputFormatValue();
render(templateName, catalog, writer);
toolOptions.getOutputOptions().closeOutputWriter(writer);
}
/**
* Renders the schema with the given template.
*
* @param resource
* Location of the resource
* @param catalog
* Catalog
* @param writer
* Writer
* @throws Exception
*/
protected abstract void render(final String resource,
final Catalog catalog,
final Writer writer)
throws Exception;
}