javax.sql.rowset.spi
Interface XmlReader

All Superinterfaces:
RowSetReader sample code for javax.sql.RowSetReader definition code for javax.sql.RowSetReader

public interface XmlReader
extends RowSetReader sample code for javax.sql.RowSetReader definition code for javax.sql.RowSetReader

A specialized interface that facilitates an extension of the SyncProvider abstract class for XML orientated synchronization providers.

SyncProvider implementations that supply XML data reader capabilities such as output XML stream capabilities can implement this interface to provider standard XmlReader objects to WebRowSet implementations.

An XmlReader object is registered as the XML reader for a WebRowSet by being assigned to the rowset's xmlReader field. When the WebRowSet object's readXml method is invoked, it in turn invokes its XML reader's readXML method.


Method Summary
 void readXML sample code for javax.sql.rowset.spi.XmlReader.readXML(javax.sql.rowset.WebRowSet, java.io.Reader) definition code for javax.sql.rowset.spi.XmlReader.readXML(javax.sql.rowset.WebRowSet, java.io.Reader) (WebRowSet sample code for javax.sql.rowset.WebRowSet definition code for javax.sql.rowset.WebRowSet  caller, Reader sample code for java.io.Reader definition code for java.io.Reader  reader)
          Reads and parses the given WebRowSet object from the given input stream in XML format.
 
Methods inherited from interface javax.sql.RowSetReader sample code for javax.sql.RowSetReader definition code for javax.sql.RowSetReader
readData sample code for javax.sql.RowSetReader.readData(javax.sql.RowSetInternal) definition code for javax.sql.RowSetReader.readData(javax.sql.RowSetInternal)
 

Method Detail

readXML sample code for javax.sql.rowset.spi.XmlReader.readXML(javax.sql.rowset.WebRowSet, java.io.Reader) definition code for javax.sql.rowset.spi.XmlReader.readXML(javax.sql.rowset.WebRowSet, java.io.Reader)

void readXML(WebRowSet sample code for javax.sql.rowset.WebRowSet definition code for javax.sql.rowset.WebRowSet  caller,
             Reader sample code for java.io.Reader definition code for java.io.Reader  reader)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Reads and parses the given WebRowSet object from the given input stream in XML format. The xmlReader field of the given WebRowSet object must contain this XmlReader object.

If a parsing error occurs, the exception that is thrown will include information about the location of the error in the original XML document.

Parameters:
caller - the WebRowSet object to be parsed, whose xmlReader field must contain a reference to this XmlReader object
reader - the java.io.Reader object from which caller will be read
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs or this XmlReader object is not the reader for the given rowset