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 値にアクセスできます。さらにこのインタフェースは CLOB 値を更新するためのメソッドを備えています。

導入されたバージョン:

1.2

メソッドの概要

InputStream	getAsciiStream() この Clob オブジェクトによって指定された CLOB 値を ASCII ストリームとして取り出します。
Reader	getCharacterStream() この Clob オブジェクトによって指定された CLOB 値を java.io.Reader オブジェクト (または文字のストリーム) として取り出します。
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 が現れる文字位置を取得します。
OutputStream	setAsciiStream(long pos) この Clob オブジェクトが表す CLOB 値へ ASCII 文字を書き込むために使用するストリームを取得します。
Writer	setCharacterStream(long pos) この Clob オブジェクトが表す CLOB 値へ Unicode 文字を書き込むために使用するストリームを取得します。
int	setString(long pos, String str) この Clob オブジェクトが指定する CLOB 値へ指定された Java String を pos の位置に書き込みます。
int	setString(long pos, String str, int offset, int len) この Clob が表す CLOB 値へ、offset 文字から始まる str の len 文字を書き込みます。
void	truncate(long len) この Clob が指定する CLOB 値を len 文字の長さに切り詰めます。

メソッドの詳細

length

public long length()
            throws SQLException

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

戻り値:

文字数での CLOB の長さ

例外:

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

導入されたバージョン:

1.2

getSubString

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

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

パラメータ:

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

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

getCharacterStream

public Reader getCharacterStream()
                          throws SQLException

この Clob オブジェクトによって指定された CLOB 値を java.io.Reader オブジェクト (または文字のストリーム) として取り出します。

戻り値:

CLOB データを格納する java.io.Reader オブジェクト

例外:

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

導入されたバージョン:

1.2

関連項目:

setCharacterStream(long)

getAsciiStream

public InputStream getAsciiStream()
                           throws SQLException

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

戻り値:

CLOB データを格納する java.io.InputStream オブジェクト

例外:

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

導入されたバージョン:

1.2

関連項目:

setAsciiStream(long)

position

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

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

パラメータ:

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

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

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

setString

public int setString(long pos,
                     String str)
              throws SQLException

この Clob オブジェクトが指定する CLOB 値へ指定された Java String を pos の位置に書き込みます。

パラメータ:

pos - この Clob オブジェクトが表す CLOB 値への書き込みを開始する位置

str - この Clob オブジェクトが指定する CLOB 値へ書き込まれる文字列

戻り値:

書き込まれる文字数

例外:

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

導入されたバージョン:

1.4

setString

public int setString(long pos,
                     String str,
                     int offset,
                     int len)
              throws SQLException

この Clob が表す CLOB 値へ、offset 文字から始まる str の len 文字を書き込みます。

パラメータ:

pos - この CLOB オブジェクトへの書き込みを開始する位置

str - この Clob オブジェクトが表す CLOB 値へ書き込まれる文字列

offset - 書き込まれる文字の読み込みを開始する str 内のオフセット

len - 書き込まれる文字数

戻り値:

書き込まれる文字数

例外:

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

導入されたバージョン:

1.4

setAsciiStream

public OutputStream setAsciiStream(long pos)
                            throws SQLException

この Clob オブジェクトが表す CLOB 値へ ASCII 文字を書き込むために使用するストリームを取得します。ストリームは pos の位置から開始します。

パラメータ:

pos - この CLOB オブジェクトへの書き込みを開始する位置

戻り値:

ASCII 符号化文字が書き込まれるストリーム

例外:

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

導入されたバージョン:

1.4

関連項目:

getAsciiStream()

setCharacterStream

public Writer setCharacterStream(long pos)
                          throws SQLException

この Clob オブジェクトが表す CLOB 値へ Unicode 文字を書き込むために使用するストリームを取得します。ストリームは pos の位置から開始します。

パラメータ:

pos - CLOB 値への書き込みを開始する位置

戻り値:

Unicode 符号化文字が書き込まれるストリーム

例外:

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

導入されたバージョン:

1.4

関連項目:

getCharacterStream()

truncate

public void truncate(long len)
              throws SQLException

この Clob が指定する CLOB 値を len 文字の長さに切り詰めます。

パラメータ:

len - CLOB 値が切り詰められる長さ (バイト単位)

例外:

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

導入されたバージョン:

1.4