OpenJDK 27 · com.sun.rowset.providers.RIXMLProvider · APIdia, the JavaDoc alternative

A reference implementation of a JDBC RowSet synchronization provider with the ability to read and write rowsets in well formed XML using the standard WebRowSet schema.

1.0 Background

This synchronization provider is registered with the 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://xmlns.jcp.org/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.

2.0 Usage

A 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.

Field Summary

Modifier and Type	Field and Description
private String	providerID The unique provider identifier.
private JdbcRowSetResourceBundle	resBundle
private String	vendorName The vendor name of this SyncProvider implementation.
private String	versionNumber The version number of this SyncProvider implementation.
private XmlReader	xmlReader
private XmlWriter	xmlWriter

Inherited from javax.sql.rowset.spi.SyncProvider:: DATASOURCE_DB_LOCK DATASOURCE_NO_LOCK DATASOURCE_ROW_LOCK DATASOURCE_TABLE_LOCK GRADE_CHECK_ALL_AT_COMMIT GRADE_CHECK_MODIFIED_AT_COMMIT GRADE_LOCK_WHEN_LOADED GRADE_LOCK_WHEN_MODIFIED GRADE_NONE NONUPDATABLE_VIEW_SYNC UPDATABLE_VIEW_SYNC

Constructor Summary

Access	Constructor and Description
public	RIXMLProvider() This provider is available to all JDBC `RowSet` implementations as the default persistence provider.

Method Summary

Modifier and Type	Method and Description
public int	getDataSourceLock() Implements abstract javax.sql.rowset.spi.SyncProvider.getDataSourceLock. Returns the default DATASOURCE_LOCK behavior of this reader
public int	Returns: the `SyncProvider` synchronization 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 getProviderGrade() Implements abstract javax.sql.rowset.spi.SyncProvider.getProviderGrade. Returns the `SyncProvider` grade of syncrhonization that `RowSet` object instances can expect when using this implementation.
public String	Returns: a `String` object with the fully specified class name of this `RIOptimisticProvider` implementation getProviderID() Implements abstract javax.sql.rowset.spi.SyncProvider.getProviderID. Returns `"javax.sql.rowset.providers.RIXMLProvider"`, which is the fully qualified class name of this provider implementation.
public RowSetReader	getRowSetReader() Implements abstract javax.sql.rowset.spi.SyncProvider.getRowSetReader. Returns a null object as RowSetWriter objects are not returned by this SyncProvider
public RowSetWriter	getRowSetWriter() Implements abstract javax.sql.rowset.spi.SyncProvider.getRowSetWriter. Returns a null object as RowSetWriters are not returned by this SyncProvider
public String	Returns: the `String` detailing the vendor name of this SyncProvider getVendor() Implements abstract javax.sql.rowset.spi.SyncProvider.getVendor. Returns the vendor name of the Reference Implementation Optimistic Synchronization Provider
public String	Returns: the `String` detailing the version number of this SyncProvider getVersion() Implements abstract javax.sql.rowset.spi.SyncProvider.getVersion. Returns the release version ID of the Reference Implementation Optimistic Synchronization Provider.
public XmlReader	Returns: the `XmlReader` object for this SyncProvider getXmlReader() Retrieves the reader that this `WebRowSet` object will call when its `readXml` method is called.
public XmlWriter	Returns: the `XmlWriter` for this SyncProvider getXmlWriter() Retrieves the writer that this `WebRowSet` object will call when its `writeXml` method is called.
public void	setDataSourceLock(int lock) Implements abstract javax.sql.rowset.spi.SyncProvider.setDataSourceLock. Throws an unsupported operation exception as this method does function with non-locking XML data sources.
public void	setXmlReader(XmlReader reader) Sets this `WebRowSet` object's reader to the given `XmlReader` object.
public void	setXmlWriter(XmlWriter writer) Sets this `WebRowSet` object's writer to the given `XmlWriter` object.
public int	supportsUpdatableView() Implements abstract javax.sql.rowset.spi.SyncProvider.supportsUpdatableView. Returns the default UPDATABLE_VIEW behavior of this reader

