View Javadoc
1   /*
2    *
3    * The DbUnit Database Testing Framework
4    * Copyright (C)2002-2004, 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.filter;
22  
23  import org.dbunit.dataset.Column;
24  
25  /**
26   * A filter for database columns.
27   * 
28   * <p> Instances of this interface may be passed to the 
29   * <code>{@link org.dbunit.dataset.FilteredTableMetaData#FilteredTableMetaData(org.dbunit.dataset.ITableMetaData, IColumnFilter)}</code> 
30   * method of the <code>{@link org.dbunit.dataset.FilteredTableMetaData}</code> class.
31   * 
32   * @author Manuel Laflamme
33   * @since Apr 17, 2004
34   * @version $Revision$
35   */
36  public interface IColumnFilter
37  {
38  	/**
39  	 * Tests whether or not the specified column of the specified tableName
40  	 * should be included by this filter.
41  	 *
42  	 * @param tableName The tableName to be tested
43  	 * @param column The column to be tested
44  	 * @return <code>true</code> if and only if the given parameter set should be included
45  	 */
46  	public boolean accept(String tableName, Column column);
47  }