01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.sql;
23:
24: import java.sql.SQLException;
25:
26: /**
27: * An object implementing the RowSetReader interface may be registered with a RowSet object that supports
28: * the reader/writer paradigm. A RowSetReader object is called by a rowset to produce a new set of rows which
29: * will become the rowset's contents.
30: */
31: public interface RowSetReader {
32: /**
33: * <p>Read the new contents of a rowset. This method is invoked internally by the RowSet.execute()
34: * method for rowsets that support the reader/writer paradigm.</p>
35: *
36: * <p>The readData() method uses the RowSet.insertRow() or RowSet.populate() methods to add rows
37: * to the caller. In general, any of the caller's methods may be called by the reader with one
38: * exception, calling execute() will throw an SQLException since execute may not be called
39: * recursively. Also, rowset events, such as RowSetChanged, etc. are not generated by RowSet methods
40: * invoked by a reader.</p>
41: *
42: * @param rowSetInternal - the rowset that called the reader
43: * @exception SQLException - if a database-access error occurs
44: */
45: public void readData(RowSetInternal rowSetInternal)
46: throws SQLException;
47: }
|