| org.springframework.jdbc.support.lob.LobHandler
All known Subclasses: org.springframework.jdbc.support.lob.AbstractLobHandler,
| LobHandler | | public interface LobHandler (Code) | | Abstraction for handling large binary fields and large text fields in
specific databases, no matter if represented as simple types or Large OBjects.
Its main purpose is to isolate Oracle's peculiar handling of LOBs in
OracleLobHandler; most other databases should work with DefaultLobHandler.
Provides accessor methods for BLOBs and CLOBs, and acts as factory for
LobCreator instances, to be used as sessions for creating BLOBs or CLOBs.
LobCreators are typically instantiated for each statement execution or for
each transaction. They are not thread-safe because they might track
allocated database resources to be able to free them after execution.
Most databases/drivers should be able to work with DefaultLobHandler,
which simply delegates to JDBC's direct accessor methods, avoiding
java.sql.Blob and java.sql.Clob completely.
Unfortunately, Oracle 9i just accepts Blob/Clob instances created via its own
proprietary BLOB/CLOB API, and additionally doesn't accept large streams for
PreparedStatement's corresponding setter methods. Therefore, you need to use
OracleLobHandler there, which uses Oracle's BLOB/CLOB API for both all access.
The Oracle 10g JDBC driver should work with DefaultLobHandler too.
Of course, you need to declare different field types for each database.
In Oracle, any binary content needs to go into a BLOB, and all character content
beyond 4000 bytes needs to go into a CLOB. In MySQL, there is no notion of a
CLOB type but rather a LONGTEXT type that behaves like a VARCHAR. For complete
portability, just use a LobHandler for fields that might typically require LOBs
on some database because of their size (take Oracle's numbers as a guideline).
author:
Juergen Hoeller
since:
23.12.2003
See Also: DefaultLobHandler
See Also: OracleLobHandler
See Also: java.sql.ResultSet.getBlob
See Also: java.sql.ResultSet.getClob
See Also: java.sql.ResultSet.getBytes
See Also: java.sql.ResultSet.getBinaryStream
See Also: java.sql.ResultSet.getString
See Also: java.sql.ResultSet.getAsciiStream
See Also: java.sql.ResultSet.getCharacterStream |
| Method Summary | |
| InputStream | getBlobAsBinaryStream(ResultSet rs, String columnName)
Retrieve the given column as binary stream from the given ResultSet. | | InputStream | getBlobAsBinaryStream(ResultSet rs, int columnIndex)
Retrieve the given column as binary stream from the given ResultSet. | | byte[] | getBlobAsBytes(ResultSet rs, String columnName)
Retrieve the given column as bytes from the given ResultSet. | | byte[] | getBlobAsBytes(ResultSet rs, int columnIndex)
Retrieve the given column as bytes from the given ResultSet. | | InputStream | getClobAsAsciiStream(ResultSet rs, String columnName)
Retrieve the given column as ASCII stream from the given ResultSet. | | InputStream | getClobAsAsciiStream(ResultSet rs, int columnIndex)
Retrieve the given column as ASCII stream from the given ResultSet. | | Reader | getClobAsCharacterStream(ResultSet rs, String columnName)
Retrieve the given column as character stream from the given ResultSet. | | Reader | getClobAsCharacterStream(ResultSet rs, int columnIndex)
Retrieve the given column as character stream from the given ResultSet. | | String | getClobAsString(ResultSet rs, String columnName)
Retrieve the given column as String from the given ResultSet. | | String | getClobAsString(ResultSet rs, int columnIndex)
Retrieve the given column as String from the given ResultSet. | | LobCreator | getLobCreator()
Create a new LobCreator instance, i.e. |
| getBlobAsBinaryStream | | InputStream getBlobAsBinaryStream(ResultSet rs, String columnName) throws SQLException(Code) | | Retrieve the given column as binary stream from the given ResultSet.
Might simply invoke ResultSet.getBinaryStream or work with
ResultSet.getBlob, depending on the database and driver.
Parameters:
rs - the ResultSet to retrieve the content from
Parameters:
columnName - the column name to use the content as binary stream, or null in case of SQL NULL
throws:
SQLException - if thrown by JDBC methods
See Also: java.sql.ResultSet.getBinaryStream |
| getBlobAsBinaryStream | | InputStream getBlobAsBinaryStream(ResultSet rs, int columnIndex) throws SQLException(Code) | | Retrieve the given column as binary stream from the given ResultSet.
Might simply invoke ResultSet.getBinaryStream or work with
ResultSet.getBlob, depending on the database and driver.
Parameters:
rs - the ResultSet to retrieve the content from
Parameters:
columnIndex - the column index to use the content as binary stream, or null in case of SQL NULL
throws:
SQLException - if thrown by JDBC methods
See Also: java.sql.ResultSet.getBinaryStream |
| getBlobAsBytes | | byte[] getBlobAsBytes(ResultSet rs, String columnName) throws SQLException(Code) | | Retrieve the given column as bytes from the given ResultSet.
Might simply invoke ResultSet.getBytes or work with
ResultSet.getBlob, depending on the database and driver.
Parameters:
rs - the ResultSet to retrieve the content from
Parameters:
columnName - the column name to use the content as byte array, or null in case of SQL NULL
throws:
SQLException - if thrown by JDBC methods
See Also: java.sql.ResultSet.getBytes |
| getBlobAsBytes | | byte[] getBlobAsBytes(ResultSet rs, int columnIndex) throws SQLException(Code) | | Retrieve the given column as bytes from the given ResultSet.
Might simply invoke ResultSet.getBytes or work with
ResultSet.getBlob, depending on the database and driver.
Parameters:
rs - the ResultSet to retrieve the content from
Parameters:
columnIndex - the column index to use the content as byte array, or null in case of SQL NULL
throws:
SQLException - if thrown by JDBC methods
See Also: java.sql.ResultSet.getBytes |
| getClobAsAsciiStream | | InputStream getClobAsAsciiStream(ResultSet rs, String columnName) throws SQLException(Code) | | Retrieve the given column as ASCII stream from the given ResultSet.
Might simply invoke ResultSet.getAsciiStream or work with
ResultSet.getClob, depending on the database and driver.
Parameters:
rs - the ResultSet to retrieve the content from
Parameters:
columnName - the column name to use the content as ASCII stream, or null in case of SQL NULL
throws:
SQLException - if thrown by JDBC methods
See Also: java.sql.ResultSet.getAsciiStream |
| getClobAsAsciiStream | | InputStream getClobAsAsciiStream(ResultSet rs, int columnIndex) throws SQLException(Code) | | Retrieve the given column as ASCII stream from the given ResultSet.
Might simply invoke ResultSet.getAsciiStream or work with
ResultSet.getClob, depending on the database and driver.
Parameters:
rs - the ResultSet to retrieve the content from
Parameters:
columnIndex - the column index to use the content as ASCII stream, or null in case of SQL NULL
throws:
SQLException - if thrown by JDBC methods
See Also: java.sql.ResultSet.getAsciiStream |
| getClobAsCharacterStream | | Reader getClobAsCharacterStream(ResultSet rs, String columnName) throws SQLException(Code) | | Retrieve the given column as character stream from the given ResultSet.
Might simply invoke ResultSet.getCharacterStream or work with
ResultSet.getClob, depending on the database and driver.
Parameters:
rs - the ResultSet to retrieve the content from
Parameters:
columnName - the column name to use the content as character stream
throws:
SQLException - if thrown by JDBC methods
See Also: java.sql.ResultSet.getCharacterStream |
| getClobAsCharacterStream | | Reader getClobAsCharacterStream(ResultSet rs, int columnIndex) throws SQLException(Code) | | Retrieve the given column as character stream from the given ResultSet.
Might simply invoke ResultSet.getCharacterStream or work with
ResultSet.getClob, depending on the database and driver.
Parameters:
rs - the ResultSet to retrieve the content from
Parameters:
columnIndex - the column index to use the content as character stream
throws:
SQLException - if thrown by JDBC methods
See Also: java.sql.ResultSet.getCharacterStream |
| getClobAsString | | String getClobAsString(ResultSet rs, String columnName) throws SQLException(Code) | | Retrieve the given column as String from the given ResultSet.
Might simply invoke ResultSet.getString or work with
ResultSet.getClob, depending on the database and driver.
Parameters:
rs - the ResultSet to retrieve the content from
Parameters:
columnName - the column name to use the content as String, or null in case of SQL NULL
throws:
SQLException - if thrown by JDBC methods
See Also: java.sql.ResultSet.getString |
| getClobAsString | | String getClobAsString(ResultSet rs, int columnIndex) throws SQLException(Code) | | Retrieve the given column as String from the given ResultSet.
Might simply invoke ResultSet.getString or work with
ResultSet.getClob, depending on the database and driver.
Parameters:
rs - the ResultSet to retrieve the content from
Parameters:
columnIndex - the column index to use the content as String, or null in case of SQL NULL
throws:
SQLException - if thrown by JDBC methods
See Also: java.sql.ResultSet.getString |
| getLobCreator | | LobCreator getLobCreator()(Code) | | Create a new LobCreator instance, i.e. a session for creating BLOBs
and CLOBs. Needs to be closed after the created LOBs are not needed
anymore, i.e. after statement execution or transaction completion.
the new LobCreator instance
See Also: LobCreator.close |
|
|