SyncFactory by default as the
* com.sun.rowset.providers.RIXMLProvider.
*
* A WebRowSet object uses an RIXMLProvider implementation
* to read an XML data source or to write itself in XML format using the
* WebRowSet XML schema definition available at
*
* http://java.sun.com/xml/ns/jdbc/webrowset.xsd ** The
RIXMLProvider implementation has a synchronization level of
* GRADE_NONE, which means that it does no checking at all for conflicts. It
* simply writes a WebRowSet object to a file.
* WebRowSet implementation is created with an RIXMLProvider
* by default.
* * WebRowSet wrs = new FooWebRowSetImpl(); ** The
SyncFactory always provides an instance of
* RIOptimisticProvider when no provider is specified,
* but the implementation of the default constructor for WebRowSet sets the
* provider to be the RIXMLProvider implementation. Therefore,
* the following line of code is executed behind the scenes as part of the
* implementation of the default constructor.
*
* wrs.setSyncProvider("com.sun.rowset.providers.RIXMLProvider");
*
* See the standard RowSet reference implementations in the
* com.sun.rowset package for more details.
*
* @author Jonathan Bruce
* @see javax.sql.rowset.spi.SyncProvider
* @see javax.sql.rowset.spi.SyncProviderException
* @see javax.sql.rowset.spi.SyncFactory
* @see javax.sql.rowset.spi.SyncFactoryException
*/
public final class RIXMLProvider extends SyncProvider {
/**
* The unique provider identifier.
*/
private String providerID = "com.sun.rowset.providers.RIXMLProvider";
/**
* The vendor name of this SyncProvider implementation.
*/
private String vendorName = "Oracle Corporation";
/**
* The version number of this SyncProvider implementation.
*/
private String versionNumber = "1.0";
private JdbcRowSetResourceBundle resBundle;
private XmlReader xmlReader;
private XmlWriter xmlWriter;
/**
* This provider is available to all JDBC RowSet implementations as the
* default persistence provider.
*/
public RIXMLProvider() {
providerID = this.getClass().getName();
try {
resBundle = JdbcRowSetResourceBundle.getJdbcRowSetResourceBundle();
} catch(IOException ioe) {
throw new RuntimeException(ioe);
}
}
/**
* Returns "javax.sql.rowset.providers.RIXMLProvider", which is
* the fully qualified class name of this provider implementation.
*
* @return a String object with the fully specified class name of
* this RIOptimisticProvider implementation
*/
public String getProviderID() {
return providerID;
}
// additional methods that sit on top of reader/writer methods back to
// original datasource. Allow XML state to be written out and in
/**
* Sets this WebRowSet object's reader to the given
* XmlReader object.
*
* @throws SQLException if a database access error occurs
*/
public void setXmlReader(XmlReader reader) throws SQLException {
xmlReader = reader;
}
/**
* Sets this WebRowSet object's writer to the given
* XmlWriter object.
*
* @throws SQLException if a database access error occurs
*/
public void setXmlWriter(XmlWriter writer) throws SQLException {
xmlWriter = writer;
}
/**
* Retrieves the reader that this WebRowSet object
* will call when its readXml method is called.
*
* @return the XmlReader object for this SyncProvider
* @throws SQLException if a database access error occurs
*/
public XmlReader getXmlReader() throws SQLException {
return xmlReader;
}
/**
* Retrieves the writer that this WebRowSet object
* will call when its writeXml method is called.
*
* @return the XmlWriter for this SyncProvider
* @throws SQLException if a database access error occurs
*/
public XmlWriter getXmlWriter() throws SQLException {
return xmlWriter;
}
/**
* Returns the SyncProvider grade of syncrhonization that
* RowSet object instances can expect when using this
* implementation. As this implementation provides no synchonization
* facilities to the XML data source, the lowest grade is returned.
*
* @return the SyncProvider syncronization grade of this
* provider; must be one of the following constants:
*
* SyncProvider.GRADE_NONE,
* SyncProvider.GRADE_MODIFIED_AT_COMMIT,
* SyncProvider.GRADE_CHECK_ALL_AT_COMMIT,
* SyncProvider.GRADE_LOCK_WHEN_MODIFIED,
* SyncProvider.GRADE_LOCK_WHEN_LOADED
*
*
*/
public int getProviderGrade() {
return SyncProvider.GRADE_NONE;
}
/**
* Returns the default UPDATABLE_VIEW behavior of this reader
*
*/
public int supportsUpdatableView() {
return SyncProvider.NONUPDATABLE_VIEW_SYNC;
}
/**
* Returns the default DATASOURCE_LOCK behavior of this reader
*/
public int getDataSourceLock() throws SyncProviderException {
return SyncProvider.DATASOURCE_NO_LOCK;
}
/**
* Throws an unsupported operation exception as this method does
* function with non-locking XML data sources.
*/
public void setDataSourceLock(int lock) throws SyncProviderException {
throw new UnsupportedOperationException(resBundle.handleGetObject("rixml.unsupp").toString());
}
/**
* Returns a null object as RowSetWriters are not returned by this SyncProvider
*/
public RowSetWriter getRowSetWriter() {
return null;
}
/**
* Returns a null object as RowSetWriter objects are not returned by this
* SyncProvider
*/
public RowSetReader getRowSetReader() {
return null;
}
/**
* Returns the release version ID of the Reference Implementation Optimistic
* Synchronization Provider.
*
* @return the String detailing the version number of this SyncProvider
*/
public String getVersion() {
return this.versionNumber;
}
/**
* Returns the vendor name of the Reference Implemntation Optimistic
* Syncchronication Provider
*
* @return the String detailing the vendor name of this
* SyncProvider
*/
public String getVendor() {
return this.vendorName;
}
}