public interface SqlXmlHandler
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.
Jdbc4SqlXmlHandler
,
SQLXML
,
ResultSet.getSQLXML(int)
,
PreparedStatement.setSQLXML(int, java.sql.SQLXML)
Modifier and Type | Method and Description |
---|---|
java.io.InputStream |
getXmlAsBinaryStream(java.sql.ResultSet rs,
int columnIndex)
Retrieve the given column as binary stream from the given ResultSet.
|
java.io.InputStream |
getXmlAsBinaryStream(java.sql.ResultSet rs,
java.lang.String columnName)
Retrieve the given column as binary stream from the given ResultSet.
|
java.io.Reader |
getXmlAsCharacterStream(java.sql.ResultSet rs,
int columnIndex)
Retrieve the given column as character stream from the given ResultSet.
|
java.io.Reader |
getXmlAsCharacterStream(java.sql.ResultSet rs,
java.lang.String columnName)
Retrieve the given column as character stream from the given ResultSet.
|
javax.xml.transform.Source |
getXmlAsSource(java.sql.ResultSet rs,
int columnIndex,
java.lang.Class<? extends javax.xml.transform.Source> sourceClass)
Retrieve the given column as Source implemented using the specified source class
from the given ResultSet.
|
javax.xml.transform.Source |
getXmlAsSource(java.sql.ResultSet rs,
java.lang.String columnName,
java.lang.Class<? extends javax.xml.transform.Source> sourceClass)
Retrieve the given column as Source implemented using the specified source class
from the given ResultSet.
|
java.lang.String |
getXmlAsString(java.sql.ResultSet rs,
int columnIndex)
Retrieve the given column as String from the given ResultSet.
|
java.lang.String |
getXmlAsString(java.sql.ResultSet rs,
java.lang.String columnName)
Retrieve the given column as String from the given ResultSet.
|
SqlXmlValue |
newSqlXmlValue(java.lang.Class<? extends javax.xml.transform.Result> resultClass,
XmlResultProvider provider)
Create a
SqlXmlValue instance for the given XML data,
as supported by the underlying JDBC driver. |
SqlXmlValue |
newSqlXmlValue(org.w3c.dom.Document doc)
Create a
SqlXmlValue instance for the given XML data,
as supported by the underlying JDBC driver. |
SqlXmlValue |
newSqlXmlValue(java.lang.String value)
Create a
SqlXmlValue instance for the given XML data,
as supported by the underlying JDBC driver. |
SqlXmlValue |
newSqlXmlValue(XmlBinaryStreamProvider provider)
Create a
SqlXmlValue instance for the given XML data,
as supported by the underlying JDBC driver. |
SqlXmlValue |
newSqlXmlValue(XmlCharacterStreamProvider provider)
Create a
SqlXmlValue instance for the given XML data,
as supported by the underlying JDBC driver. |
java.lang.String getXmlAsString(java.sql.ResultSet rs, java.lang.String columnName) throws java.sql.SQLException
Might simply invoke ResultSet.getString
or work with
SQLXML
or database-specific classes depending on the
database and driver.
rs
- the ResultSet to retrieve the content fromcolumnName
- the column name to usenull
in case of SQL NULLjava.sql.SQLException
- if thrown by JDBC methodsResultSet.getString(int)
,
ResultSet.getSQLXML(int)
java.lang.String getXmlAsString(java.sql.ResultSet rs, int columnIndex) throws java.sql.SQLException
Might simply invoke ResultSet.getString
or work with
SQLXML
or database-specific classes depending on the
database and driver.
rs
- the ResultSet to retrieve the content fromcolumnIndex
- the column index to usenull
in case of SQL NULLjava.sql.SQLException
- if thrown by JDBC methodsResultSet.getString(int)
,
ResultSet.getSQLXML(int)
java.io.InputStream getXmlAsBinaryStream(java.sql.ResultSet rs, java.lang.String columnName) throws java.sql.SQLException
Might simply invoke ResultSet.getAsciiStream
or work with
SQLXML
or database-specific classes depending on the
database and driver.
rs
- the ResultSet to retrieve the content fromcolumnName
- the column name to usenull
in case of SQL NULLjava.sql.SQLException
- if thrown by JDBC methodsResultSet.getSQLXML(int)
,
SQLXML.getBinaryStream()
java.io.InputStream getXmlAsBinaryStream(java.sql.ResultSet rs, int columnIndex) throws java.sql.SQLException
Might simply invoke ResultSet.getAsciiStream
or work with
SQLXML
or database-specific classes depending on the
database and driver.
rs
- the ResultSet to retrieve the content fromcolumnIndex
- the column index to usenull
in case of SQL NULLjava.sql.SQLException
- if thrown by JDBC methodsResultSet.getSQLXML(int)
,
SQLXML.getBinaryStream()
java.io.Reader getXmlAsCharacterStream(java.sql.ResultSet rs, java.lang.String columnName) throws java.sql.SQLException
Might simply invoke ResultSet.getCharacterStream
or work with
SQLXML
or database-specific classes depending on the
database and driver.
rs
- the ResultSet to retrieve the content fromcolumnName
- the column name to usenull
in case of SQL NULLjava.sql.SQLException
- if thrown by JDBC methodsResultSet.getSQLXML(int)
,
SQLXML.getCharacterStream()
java.io.Reader getXmlAsCharacterStream(java.sql.ResultSet rs, int columnIndex) throws java.sql.SQLException
Might simply invoke ResultSet.getCharacterStream
or work with
SQLXML
or database-specific classes depending on the
database and driver.
rs
- the ResultSet to retrieve the content fromcolumnIndex
- the column index to usenull
in case of SQL NULLjava.sql.SQLException
- if thrown by JDBC methodsResultSet.getSQLXML(int)
,
SQLXML.getCharacterStream()
javax.xml.transform.Source getXmlAsSource(java.sql.ResultSet rs, java.lang.String columnName, java.lang.Class<? extends javax.xml.transform.Source> sourceClass) throws java.sql.SQLException
Might work with SQLXML
or database-specific classes depending
on the database and driver.
rs
- the ResultSet to retrieve the content fromcolumnName
- the column name to usesourceClass
- the implementation class to be usednull
in case of SQL NULLjava.sql.SQLException
- if thrown by JDBC methodsResultSet.getSQLXML(int)
,
SQLXML.getSource(java.lang.Class<T>)
javax.xml.transform.Source getXmlAsSource(java.sql.ResultSet rs, int columnIndex, java.lang.Class<? extends javax.xml.transform.Source> sourceClass) throws java.sql.SQLException
Might work with SQLXML
or database-specific classes depending
on the database and driver.
rs
- the ResultSet to retrieve the content fromcolumnIndex
- the column index to usesourceClass
- the implementation class to be usednull
in case of SQL NULLjava.sql.SQLException
- if thrown by JDBC methodsResultSet.getSQLXML(int)
,
SQLXML.getSource(java.lang.Class<T>)
SqlXmlValue newSqlXmlValue(java.lang.String value)
SqlXmlValue
instance for the given XML data,
as supported by the underlying JDBC driver.value
- the XML String value providing XML dataSqlXmlValue
,
SQLXML.setString(String)
SqlXmlValue newSqlXmlValue(XmlBinaryStreamProvider provider)
SqlXmlValue
instance for the given XML data,
as supported by the underlying JDBC driver.provider
- the XmlBinaryStreamProvider
providing XML dataSqlXmlValue
,
SQLXML.setBinaryStream()
SqlXmlValue newSqlXmlValue(XmlCharacterStreamProvider provider)
SqlXmlValue
instance for the given XML data,
as supported by the underlying JDBC driver.provider
- the XmlCharacterStreamProvider
providing XML dataSqlXmlValue
,
SQLXML.setCharacterStream()
SqlXmlValue newSqlXmlValue(java.lang.Class<? extends javax.xml.transform.Result> resultClass, XmlResultProvider provider)
SqlXmlValue
instance for the given XML data,
as supported by the underlying JDBC driver.resultClass
- the Result implementation class to be usedprovider
- the XmlResultProvider
that will provide the XML dataSqlXmlValue
,
SQLXML.setResult(Class)
SqlXmlValue newSqlXmlValue(org.w3c.dom.Document doc)
SqlXmlValue
instance for the given XML data,
as supported by the underlying JDBC driver.doc
- the XML Document to be usedSqlXmlValue