JavaTM Platform
Standard Ed. 6

java.sql
인터페이스 Clob

기존의 서브 인터페이스의 일람:
NClob
기존의 구현 클래스의 일람:
SerialClob


public interface Clob

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

Clob 인터페이스는, SQL 의 CLOB (캐릭터 라지 객체) 치의 길이를 취득하기 위한 메소드, 클라이언트로 CLOB 치를 생성하기 위한 메소드, 및 CLOB 치내에서 부분 캐릭터 라인 또는 CLOB 객체를 검색하기 위한 메소드를 제공합니다. ResultSet ,CallableStatement ,PreparedStatement 의 각 인터페이스의 메소드 (getClobsetClob 등)를 사용하면(자), 프로그래머는 SQL 의 CLOB 치에 액세스 할 수 있습니다. 한층 더 이 인터페이스는 CLOB 치를 갱신하기 위한 메소드를 갖추고 있습니다.  

JDBC 드라이버가 그 데이터형을 지원하는 경우는,Clob 인터페이스의 모든 메소드가 완전하게 구현될 필요가 있습니다.

도입된 버젼:
1.2

메소드의 개요
 void free ()
          이 메소드는,Clob 객체를 해제해, 보관 유지되고 있는 자원을 해제합니다.
 InputStream getAsciiStream ()
          이 Clob 객체에 의해 지정된 CLOB 치를 ASCII 스트림로서 꺼냅니다.
 Reader getCharacterStream ()
          이 Clob 객체에 의해 지정된 CLOB 치를 java.io.Reader 객체 (또는 문자의 스트림)로서 꺼냅니다.
 Reader getCharacterStream (long pos, long length)
          Clob 치의 일부 (문자 위치 pos 로부터 길이 length 문자분 )를 포함한 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 Stringpos 의 위치에 기입합니다.
 int setString (long pos, String  str, int offset, int len)
          이 Clob 가 나타내는 CLOB 치에,offset 문자로부터 시작되는 strlen 문자를 기입합니다.
 void truncate (long len)
          이 Clob 가 지정하는 CLOB 치를 len 문자의 길이에 절약합니다.
 

메소드의 상세

length

long length()
            throws SQLException 
Clob 객체에 의해 지정된 CLOB 치의 문자수를 가져옵니다.

반환값:
문자수에서의 CLOB 의 길이
예외:
SQLException - CLOB 치의 길이에 액세스 할 경우에 에러가 발생했을 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.2

getSubString

String  getSubString(long pos,
                    int length)
                    throws SQLException 
Clob 객체에 의해 지정된 CLOB 치내의 지정된 부분 캐릭터 라인의 카피를 가져옵니다. 부분 캐릭터 라인은,pos 의 위치로부터 length 로 지정된 수가 연속하는 문자입니다.

파라미터:
pos - 추출되는 부분 캐릭터 라인의 최초의 문자. 최초의 문자는 위치 1
length - 카피되는 연속한 문자수. 길이의 값은, 0 이상일 필요가 있다
반환값:
Clob 객체에 의해 지정된 CLOB 치내의 지정된 부분 캐릭터 라인인 String
예외:
SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우. pos 가 1 보다 작은지, 또는 length 가 0 보다 작은 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.2

getCharacterStream

Reader  getCharacterStream()
                          throws SQLException 
Clob 객체에 의해 지정된 CLOB 치를 java.io.Reader 객체 (또는 문자의 스트림)로서 꺼냅니다.

반환값:
CLOB 데이터를 포함하는 java.io.Reader 객체
예외:
SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.2
관련 항목:
setCharacterStream(long)

getAsciiStream

InputStream  getAsciiStream()
                           throws SQLException 
Clob 객체에 의해 지정된 CLOB 치를 ASCII 스트림로서 꺼냅니다.

반환값:
CLOB 데이터를 포함하는 java.io.InputStream 객체
예외:
SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
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 치에 액세스 할 경우에 에러가 발생했을 경우, 또는 pos 가 1 보다 작은 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.2

