DataToolsExecutable.java

/*
 *
 * 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.datatext;


import java.sql.Connection;

import schemacrawler.execute.DataHandler;
import schemacrawler.execute.QueryExecutor;
import schemacrawler.schemacrawler.SchemaCrawlerException;
import schemacrawler.tools.Executable;

/**
 * Basic SchemaCrawler executor.
 * 
 * @author Sualeh Fatehi
 */
public class DataToolsExecutable
  extends Executable<DataTextFormatOptions>
{

  /**
   * Instantiates a text formatter type of DataHandler from the mnemonic
   * string.
   * 
   * @param options
   *        Options
   * @throws SchemaCrawlerException
   *         On an exception
   * @return CrawlHandler instance
   */
  public static DataHandler createDataHandler(final DataTextFormatOptions options)
    throws SchemaCrawlerException
  {
    try
    {
      final DataHandler handler = new DataTextFormatter(options);
      return handler;
    }
    catch (final Exception e)
    {
      throw new SchemaCrawlerException(e.getMessage(), e);
    }
  }

  public DataToolsExecutable()
  {
    this(null);
  }

  public DataToolsExecutable(final String name)
  {
    super(name);
  }

  /**
   * {@inheritDoc}
   * 
   * @see schemacrawler.tools.Executable#execute(javax.sql.DataSource)
   */
  @Override
  public void execute(final Connection connection)
    throws Exception
  {
    if (connection == null)
    {
      throw new IllegalArgumentException("No connection provided");
    }
    initialize();

    final DataHandler dataHandler = new DataTextFormatter(toolOptions);
    final QueryExecutor executor = new QueryExecutor(connection, dataHandler);
    executor.executeSQL(toolOptions.getQuery().getQuery());
  }

}