Field Detail

providerID	back to summary
private String providerID The unique provider identifier.

resBundle	back to summary
private JdbcRowSetResourceBundle resBundle

vendorName	back to summary
private String vendorName The vendor name of this SyncProvider implementation.

versionNumber	back to summary
private String versionNumber The version number of this SyncProvider implementation.

xmlReader	back to summary
private XmlReader xmlReader

xmlWriter	back to summary
private XmlWriter xmlWriter

Constructor Detail

RIXMLProvider	back to summary
public RIXMLProvider() This provider is available to all JDBC `RowSet` implementations as the default persistence provider.

Method Detail

getDataSourceLock	back to summary
public int getDataSourceLock() throws SyncProviderException Implements abstract javax.sql.rowset.spi.SyncProvider.getDataSourceLock. Returns the default DATASOURCE_LOCK behavior of this reader Exceptions SyncProviderException: Doc from javax.sql.rowset.spi.SyncProvider.getDataSourceLock. if an error occurs determining the data source locking level.

getDataSourceLock

back to summary

public int getDataSourceLock() throws SyncProviderException

Implements abstract javax.sql.rowset.spi.SyncProvider.getDataSourceLock.

Returns the default DATASOURCE_LOCK behavior of this reader

Exceptions

SyncProviderException:

Doc from javax.sql.rowset.spi.SyncProvider.getDataSourceLock.

if an error occurs determining the data source locking level.

getProviderGrade back to summary

getProviderGrade	back to summary
public int getProviderGrade() Implements abstract javax.sql.rowset.spi.SyncProvider.getProviderGrade. Returns the `SyncProvider` grade of syncrhonization that `RowSet` object instances can expect when using this implementation. As this implementation provides no synchronization facilities to the XML data source, the lowest grade is returned. Returns:int the `SyncProvider` synchronization 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()

Implements abstract javax.sql.rowset.spi.SyncProvider.getProviderGrade.

Returns the SyncProvider grade of syncrhonization that RowSet object instances can expect when using this implementation. As this implementation provides no synchronization facilities to the XML data source, the lowest grade is returned.

Returns:int

the SyncProvider synchronization 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

getProviderID back to summary

getProviderID	back to summary
public String getProviderID() Implements abstract javax.sql.rowset.spi.SyncProvider.getProviderID. Returns `"javax.sql.rowset.providers.RIXMLProvider"`, which is the fully qualified class name of this provider implementation. Returns:String a `String` object with the fully specified class name of this `RIOptimisticProvider` implementation

public String getProviderID()

Implements abstract javax.sql.rowset.spi.SyncProvider.getProviderID.

Returns "javax.sql.rowset.providers.RIXMLProvider", which is the fully qualified class name of this provider implementation.

Returns:String: a String object with the fully specified class name of this RIOptimisticProvider implementation

getRowSetReader	back to summary
public RowSetReader getRowSetReader() Implements abstract javax.sql.rowset.spi.SyncProvider.getRowSetReader. Returns a null object as RowSetWriter objects are not returned by this SyncProvider

getRowSetReader

back to summary

public RowSetReader getRowSetReader()

Implements abstract javax.sql.rowset.spi.SyncProvider.getRowSetReader.

Returns a null object as RowSetWriter objects are not returned by this SyncProvider

getRowSetWriter	back to summary
public RowSetWriter getRowSetWriter() Implements abstract javax.sql.rowset.spi.SyncProvider.getRowSetWriter. Returns a null object as RowSetWriters are not returned by this SyncProvider

getRowSetWriter

back to summary

public RowSetWriter getRowSetWriter()

Implements abstract javax.sql.rowset.spi.SyncProvider.getRowSetWriter.

Returns a null object as RowSetWriters are not returned by this SyncProvider

getVendor back to summary

getVendor	back to summary
public String getVendor() Implements abstract javax.sql.rowset.spi.SyncProvider.getVendor. Returns the vendor name of the Reference Implementation Optimistic Synchronization Provider Returns:String the `String` detailing the vendor name of this SyncProvider