position

long position(Clob  searchstr,
              long start)
              throws SQLException 
Clob 객체내에서, 지정된 Clob 객체 searchstr 가 나타나는 문자 위치를 가져옵니다. 검색은,start 의 위치로부터 시작됩니다.

파라미터:
searchstr - 검색 대상의 Clob 객체
start - 검색을 개시하는 위치. 최초의 위치는 1
반환값:
Clob 객체가 발견된 위치. 발견되지 않았던 경우는 -1. 최초의 위치는 1
예외:
SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우, 또는 start 가 1 보다 작은 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.2

setString

int setString(long pos,
              String  str)
              throws SQLException 
Clob 객체가 지정하는 CLOB 치에 지정된 Java Stringpos 의 위치에 기입합니다. 이 캐릭터 라인은,pos 의 위치로부터 시작되는 Clob 객체의 기존 문자를 덧쓰기합니다. 지정된 캐릭터 라인에의 기입해 안에 Clob 치의 마지막에 이르면(자), 여분의 문자를 포함하기 위해서 Clob 치의 길이가 증가합니다.  

주:pos 로 지정된 값이 CLOB 치의 length + 1 보다 큰 경우, 동작은 미정도리입니다. JDBC 드라이버에 의해,SQLException 를 throw 하는 것도 있으면, 이 조작을 지원하는 것도 있을 가능성이 있습니다.

파라미터:
pos - 이 Clob 객체가 나타내는 CLOB 치에의 기입을 개시하는 위치. 최초의 위치는 1
str - 이 Clob 객체가 지정하는 CLOB 치에 기입해지는 캐릭터 라인
반환값:
기입해지는 문자수
예외:
SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우, 또는 pos 가 1 보다 작은 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.4

setString

int setString(long pos,
              String  str,
              int offset,
              int len)
              throws SQLException 
Clob 가 나타내는 CLOB 치에,offset 문자로부터 시작되는 strlen 문자를 기입합니다. 이 캐릭터 라인은,pos 의 위치로부터 시작되는 Clob 객체의 기존 문자를 덧쓰기합니다. 지정된 캐릭터 라인에의 기입해 안에 Clob 치의 마지막에 이르면(자), 여분의 문자를 포함하기 위해서 Clob 치의 길이가 증가합니다.  

주:pos 로 지정된 값이 CLOB 치의 length + 1 보다 큰 경우, 동작은 미정도리입니다. JDBC 드라이버에 의해,SQLException 를 throw 하는 것도 있으면, 이 조작을 지원하는 것도 있을 가능성이 있습니다.

파라미터:
pos - 이 CLOB 객체에의 기입을 개시하는 위치. 최초의 위치는 1
str - 이 Clob 객체가 나타낸다 CLOB 치에 기입해지는 캐릭터 라인
offset - 기입해지는 문자의 read를 개시하는 str 내의 오프셋(offset)
len - 기입해지는 문자수
반환값:
기입해지는 문자수
예외:
SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우, 또는 pos 가 1 보다 작은 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.4

setAsciiStream

OutputStream  setAsciiStream(long pos)
                            throws SQLException 
Clob 객체가 나타내는 CLOB 치에 ASCII 문자를 기입하기 위해서(때문에) 사용하는 스트림을 가져옵니다. 스트림은 pos 의 위치로부터 개시합니다. 스트림에 기입해지는 문자는,pos 의 위치로부터 시작되는 Clob 객체의 기존 문자를 덧쓰기합니다. 스트림에의 문자의 기입중에 Clob 치의 마지막에 이르면(자), 여분의 문자를 포함하기 위해서 Clob 치의 길이가 증가합니다.  

주:pos 로 지정된 값이 CLOB 치의 length + 1 보다 큰 경우, 동작은 미정도리입니다. JDBC 드라이버에 의해,SQLException 를 throw 하는 것도 있으면, 이 조작을 지원하는 것도 있을 가능성이 있습니다.

