1 /*

     2  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. 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.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * 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 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

    71    *            for the given rowset

    72    */

    73   public void readXML(WebRowSet caller, java.io.Reader reader)

    74     throws SQLException;

    75 

    76 }