| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface SqlXmlHandler
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.
Jdbc4SqlXmlHandler, 
SQLXML, 
ResultSet.getSQLXML(int), 
PreparedStatement.setSQLXML(int, java.sql.SQLXML)| Method Summary | |
|---|---|
|  InputStream | getXmlAsBinaryStream(ResultSet rs,
                     int columnIndex)Retrieve the given column as binary stream from the given ResultSet. | 
|  InputStream | getXmlAsBinaryStream(ResultSet rs,
                     String columnName)Retrieve the given column as binary stream from the given ResultSet. | 
|  Reader | getXmlAsCharacterStream(ResultSet rs,
                        int columnIndex)Retrieve the given column as character stream from the given ResultSet. | 
|  Reader | getXmlAsCharacterStream(ResultSet rs,
                        String columnName)Retrieve the given column as character stream from the given ResultSet. | 
|  Source | getXmlAsSource(ResultSet rs,
               int columnIndex,
               Class sourceClass)Retrieve the given column as Source implemented using the specified source class from the given ResultSet. | 
|  Source | getXmlAsSource(ResultSet rs,
               String columnName,
               Class sourceClass)Retrieve the given column as Source implemented using the specified source class from the given ResultSet. | 
|  String | getXmlAsString(ResultSet rs,
               int columnIndex)Retrieve the given column as String from the given ResultSet. | 
|  String | getXmlAsString(ResultSet rs,
               String columnName)Retrieve the given column as String from the given ResultSet. | 
|  SqlXmlValue | newSqlXmlValue(Class resultClass,
               XmlResultProvider provider)Create a SqlXmlValueinstance for the given XML data,
 as supported by the underlying JDBC driver. | 
|  SqlXmlValue | newSqlXmlValue(Document doc)Create a SqlXmlValueinstance for the given XML data,
 as supported by the underlying JDBC driver. | 
|  SqlXmlValue | newSqlXmlValue(String value)Create a SqlXmlValueinstance for the given XML data,
 as supported by the underlying JDBC driver. | 
|  SqlXmlValue | newSqlXmlValue(XmlBinaryStreamProvider provider)Create a SqlXmlValueinstance for the given XML data,
 as supported by the underlying JDBC driver. | 
|  SqlXmlValue | newSqlXmlValue(XmlCharacterStreamProvider provider)Create a SqlXmlValueinstance for the given XML data,
 as supported by the underlying JDBC driver. | 
| Method Detail | 
|---|
String getXmlAsString(ResultSet rs,
                      String columnName)
                      throws 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 use
null in case of SQL NULL
SQLException - if thrown by JDBC methodsResultSet.getString(int), 
ResultSet.getSQLXML(int)
String getXmlAsString(ResultSet rs,
                      int columnIndex)
                      throws 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 use
null in case of SQL NULL
SQLException - if thrown by JDBC methodsResultSet.getString(int), 
ResultSet.getSQLXML(int)
InputStream getXmlAsBinaryStream(ResultSet rs,
                                 String columnName)
                                 throws 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 use
null in case of SQL NULL
SQLException - if thrown by JDBC methodsResultSet.getSQLXML(int), 
SQLXML.getBinaryStream()
InputStream getXmlAsBinaryStream(ResultSet rs,
                                 int columnIndex)
                                 throws 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 use
null in case of SQL NULL
SQLException - if thrown by JDBC methodsResultSet.getSQLXML(int), 
SQLXML.getBinaryStream()
Reader getXmlAsCharacterStream(ResultSet rs,
                               String columnName)
                               throws 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 use
SQLException - if thrown by JDBC methodsResultSet.getSQLXML(int), 
SQLXML.getCharacterStream()
Reader getXmlAsCharacterStream(ResultSet rs,
                               int columnIndex)
                               throws 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 use
SQLException - if thrown by JDBC methodsResultSet.getSQLXML(int), 
SQLXML.getCharacterStream()
Source getXmlAsSource(ResultSet rs,
                      String columnName,
                      Class sourceClass)
                      throws 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 used
SQLException - if thrown by JDBC methodsResultSet.getSQLXML(int), 
SQLXML.getSource(java.lang.Class) 
Source getXmlAsSource(ResultSet rs,
                      int columnIndex,
                      Class sourceClass)
                      throws 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 used
SQLException - if thrown by JDBC methodsResultSet.getSQLXML(int), 
SQLXML.getSource(java.lang.Class) SqlXmlValue newSqlXmlValue(String value)
SqlXmlValue instance for the given XML data,
 as supported by the underlying JDBC driver.
value - the XML String value providing XML data
SqlXmlValue, 
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 data
SqlXmlValue, 
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 data
SqlXmlValue, 
SQLXML.setCharacterStream()
SqlXmlValue newSqlXmlValue(Class 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 data
SqlXmlValue, 
SQLXML.setResult(Class)SqlXmlValue newSqlXmlValue(Document doc)
SqlXmlValue instance for the given XML data,
 as supported by the underlying JDBC driver.
doc - the XML Document to be used
SqlXmlValue| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||