파라미터:
pos - 이 CLOB 객체에의 기입을 개시하는 위치. 최초의 위치는 1
반환값:
ASCII encode 문자가 기입해지는 스트림
예외:
SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우, 또는 pos 가 1 보다 작은 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.4
관련 항목:
getAsciiStream()

setCharacterStream

Writer  setCharacterStream(long pos)
                          throws SQLException 
Clob 객체가 나타내는 CLOB 치에 Unicode 문자를 기입하기 위해서(때문에) 사용하는 스트림을 가져옵니다. 스트림은 pos 의 위치로부터 개시합니다. 스트림에 기입해지는 문자는,pos 의 위치로부터 시작되는 Clob 객체의 기존 문자를 덧쓰기합니다. 스트림에의 문자의 기입중에 Clob 치의 마지막에 이르면(자), 여분의 문자를 포함하기 위해서 Clob 치의 길이가 증가합니다.  

주:pos 로 지정된 값이 CLOB 치의 length + 1 보다 큰 경우, 동작은 미정도리입니다. JDBC 드라이버에 의해,SQLException 를 throw 하는 것도 있으면, 이 조작을 지원하는 것도 있을 가능성이 있습니다.

파라미터:
pos - 이 CLOB 객체에의 기입을 개시하는 위치. 최초의 위치는 1
반환값:
Unicode encode 문자가 기입해지는 스트림
예외:
SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우, 또는 pos 가 1 보다 작은 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.4
관련 항목:
getCharacterStream()

truncate

void truncate(long len)
              throws SQLException 
Clob 가 지정하는 CLOB 치를 len 문자의 길이에 절약합니다.  

주:pos 로 지정된 값이 CLOB 치의 length + 1 보다 큰 경우, 동작은 미정도리입니다. JDBC 드라이버에 의해,SQLException 를 throw 하는 것도 있으면, 이 조작을 지원하는 것도 있을 가능성이 있습니다.

파라미터:
len - CLOB 값을 절약할 수 있는 길이 (문자 단위)
예외:
SQLException - CLOB 치에 액세스 할 경우에 에러가 발생했을 경우, 또는 len 가 0 보다 작은 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.4

free

void free()
          throws SQLException 
이 메소드는,Clob 객체를 해제해, 보관 유지되고 있는 자원을 해제합니다. free 메소드가 한 번 불려 간 뒤는, 객체는 무효가 됩니다.  

free 가 불려 가면(자),free 이외의 메소드를 호출하려고 해도,SQLException 가 throw 됩니다. free 를 여러 차례 호출했을 경우, 2 번째 이후의 free 호출은 아무것도 실시하지 않는 것으로서 다루어집니다.  

예외:
SQLException - Clob 의 자원을 해제할 경우에 에러가 발생했을 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.6

getCharacterStream

Reader  getCharacterStream(long pos,
                          long length)
                          throws SQLException 
Clob 치의 일부 (문자 위치 pos 로부터 길이 length 문자분 )를 포함한 Reader 객체를 돌려줍니다.

파라미터:
pos - 취득하는 부분치의 최초의 문자까지의 오프셋(offset). Clob 내에서 최초의 문자의 위치는 1
length - 취득하는 부분치의 길이 (문자수)
반환값:
Clob 치의 일부를 읽어낼 수 있는 Reader
예외:
SQLException - pos 가 1 보다 작은 경우, pos 가 Clob 내의 문자수보다 큰 경우, 또는 pos + length 가 Clob 내의 문자수보다 큰 경우
SQLFeatureNotSupportedException - JDBC 드라이버가 이 메소드를 지원하지 않는 경우
도입된 버젼:
1.6

JavaTM Platform
Standard Ed. 6

버그의 보고와 기능의 요청
한층 더 자세한 API 레퍼런스 및 개발자 문서에 대해서는,Java SE 개발자용 문서를 참조해 주세요. 개발자전용의 상세한 해설, 개념의 개요, 용어의 정의, 버그의 회피책, 및 코드 실례가 포함되어 있습니다.

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms . Documentation Redistribution Policy 도 참조해 주세요.