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.stream;
22  
23  import org.dbunit.dataset.DataSetException;
24  
25  
26  /**
27   * Interface for reading a dataset using callback.
28   *
29   * @author Manuel Laflamme
30   * @since Apr 17, 2003
31   * @version $Revision$
32   */
33  public interface IDataSetProducer
34  {
35      public void setConsumer(IDataSetConsumer consumer) throws DataSetException;
36  
37      /**
38       * Process this dataset source. During the processing, the IDataSetProducer
39       * will provide information about the dataset through the specified event
40       * listener.
41       * <p>
42       * This method is synchronous: it will not return until processing has ended.
43       * If a client application wants to terminate parsing early, it should
44       * throw an exception from the listener.
45       */
46      public void produce() throws DataSetException;
47  }