java.sql
인터페이스 Clob

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

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 - 기입해지는 캐릭터의 read를 개시하는 str 내의 오프셋(offset)

len - 기입해지는 캐릭터수

반환값:

기입해지는 캐릭터수

예외:

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

도입된 버젼:

1.4

setAsciiStream

public OutputStream  setAsciiStream(long pos)
                            throws SQLException 

이 Clob 오브젝트가 나타내는 CLOB 치에 ASCII 캐릭터를 기입하기 위해서(때문에) 사용하는 스트림을 취득합니다. 스트림은 pos 의 위치로부터 개시합니다.

파라미터:

pos - 이 CLOB 오브젝트에의 기입을 개시하는 위치

반환값:

ASCII encode 캐릭터가 기입해지는 스트림

예외:

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

도입된 버젼:

1.4

관련 항목:

getAsciiStream()

setCharacterStream

public Writer  setCharacterStream(long pos)
                          throws SQLException 

이 Clob 오브젝트가 나타내는 CLOB 치에 Unicode 캐릭터를 기입하기 위해서(때문에) 사용하는 스트림을 취득합니다. 스트림은 pos 의 위치로부터 개시합니다.

파라미터:

pos - CLOB 치에의 기입을 개시하는 위치

반환값:

Unicode encode 캐릭터가 기입해지는 스트림

예외:

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

도입된 버젼:

1.4

관련 항목:

getCharacterStream()

truncate

public void truncate(long len)
              throws SQLException 

이 Clob 가 지정하는 CLOB 치를 len 캐릭터의 길이에 절약합니다.

파라미터:

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

예외:

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

도입된 버젼:

1.4