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 provide 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

  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 provide 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  * @since 1.5
  51  */
  52 public interface XmlReader extends RowSetReader {
  53 
  54   /**
  55    * Reads and parses the given <code>WebRowSet</code> object from the given
  56    * input stream in XML format. The <code>xmlReader</code> field of the
  57    * given <code>WebRowSet</code> object must contain this
  58    * <code>XmlReader</code> object.
  59    * <P>
  60    * If a parsing error occurs, the exception that is thrown will
  61    * include information about the location of the error in the
  62    * original XML document.
  63    *
  64    * @param caller the <code>WebRowSet</code> object to be parsed, whose
  65    *        <code>xmlReader</code> field must contain a reference to
  66    *        this <code>XmlReader</code> object
  67    * @param reader the <code>java.io.Reader</code> object from which
  68    *        <code>caller</code> will be read
  69    * @throws SQLException if a database access error occurs or
  70    *            this <code>XmlReader</code> object is not the reader