public String getVendor()

Implements abstract javax.sql.rowset.spi.SyncProvider.getVendor.

Returns the vendor name of the Reference Implementation Optimistic Synchronization Provider

Returns:String: the String detailing the vendor name of this SyncProvider

getVersion back to summary

getVersion	back to summary
public String getVersion() Implements abstract javax.sql.rowset.spi.SyncProvider.getVersion. Returns the release version ID of the Reference Implementation Optimistic Synchronization Provider. Returns:String the `String` detailing the version number of this SyncProvider

public String getVersion()

Implements abstract javax.sql.rowset.spi.SyncProvider.getVersion.

Returns the release version ID of the Reference Implementation Optimistic Synchronization Provider.

Returns:String: the String detailing the version number of this SyncProvider

getXmlReader back to summary

getXmlReader	back to summary
public XmlReader getXmlReader() throws SQLException Retrieves the reader that this `WebRowSet` object will call when its `readXml` method is called. Returns:XmlReader the `XmlReader` object for this SyncProvider Exceptions SQLException: if a database access error occurs

public XmlReader getXmlReader() throws SQLException

Retrieves the reader that this WebRowSet object will call when its readXml method is called.

Returns:XmlReader

the XmlReader object for this SyncProvider

Exceptions

SQLException:: if a database access error occurs

getXmlWriter back to summary

getXmlWriter	back to summary
public XmlWriter getXmlWriter() throws SQLException Retrieves the writer that this `WebRowSet` object will call when its `writeXml` method is called. Returns:XmlWriter the `XmlWriter` for this SyncProvider Exceptions SQLException: if a database access error occurs

public XmlWriter getXmlWriter() throws SQLException

Retrieves the writer that this WebRowSet object will call when its writeXml method is called.

Returns:XmlWriter

the XmlWriter for this SyncProvider

Exceptions

SQLException:: if a database access error occurs

setDataSourceLock	back to summary
public void setDataSourceLock(int lock) throws SyncProviderException Implements abstract javax.sql.rowset.spi.SyncProvider.setDataSourceLock. Throws an unsupported operation exception as this method does function with non-locking XML data sources. Exceptions SyncProviderException: Doc from javax.sql.rowset.spi.SyncProvider.setDataSourceLock. if an unsupported data source locking level is set.

setDataSourceLock

back to summary

public void setDataSourceLock(int lock) throws SyncProviderException

Implements abstract javax.sql.rowset.spi.SyncProvider.setDataSourceLock.

Throws an unsupported operation exception as this method does function with non-locking XML data sources.

Exceptions

SyncProviderException:

Doc from javax.sql.rowset.spi.SyncProvider.setDataSourceLock.

if an unsupported data source locking level is set.

setXmlReader back to summary

setXmlReader	back to summary
public void setXmlReader(XmlReader reader) throws SQLException Sets this `WebRowSet` object's reader to the given `XmlReader` object. Exceptions SQLException: if a database access error occurs

public void setXmlReader(XmlReader reader) throws SQLException

Sets this WebRowSet object's reader to the given XmlReader object.

Exceptions

SQLException:: if a database access error occurs

setXmlWriter back to summary

setXmlWriter	back to summary
public void setXmlWriter(XmlWriter writer) throws SQLException Sets this `WebRowSet` object's writer to the given `XmlWriter` object. Exceptions SQLException: if a database access error occurs

public void setXmlWriter(XmlWriter writer) throws SQLException

Sets this WebRowSet object's writer to the given XmlWriter object.

Exceptions

SQLException:: if a database access error occurs

supportsUpdatableView	back to summary
public int supportsUpdatableView() Implements abstract javax.sql.rowset.spi.SyncProvider.supportsUpdatableView. Returns the default UPDATABLE_VIEW behavior of this reader

supportsUpdatableView

back to summary

public int supportsUpdatableView()

Implements abstract javax.sql.rowset.spi.SyncProvider.supportsUpdatableView.

Returns the default UPDATABLE_VIEW behavior of this reader

public final Class RIXMLProvider

1.0 Background

2.0 Usage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail