oracle.sql.CLOB

---

Class oracle.sql.CLOB

oracle.sql.CLOB

---

public class CLOB

implements Clob

---

getAsciiOutputStream()

Oracle extension.

getAsciiStream()

Implements the Clob interface method.

getBufferSize()

Oracle extension.

getCharacterOutputStream()

Oracle extension.

getCharacterStream()

Implements the Clob interface method.

getChars(long, int, char[])

Oracle extension.

getChunkSize()

Oracle extension.

getConnection()

Oracle extension.

getSubString(long, int)

Implements the Clob interface method.

isConvertibleTo(Class)

Test whether this data object can be converted to the specified Java data type.

length()

Implements the Clob interface method.

position(Clob, long)

Implements the Clob interface method.

position(String, long)

Implements the Clob interface method.

putChars(long, char[])

Oracle extension.

putString(long, String)

Oracle extension.

toJdbc()

Convert this data object into its default Java object type.

length

 public long length() throws SQLException

Implements the Clob interface method. Returns the number of characters in the CLOB value designated by this Clob object.

Returns:

length of the CLOB in characters

Throws: SQLException

if there is an error accessing the length of the CLOB

getSubString

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

Implements the Clob interface method. Returns a copy of the specified substring in the CLOB value designated by this Clob object. The substring begins at position pos and has up to length consecutive characters.

Parameters:

pos - the first character of the substring to be extracted. The first character is at position 1.

length - the number of consecutive characters to be copied

Returns:

a String that is the specified substring in the CLOB value designated by this Clob ob ject

Throws: SQLException

if there is an error accessing the CLOB

getCharacterStream

 public Reader getCharacterStream() throws SQLException

Implements the Clob interface method. Gets the Clob contents as a Unicode stream.

Returns:

a Unicode stream containing the CLOB data

Throws: SQLException

if there is an error accessing the CLOB

getAsciiStream

 public InputStream getAsciiStream() throws SQLException

Implements the Clob interface method. Gets the CLOB value designated by this Clob object as a stream of Ascii bytes.

Returns:

an ascii stream containing the CLOB data

Throws: SQLException

if there is an error accessing the CLOB value

position

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

Implements the Clob interface method. Determine the character position at which the given substring

Parameters:

searchstr - is the substring to search for.

start - is the position at which to begin searching.

Returns:

the position at which the substring appears, else -1.

position

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

Implements the Clob interface method. Determine the character position at which the given substring

Parameters:

searchstr - is the substring to search for.

start - is the position at which to begin searching.

Returns:

the position at which the substring appears, else -1.

getChars

 public int getChars(long pos,
                     int length,
                     char buffer[]) throws SQLException

Oracle extension. Return copy of the substring of the CLOB at the requested position.

Parameters:

buffer - is the buffer into whcih the characters are read.

pos - is the first character of the substring to be extracted.

length - is the number of consecutive character to be copied.

Returns:

the actual number of characters read.

getCharacterOutputStream

 public Writer getCharacterOutputStream() throws SQLException

Oracle extension. Write Unicode stream to the CLOB.

Returns:

a Unicode character output stream.

getAsciiOutputStream

 public OutputStream getAsciiOutputStream() throws SQLException

Oracle extension. Write ascii stream to the CLOB.

Returns:

a ascii output stream.

getConnection

 public OracleConnection getConnection() throws SQLException

Oracle extension. Get connection object.

putChars

 public int putChars(long pos,
                     char chars[]) throws SQLException

Oracle extension. Write characters at the requested position.

Parameters:

pos - is the position to write characters.

chars - is the buffer of characters to be written.

Returns:

the actual number of characters written.

putString

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

Oracle extension. Write Java string at the requested position.

Parameters:

pos - is the position to write characters.

str - is the Java string to be written.

Returns:

the actual number of characters written.

getChunkSize

 public int getChunkSize() throws SQLException

Oracle extension. Get database LOB storage chunk size.

Returns:

the size in terms of characters.

getBufferSize

 public int getBufferSize() throws SQLException

Oracle extension. Get ideal LOB db access buffer size.

Returns:

the size in terms of characters.

toJdbc

 public Object toJdbc() throws SQLException

Convert this data object into its default Java object type.

Returns:

this object.

Throws: SQLException

if any of the lower layer code throws an exception.

isConvertibleTo

 public boolean isConvertibleTo(Class jClass)

Test whether this data object can be converted to the specified Java data type.

Parameters:

jClass specifies - the Java data type to test against.

Returns:

true if this data object is convertible to the specified Java class, and a corresponding xxxValue() method is available; otherwise, a false is returned.

---