2
|
1 |
/*
|
|
2 |
* Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
|
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
4 |
*
|
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
|
7 |
* published by the Free Software Foundation. Sun designates this
|
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
|
9 |
* by Sun in the LICENSE file that accompanied this code.
|
|
10 |
*
|
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
|
15 |
* accompanied this code).
|
|
16 |
*
|
|
17 |
* You should have received a copy of the GNU General Public License version
|
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
20 |
*
|
|
21 |
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
|
|
22 |
* CA 95054 USA or visit www.sun.com if you need additional information or
|
|
23 |
* have any questions.
|
|
24 |
*/
|
|
25 |
|
|
26 |
package javax.sql.rowset.spi;
|
|
27 |
|
|
28 |
import java.sql.SQLException;
|
|
29 |
import java.io.Reader;
|
|
30 |
|
|
31 |
import javax.sql.RowSetReader;
|
|
32 |
import javax.sql.rowset.*;
|
|
33 |
|
|
34 |
/**
|
|
35 |
* A specialized interface that facilitates an extension of the
|
|
36 |
* <code>SyncProvider</code> abstract class for XML orientated
|
|
37 |
* synchronization providers.
|
|
38 |
* <P>
|
|
39 |
* <code>SyncProvider</code> implementations that supply XML data reader
|
|
40 |
* capabilities such as output XML stream capabilities can implement this
|
|
41 |
* interface to provider standard <code>XmlReader</code> objects to
|
|
42 |
* <code>WebRowSet</code> implementations.
|
|
43 |
* <p>
|
|
44 |
* An <code>XmlReader</code> object is registered as the
|
|
45 |
* XML reader for a <code>WebRowSet</code> by being assigned to the
|
|
46 |
* rowset's <code>xmlReader</code> field. When the <code>WebRowSet</code>
|
|
47 |
* object's <code>readXml</code> method is invoked, it in turn invokes
|
|
48 |
* its XML reader's <code>readXML</code> method.
|
|
49 |
*/
|
|
50 |
public interface XmlReader extends RowSetReader {
|
|
51 |
|
|
52 |
/**
|
|
53 |
* Reads and parses the given <code>WebRowSet</code> object from the given
|
|
54 |
* input stream in XML format. The <code>xmlReader</code> field of the
|
|
55 |
* given <code>WebRowSet</code> object must contain this
|
|
56 |
* <code>XmlReader</code> object.
|
|
57 |
* <P>
|
|
58 |
* If a parsing error occurs, the exception that is thrown will
|
|
59 |
* include information about the location of the error in the
|
|
60 |
* original XML document.
|
|
61 |
*
|
|
62 |
* @param caller the <code>WebRowSet</code> object to be parsed, whose
|
|
63 |
* <code>xmlReader</code> field must contain a reference to
|
|
64 |
* this <code>XmlReader</code> object
|
|
65 |
* @param reader the <code>java.io.Reader</code> object from which
|
|
66 |
* <code>caller</code> will be read
|
|
67 |
* @throws SQLException if a database access error occurs or
|
|
68 |
* this <code>XmlReader</code> object is not the reader
|
|
69 |
* for the given rowset
|
|
70 |
*/
|
|
71 |
public void readXML(WebRowSet caller, java.io.Reader reader)
|
|
72 |
throws SQLException;
|
|
73 |
|
|
74 |
}
|