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.DataSetException;
24  import org.dbunit.dataset.IDataSet;
25  import org.dbunit.dataset.ITableIterator;
26  
27  /**
28   * Represents a strategy used by {@link org.dbunit.dataset.FilteredDataSet} to
29   * exposes only some tables from a dataset.
30   *
31   * @author Manuel Laflamme
32   * @since Mar 7, 2003
33   * @version $Revision$
34   */
35  public interface ITableFilter extends ITableFilterSimple
36  {
37  
38      /**
39       * Returns the table names allowed by this filter from the specified dataset.
40       *
41       * @param dataSet the filtered dataset
42       */
43      public String[] getTableNames(IDataSet dataSet) throws DataSetException;
44  
45      /**
46       * Returns iterator of tables allowed by this filter from the specified dataset.
47       *
48       * @param dataSet the filtered dataset
49       */
50      public ITableIterator iterator(IDataSet dataSet, boolean reversed)
51              throws DataSetException;
52  }