javax.sql.rowset.spi
Interface XmlWriter

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

public interface XmlWriter
extends RowSetWriter sample code for javax.sql.RowSetWriter definition code for javax.sql.RowSetWriter

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

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

Writing a WebRowSet object includes printing the rowset's data, metadata, and properties, all with the appropriate XML tags.


Method Summary
 void writeXML sample code for javax.sql.rowset.spi.XmlWriter.writeXML(javax.sql.rowset.WebRowSet, java.io.Writer) definition code for javax.sql.rowset.spi.XmlWriter.writeXML(javax.sql.rowset.WebRowSet, java.io.Writer) (WebRowSet sample code for javax.sql.rowset.WebRowSet definition code for javax.sql.rowset.WebRowSet  caller, Writer sample code for java.io.Writer definition code for java.io.Writer  writer)
          Writes the given WebRowSet object to the specified java.io.Writer output stream as an XML document.
 
Methods inherited from interface javax.sql.RowSetWriter sample code for javax.sql.RowSetWriter definition code for javax.sql.RowSetWriter
writeData sample code for javax.sql.RowSetWriter.writeData(javax.sql.RowSetInternal) definition code for javax.sql.RowSetWriter.writeData(javax.sql.RowSetInternal)
 

Method Detail

writeXML sample code for javax.sql.rowset.spi.XmlWriter.writeXML(javax.sql.rowset.WebRowSet, java.io.Writer) definition code for javax.sql.rowset.spi.XmlWriter.writeXML(javax.sql.rowset.WebRowSet, java.io.Writer)

void writeXML(WebRowSet sample code for javax.sql.rowset.WebRowSet definition code for javax.sql.rowset.WebRowSet  caller,
              Writer sample code for java.io.Writer definition code for java.io.Writer  writer)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Writes the given WebRowSet object to the specified java.io.Writer output stream as an XML document. This document includes the rowset's data, metadata, and properties plus the appropriate XML tags.

The caller parameter must be a WebRowSet object whose XmlWriter field contains a reference to this XmlWriter object.

Parameters:
caller - the WebRowSet instance to be written, for which this XmlWriter object is the writer
writer - the java.io.Writer object that serves as the output stream for writing caller as an XML document
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs or this XmlWriter object is not the writer for the given WebRowSet object