/*
    *
    * The DbUnit Database Testing Framework
    * Copyright (C)2002-2004, DbUnit.org
    *
    * 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 org.dbunit.dataset.filter;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import org.dbunit.dataset.DataSetException;
  import org.dbunit.dataset.IDataSet;
  import org.dbunit.dataset.ITable;
  import org.dbunit.dataset.ITableIterator;
  import org.dbunit.dataset.ITableMetaData;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * This class provides a skeletal implementation of the {@link ITableFilter}
   * interface to minimize the effort required to implement a filter. Subclasses
   * are only required to implement the {@link #isValidName} method.
   *
   * @author Manuel Laflamme
   * @author Last changed by: $Author$
   * @version $Revision$ $Date$
   * @since 2.2.0
   */
  public abstract class AbstractTableFilter implements ITableFilter
  {
  
      /**
       * Logger for this class
       */
      private static final Logger logger = LoggerFactory.getLogger(AbstractTableFilter.class);
  
      /**
       * Returns <code>true</code> if specified table is allowed by this filter.
       * This legacy method, now replaced by accept, still exist for compatibily
       * with older environment
       */
      public abstract boolean isValidName(String tableName) throws DataSetException;
  
      ////////////////////////////////////////////////////////////////////////////
      // ITableFilter interface
  
      public boolean accept(String tableName) throws DataSetException
      {
          logger.debug("accept(tableName={}) - start", tableName);
  
          return isValidName(tableName);
      }
  
      public String[] getTableNames(IDataSet dataSet) throws DataSetException
      {
          logger.debug("getTableNames(dataSet={}) - start", dataSet);
  
          String[] tableNames = dataSet.getTableNames();
          List nameList = new ArrayList();
          for (int i = 0; i < tableNames.length; i++)
          {
              String tableName = tableNames[i];
              if (accept(tableName))
              {
                  nameList.add(tableName);
              }
          }
          return (String[])nameList.toArray(new String[0]);
      }
  
      public ITableIterator iterator(IDataSet dataSet, boolean reversed)
              throws DataSetException
      {
          logger.debug("iterator(dataSet={}, reversed={}) - start", dataSet, String.valueOf(reversed));
  
          return new FilterIterator(reversed ?
                  dataSet.reverseIterator() : dataSet.iterator());
      }
  
      ////////////////////////////////////////////////////////////////////////////
      // FilterIterator class
  
      private class FilterIterator implements ITableIterator
      {
 
         /**
          * Logger for this class
          */
         private final Logger logger = LoggerFactory.getLogger(FilterIterator.class);
 
         private final ITableIterator _iterator;
 
         public FilterIterator(ITableIterator iterator)
         {
             _iterator = iterator;
         }
 
         ////////////////////////////////////////////////////////////////////////////
         // ITableIterator interface
 
         public boolean next() throws DataSetException
         {
             logger.debug("next() - start");
 
             while(_iterator.next())
             {
                 if (accept(_iterator.getTableMetaData().getTableName()))
                 {
                     return true;
                 }
             }
             return false;
         }
 
         public ITableMetaData getTableMetaData() throws DataSetException
         {
             logger.debug("getTableMetaData() - start");
 
             return _iterator.getTableMetaData();
         }
 
         public ITable getTable() throws DataSetException
         {
             logger.debug("getTable() - start");
 
             return _iterator.getTable();
         }
     }
 }