java.sql
インタフェース Clob

public interface Clob

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

Clob インタフェースは、SQL の CLOB (キャラクタラージオブジェクト) 値の長さを取得するためのメソッド、クライアントで CLOB 値を生成するためのメソッド、および CLOB 値内で部分文字列または CLOB オブジェクトを検索するためのメソッドを提供します。ResultSet、CallableStatement、および PreparedStatement の各インタフェースのメソッド (getClob および setClob など) を使用すると、プログラマは SQL の CLOB 値にアクセスできます。

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

メソッドの概要

InputStream	getAsciiStream() この Clob オブジェクトによって指定された CLOB 値を ASCII バイトのストリームとして取得します。
Reader	getCharacterStream() この Clob オブジェクトによって指定された CLOB 値を Unicode ストリームとして取得します。
String	getSubString(long pos, int length) この Clob オブジェクトによって指定された CLOB 値内の指定された部分文字列のコピーを返します。
long	length() この Clob オブジェクトによって指定された CLOB 値の文字数を返します。
long	position(Clob searchstr, long start) この Clob オブジェクト内で、指定された Clob オブジェクト searchstr が現れる文字位置を判定します。
long	position(String searchstr, long start) この Clob オブジェクトで表される SQL CLOB 値内で、指定された部分文字列 searchstr が現れる文字位置を判定します。

メソッドの詳細

length

public long length()
            throws SQLException

この Clob オブジェクトによって指定された CLOB 値の文字数を返します。

戻り値:

文字数での CLOB の長さ

例外:

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

導入されたバージョン:

1.2

関連項目:

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

getSubString

public String getSubString(long pos,
                           int length)
                    throws SQLException

この Clob オブジェクトによって指定された CLOB 値内の指定された部分文字列のコピーを返します。部分文字列は、pos の位置から length で指定された数の連続する文字です。

パラメータ:

pos - 抽出される部分文字列の最初の文字。最初の文字の位置は 1

length - コピーされる連続する文字数

戻り値:

この Clob オブジェクトによって指定された CLOB 値内の指定された部分文字列である String

例外:

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

導入されたバージョン:

1.2

関連項目:

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

getCharacterStream

public Reader getCharacterStream()
                          throws SQLException

この Clob オブジェクトによって指定された CLOB 値を Unicode ストリームとして取得します。

戻り値:

CLOB データが格納されている Unicode ストリーム

例外:

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

導入されたバージョン:

1.2

関連項目:

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

getAsciiStream

public InputStream getAsciiStream()
                           throws SQLException

この Clob オブジェクトによって指定された CLOB 値を ASCII バイトのストリームとして取得します。

戻り値:

CLOB データが格納されている ASCII ストリーム

例外:

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

導入されたバージョン:

1.2

関連項目:

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

position

public long position(String searchstr,
                     long start)
              throws SQLException

この Clob オブジェクトで表される SQL CLOB 値内で、指定された部分文字列 searchstr が現れる文字位置を判定します。start の位置から検索が開始されます。

パラメータ:

searchstr - 検索対象の部分文字列

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

戻り値:

部分文字列が見つかった位置。見つからなかった場合は -1。最初の位置は 1

例外:

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

導入されたバージョン:

1.2

関連項目:

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

position

public long position(Clob searchstr,
                     long start)
              throws SQLException

この Clob オブジェクト内で、指定された Clob オブジェクト searchstr が現れる文字位置を判定します。start の位置から検索が開始されます。

パラメータ:

searchstr - 検索対象の Clob オブジェクト

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

戻り値:

Clob オブジェクトが見つかった位置。見つからなかった場合は -1。最初の位置は 1

例外:

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

導入されたバージョン:

1.2

関連項目:

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