java.sql
インタフェース Blob

public interface Blob

SQL BLOB 値の Java^TM プログラミング言語での表現 (マッピング) です。SQL BLOB は、バイナリラージオブジェクトをデータベーステーブルの行に列値として格納する組み込み型です。ドライバは SQL locator(BLOB) を使って Blob を実装します。つまり、Blob オブジェクトはデータそのものではなく、SQL BLOB データへの論理ポインタを格納します。Blob オブジェクトは、それが生成されたトランザクションの期間中に有効です。

ResultSet、CallableStatement、PreparedStatement の各インタフェースのメソッド (getBlob や setBlob など) を使うと、プログラマは SQL BLOB 値にアクセスできます。Blob インタフェースは、SQL BLOB (バイナリラージオブジェクト) 値の長さを取得するためのメソッド、クライアントで BLOB 値を生成するためのメソッド、および BLOB 値でのバイトパターンの位置を判定するためのメソッドを提供します。

このクラスは JDBC 2.0 API で新しく追加されたものです。

導入されたバージョン:

1.2

メソッドの概要

InputStream	getBinaryStream() この Blob インスタンスによって指定された BLOB をストリームとして取り出します。
byte[]	getBytes(long pos, int length) この Blob オブジェクトによって指定された BLOB 値の一部または全部をバイト配列として返します。
long	length() この Blob オブジェクトによって指定された BLOB 値のバイト数を返します。
long	position(Blob pattern, long start) この Blob オブジェクトによって指定された BLOB 値内で pattern が始まるバイト位置を判定します。
long	position(byte[] pattern, long start) この Blob オブジェクトが表す BLOB 値内で指定されたバイト pattern が始まるバイト位置を判別します。

メソッドの詳細

length

public long length()
            throws SQLException

この Blob オブジェクトによって指定された BLOB 値のバイト数を返します。

戻り値:

BLOB の長さ (バイト単位)

例外:

SQLException - BLOB の長さにアクセスするときにエラーが発生した場合

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

getBytes

public byte[] getBytes(long pos,
                       int length)
                throws SQLException

この Blob オブジェクトによって指定された BLOB 値の一部または全部をバイト配列として返します。バイト配列には、pos の位置から length の連続するバイト数が格納されます。

パラメータ:

pos - BLOB 値内の最初に抽出されるバイトの位置 (序数)。最初のバイトの位置は 1

length - コピー対象の連続するバイトの数

戻り値:

この Blob オブジェクトによって指定された BLOB 値内の、pos の位置から length の連続するバイト数が格納されている配列

例外:

SQLException - BLOB にアクセスするときにエラーが発生した場合

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

getBinaryStream

public InputStream getBinaryStream()
                            throws SQLException

この Blob インスタンスによって指定された BLOB をストリームとして取り出します。

戻り値:

BLOB データを格納するストリーム

例外:

SQLException - BLOB にアクセスするときにエラーが発生した場合

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

position

public long position(byte[] pattern,
                     long start)
              throws SQLException

この Blob オブジェクトが表す BLOB 値内で指定されたバイト pattern が始まるバイト位置を判別します。pattern の検索は、start の位置から開始されます。

パラメータ:

pattern - 検索対象のバイト配列

start - 検索を開始する位置。最初の位置は 1

戻り値:

パターンが見つかった位置。見つからなかった場合は -1

例外:

SQLException - BLOB にアクセスするときにエラーが発生した場合

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

position

public long position(Blob pattern,
                     long start)
              throws SQLException

この Blob オブジェクトによって指定された BLOB 値内で pattern が始まるバイト位置を判定します。検索は、start の位置で開始されます。

パラメータ:

pattern - 検索対象の BLOB 値を指定する Blob オブジェクト

start - 検索を開始する BLOB 値内の位置。最初の位置は 1

戻り値:

パターンを開始する位置。それ以外は -1

例外:

SQLException - BLOB にアクセスするときにエラーが発生した場合

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」