ColumnFilterTable.java

  1. /*
  2.  *
  3.  * The DbUnit Database Testing Framework
  4.  * Copyright (C)2002-2008, DbUnit.org
  5.  *
  6.  * This library is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU Lesser General Public
  8.  * License as published by the Free Software Foundation; either
  9.  * version 2.1 of the License, or (at your option) any later version.
  10.  *
  11.  * This library is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.  * Lesser General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU Lesser General Public
  17.  * License along with this library; if not, write to the Free Software
  18.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19.  *
  20.  */
  21. package org.dbunit.dataset;

  22. import org.dbunit.dataset.filter.IColumnFilter;
  23. import org.slf4j.Logger;
  24. import org.slf4j.LoggerFactory;

  25. /**
  26.  * A table that filters some columns out from the original table.
  27.  *
  28.  * @author gommma (gommma AT users.sourceforge.net)
  29.  * @author Last changed by: $Author$
  30.  * @version $Revision$ $Date$
  31.  * @since 2.4.0
  32.  */
  33. public class ColumnFilterTable implements ITable
  34. {
  35.     /**
  36.      * logger
  37.      */
  38.     private final Logger logger = LoggerFactory.getLogger(ColumnFilterTable.class);

  39.     /**
  40.      * reference to the original table being wrapped
  41.      */
  42.     private final ITable originalTable;
  43.    
  44.     /**
  45.      * The filtered table metadata
  46.      */
  47.     private final ITableMetaData tableMetaData;

  48.    
  49.     /**
  50.      * @param table The table from which some columns should be filtered
  51.      * @param columnFilter The filter defining which columns to be filtered
  52.      * @throws DataSetException
  53.      */
  54.     public ColumnFilterTable(ITable table, IColumnFilter columnFilter)
  55.     throws DataSetException
  56.     {
  57.         if (columnFilter == null) {
  58.             throw new NullPointerException(
  59.                     "The parameter 'columnFilter' must not be null");
  60.         }
  61.         if (table == null) {
  62.             throw new NullPointerException(
  63.                     "The parameter 'table' must not be null");
  64.         }
  65.        
  66.         this.tableMetaData = new FilteredTableMetaData(
  67.                 table.getTableMetaData(), columnFilter);
  68.         this.originalTable = table;
  69.     }

  70.    
  71.     public int getRowCount()
  72.     {
  73.         logger.debug("getRowCount() - start");
  74.         return this.originalTable.getRowCount();
  75.     }

  76.     public ITableMetaData getTableMetaData()
  77.     {
  78.         logger.debug("getTableMetaData() - start");
  79.         return this.tableMetaData;
  80.     }

  81.     public Object getValue(int row, String column) throws DataSetException
  82.     {
  83.         if(logger.isDebugEnabled())
  84.             logger.debug("getValue(row={}, columnName={}) - start", Integer.toString(row), column);

  85.         return this.originalTable.getValue(row, column);
  86.     }

  87.     public ITableMetaData getOriginalMetaData()
  88.     {
  89.         logger.debug("getOriginalMetaData() - start");
  90.         return this.originalTable.getTableMetaData();
  91.     }

  92.     public String toString()
  93.     {
  94.         return this.originalTable.toString();
  95.     }
  96. }