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;
22  
23  /**
24   * @author Manuel Laflamme
25   * @since Apr 5, 2003
26   * @version $Revision$
27   */
28  public interface ITableIterator
29  {
30      /**
31       * Position this iterator to the next table. The iterator is initially
32       * positioned before the first table; the first call to the method next
33       * makes the first table the current table; the second call makes the
34       * second table the current table, and so on.
35       *
36       * @return <code>true</code> if the new current table is valid;
37       * <code>false</code> if there are no more table
38       */
39      public boolean next() throws DataSetException;
40  
41      /**
42       * Returns the metadata of the current table.
43       */
44      public ITableMetaData getTableMetaData() throws DataSetException;
45  
46      /**
47       * Returns the current table.
48       */
49      public ITable getTable() throws DataSetException;
50  }