Summary: Methods | [Expand All]
public interface

SqlXmlHandler

org.springframework.jdbc.support.xml.SqlXmlHandler
Known Indirect Subclasses

Class Overview

Abstraction for handling XML fields in specific databases. Its main purpose is to isolate database-specific handling of XML stored in the database.

JDBC 4.0 introduces the new data type java.sql.SQLXML but most databases and their drivers currently rely on database-specific data types and features.

Provides accessor methods for XML fields and acts as factory for SqlXmlValue instances.

See Also

Summary

Public Methods
abstract InputStream getXmlAsBinaryStream(ResultSet rs, int columnIndex)
Retrieve the given column as binary stream from the given ResultSet.
abstract InputStream getXmlAsBinaryStream(ResultSet rs, String columnName)
Retrieve the given column as binary stream from the given ResultSet.
abstract Reader getXmlAsCharacterStream(ResultSet rs, String columnName)
Retrieve the given column as character stream from the given ResultSet.
abstract Reader getXmlAsCharacterStream(ResultSet rs, int columnIndex)
Retrieve the given column as character stream from the given ResultSet.
abstract Source getXmlAsSource(ResultSet rs, int columnIndex, Class sourceClass)
Retrieve the given column as Source implemented using the specified source class from the given ResultSet.
abstract Source getXmlAsSource(ResultSet rs, String columnName, Class sourceClass)
Retrieve the given column as Source implemented using the specified source class from the given ResultSet.
abstract String getXmlAsString(ResultSet rs, int columnIndex)
Retrieve the given column as String from the given ResultSet.
abstract String getXmlAsString(ResultSet rs, String columnName)
Retrieve the given column as String from the given ResultSet.
abstract SqlXmlValue newSqlXmlValue(XmlBinaryStreamProvider provider)
Create a SqlXmlValue instance for the given XML data, as supported by the underlying JDBC driver.
abstract SqlXmlValue newSqlXmlValue(Class resultClass, XmlResultProvider provider)
Create a SqlXmlValue instance for the given XML data, as supported by the underlying JDBC driver.
abstract SqlXmlValue newSqlXmlValue(XmlCharacterStreamProvider provider)
Create a SqlXmlValue instance for the given XML data, as supported by the underlying JDBC driver.
abstract SqlXmlValue newSqlXmlValue(Document doc)
Create a SqlXmlValue instance for the given XML data, as supported by the underlying JDBC driver.
abstract SqlXmlValue newSqlXmlValue(String value)
Create a SqlXmlValue instance for the given XML data, as supported by the underlying JDBC driver.

Public Methods

public abstract InputStream getXmlAsBinaryStream (ResultSet rs, int columnIndex)

Retrieve the given column as binary stream from the given ResultSet.

Might simply invoke ResultSet.getAsciiStream or work with SQLXML or database-specific classes depending on the database and driver.

Parameters
rs the ResultSet to retrieve the content from
columnIndex the column index to use
Returns
  • the content as binary stream, or null in case of SQL NULL
Throws
SQLException if thrown by JDBC methods
See Also

public abstract InputStream getXmlAsBinaryStream (ResultSet rs, String columnName)

Retrieve the given column as binary stream from the given ResultSet.

Might simply invoke ResultSet.getAsciiStream or work with SQLXML or database-specific classes depending on the database and driver.

Parameters
rs the ResultSet to retrieve the content from
columnName the column name to use
Returns
  • the content as a binary stream, or null in case of SQL NULL
Throws
SQLException if thrown by JDBC methods
See Also

public abstract Reader getXmlAsCharacterStream (ResultSet rs, String columnName)

Retrieve the given column as character stream from the given ResultSet.

Might simply invoke ResultSet.getCharacterStream or work with SQLXML or database-specific classes depending on the database and driver.

Parameters
rs the ResultSet to retrieve the content from
columnName the column name to use
Returns
  • the content as character stream
Throws
SQLException if thrown by JDBC methods
See Also

public abstract Reader getXmlAsCharacterStream (ResultSet rs, int columnIndex)

Retrieve the given column as character stream from the given ResultSet.

Might simply invoke ResultSet.getCharacterStream or work with SQLXML or database-specific classes depending on the database and driver.

Parameters
rs the ResultSet to retrieve the content from
columnIndex the column index to use
Returns
  • the content as character stream
Throws
SQLException if thrown by JDBC methods
See Also

public abstract Source getXmlAsSource (ResultSet rs, int columnIndex, Class sourceClass)

Retrieve the given column as Source implemented using the specified source class from the given ResultSet.

Might work with SQLXML or database-specific classes depending on the database and driver.

Parameters
rs the ResultSet to retrieve the content from
columnIndex the column index to use
sourceClass the implementation class to be used
Returns
  • the content as character stream
Throws
SQLException if thrown by JDBC methods
See Also

public abstract Source getXmlAsSource (ResultSet rs, String columnName, Class sourceClass)

Retrieve the given column as Source implemented using the specified source class from the given ResultSet.

Might work with SQLXML or database-specific classes depending on the database and driver.

Parameters
rs the ResultSet to retrieve the content from
columnName the column name to use
sourceClass the implementation class to be used
Returns
  • the content as character stream
Throws
SQLException if thrown by JDBC methods
See Also

public abstract String getXmlAsString (ResultSet rs, int columnIndex)

Retrieve the given column as String from the given ResultSet.

Might simply invoke ResultSet.getString or work with SQLXML or database-specific classes depending on the database and driver.

Parameters
rs the ResultSet to retrieve the content from
columnIndex the column index to use
Returns
  • the content as String, or null in case of SQL NULL
Throws
SQLException if thrown by JDBC methods
See Also

public abstract String getXmlAsString (ResultSet rs, String columnName)

Retrieve the given column as String from the given ResultSet.

Might simply invoke ResultSet.getString or work with SQLXML or database-specific classes depending on the database and driver.

Parameters
rs the ResultSet to retrieve the content from
columnName the column name to use
Returns
  • the content as String, or null in case of SQL NULL
Throws
SQLException if thrown by JDBC methods
See Also

public abstract SqlXmlValue newSqlXmlValue (XmlBinaryStreamProvider provider)

Create a SqlXmlValue instance for the given XML data, as supported by the underlying JDBC driver.

Parameters
provider the XmlBinaryStreamProvider providing XML data
Returns
  • the implementation specific instance
See Also

public abstract SqlXmlValue newSqlXmlValue (Class resultClass, XmlResultProvider provider)

Create a SqlXmlValue instance for the given XML data, as supported by the underlying JDBC driver.

Parameters
resultClass the Result implementation class to be used
provider the XmlResultProvider that will provide the XML data
Returns
  • the implementation specific instance
See Also

public abstract SqlXmlValue newSqlXmlValue (XmlCharacterStreamProvider provider)

Create a SqlXmlValue instance for the given XML data, as supported by the underlying JDBC driver.

Parameters
provider the XmlCharacterStreamProvider providing XML data
Returns
  • the implementation specific instance
See Also

public abstract SqlXmlValue newSqlXmlValue (Document doc)

Create a SqlXmlValue instance for the given XML data, as supported by the underlying JDBC driver.

Parameters
doc the XML Document to be used
Returns
  • the implementation specific instance
See Also

public abstract SqlXmlValue newSqlXmlValue (String value)

Create a SqlXmlValue instance for the given XML data, as supported by the underlying JDBC driver.

Parameters
value the XML String value providing XML data
Returns
  • the implementation specific instance
See Also