/* * @(#)XmlWriter.java 1.4 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.sql.rowset.spi; import java.sql.SQLException; import java.io.Writer; import javax.sql.RowSetWriter; import javax.sql.rowset.*; /** * 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. */ public interface XmlWriter extends RowSetWriter { /** * 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. * * @param caller the WebRowSet instance to be written, * for which this XmlWriter object is the writer * @param writer the java.io.Writer object that serves * as the output stream for writing caller as * an XML document * @throws SQLException if a database access error occurs or * this XmlWriter object is not the writer * for the given WebRowSet object */ public void writeXML(WebRowSet caller, java.io.Writer writer) throws SQLException; }
