java.sql
인터페이스 Clob

알려진 구현 클래스 목록:

SerialClob

public interface Clob

SQL CLOB 형태의 Java^TM 프로그램 언어에서의 매핑입니다. SQL CLOB는 캐릭터 라지 객체를 데이타베이스 테이블의 행에 렬값으로 포함하는 빌트인형입니다. 디폴트에서는 드라이버는 SQL locator(CLOB)를 사용해 Clob 객체를 구현합니다. 즉, Clob객체는 데이터 그 자체가 아니고 SQL CLOB 데이터에의 논리 포인터를 포함합니다. Clob객체는 그것이 생성된 트랜잭션(transaction)의 기간중에 유효합니다.

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

long length()
            throws SQLException 

이 Clob 객체에 의해 지정된 CLOB값의 문자수를 취득합니다.

반환값:

문자수에서의 CLOB 길이

예외:

SQLException - CLOB값의 길이에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.2

getSubString

String  getSubString(long pos,
                    int length)
                    throws SQLException 

이 Clob 객체에 의해 지정된 CLOB 치내의 지정된 부분 캐릭터 라인의 복사본을 취득합니다. 부분 캐릭터 라인은, pos 위치로부터 length로 지정된 수가 연속하는 문자입니다.

파라미터:

pos - 추출되는 부분 캐릭터 라인의 최초의 문자. 최초의 문자의 위치는 1

length - 카피되는 연속하는 문자수

반환값:

이 Clob 객체에 의해 지정된 CLOB 치내의 지정된 부분 캐릭터 라인인 String

예외:

SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.2

getCharacterStream

Reader  getCharacterStream()
                          throws SQLException 

이 Clob 객체에 의해 지정된 CLOB값을 java.io.Reader 객체 (또는 문자의 스트림)로서 꺼냅니다.

반환값:

CLOB 데이터를 포함하는 java.io.Reader 객체

예외:

SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.2

관련 항목:

setCharacterStream(long)

getAsciiStream

InputStream  getAsciiStream()
                           throws SQLException 

이 Clob 객체에 의해 지정된 CLOB값을 ASCII 스트림로서 꺼냅니다.

반환값:

CLOB 데이터를 포함하는 java.io.InputStream 객체

예외:

SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.2

관련 항목:

setAsciiStream(long)

position

long position(String  searchstr,
              long start)
              throws SQLException 

이 Clob 객체로 나타내지는 SQL CLOB 치내에서 지정된 부분 캐릭터 라인 searchstr가 나타나는 문자 위치를 취득합니다. start 위치로부터 검색이 개시됩니다.

파라미터:

searchstr - 검색 대상의 부분 캐릭터 라인

start - 검색을 개시하는 위치. 최초의 위치는 1

반환값:

부분 캐릭터 라인이 발견된 위치. 발견되지 않았던 경우는 -1. 최초의 위치는 1

예외:

SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.2

position

long position(Clob  searchstr,
              long start)
              throws SQLException 

이 Clob 객체내에서 지정된 Clob 객체 searchstr가 나타나는 문자 위치를 취득합니다. start 위치로부터 검색이 개시됩니다.

파라미터:

searchstr - 검색 대상의 Clob 객체

start - 검색을 개시하는 위치. 최초의 위치는 1

반환값:

Clob 객체가 발견된 위치. 발견되지 않았던 경우는 -1. 최초의 위치는 1

예외:

SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.2

setString

int setString(long pos,
              String  str)
              throws SQLException 

이 Clob 객체가 지정하는 CLOB 치에 지정된 Java String를 pos 위치에 출력합니다.

파라미터:

pos - 이 Clob 객체가 나타내는 CLOB 값의 write를 개시하는 위치

str - 이 Clob 객체가 지정하는 CLOB 치에 출력해지는 캐릭터 라인

반환값:

출력해지는 문자수

예외:

SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.4

setString

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

이 Clob가 나타내는 CLOB 치에 offset 문자로부터 시작되는 str len 문자를 출력합니다.

파라미터:

pos - 이 CLOB 객체에의 write를 개시하는 위치

str - 이 Clob 객체가 나타내는 CLOB 치에 출력해지는 캐릭터 라인

offset - 출력해지는 문자의 read를 개시하는 str 내의 오프셋(offset)

len - 출력해지는 문자수

반환값:

출력해지는 문자수

예외:

SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.4

setAsciiStream

OutputStream  setAsciiStream(long pos)
                            throws SQLException 

이 Clob 객체가 나타내는 CLOB 치에 ASCII 문자를 출력하기 위해서 사용하는 스트림을 취득합니다. 스트림은 pos 위치로부터 개시합니다.

파라미터:

pos - 이 CLOB 객체에의 write를 개시하는 위치

반환값:

ASCII encode 문자가 출력해지는 스트림

예외:

SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.4

관련 항목:

getAsciiStream()

setCharacterStream

Writer  setCharacterStream(long pos)
                          throws SQLException 

이 Clob 객체가 나타내는 CLOB 치에 Unicode 문자를 출력하기 위해서 사용하는 스트림을 취득합니다. 스트림은 pos 위치로부터 개시합니다.

파라미터:

pos - CLOB 값의 write를 개시하는 위치

반환값:

Unicode encode 문자가 출력해지는 스트림

예외:

SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.4

관련 항목:

getCharacterStream()

truncate

void truncate(long len)
              throws SQLException 

이 Clob가 지정하는 CLOB값을 len 문자의 길이에 절약합니다.

파라미터:

len - CLOB 값을 절약할 수 있는 길이 (바이트 단위)

예외:

SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우

도입된 버전 :

1.4