interbase.interclient
Class Clob

java.lang.Object
  |
  +--interbase.interclient.Clob

public final class Clob

extends Object

implements Clob

Represents an SQL 3 Character Large Object (CLOb). By default, a Clob is a transaction duration reference to a character large object.

Since:

JDBC 2, not yet supported

Method Summary

InputStream	getAsciiStream() Get the Clob contents as an ascii stream.
Reader	getCharacterStream() Get the Clob contents as a Unicode stream.
String	getSubString(long pos, int length) Return copy of the substring of the Clob at the requested position.
long	length() The length of the Character Large Object in characters.
long	position(Clob searchstr, long start) Determine the character position at which the given substring searchstr appears in the CLOB.
long	position(String searchstr, long start) Determine the character position at which the given substring searchstr appears in the CLOB.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

length

public long length()
            throws SQLException

The length of the Character Large Object in characters.

Specified by:

length in interface Clob

Returns:

length of the Clob in characters

Throws:

SQLException - if a database access error occurs.

Since:

JDBC 2, not yet supported

getSubString

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

Return copy of the substring of the Clob at the requested position.

Specified by:

getSubString in interface Clob

Parameters:

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

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

Returns:

a byte array containing a substring of the CLOB

Throws:

SQLException - if a database access error occurs.

Since:

JDBC 2, not yet supported

getCharacterStream

public Reader getCharacterStream()
                          throws SQLException

Get the Clob contents as a Unicode stream.

Specified by:

getCharacterStream in interface Clob

Returns:

a Unicode stream containing the CLOB data

Throws:

SQLException - if a database access error occurs.

Since:

JDBC 2, not yet supported

getAsciiStream

public InputStream getAsciiStream()
                           throws SQLException

Get the Clob contents as an ascii stream.

Specified by:

getAsciiStream in interface Clob

Returns:

an ascii stream containing the Clob data

Throws:

SQLException - if a database access error occurs.

Since:

JDBC 2, not yet supported

position

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

Determine the character position at which the given substring searchstr appears in the CLOB. Begin search at position start. Return -1 if the substring does not appear in the CLOB.

Specified by:

position in interface Clob

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.

Throws:

SQLException - if a database access error occurs.

Since:

JDBC 2, not yet supported

position

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

Determine the character position at which the given substring searchstr appears in the CLOB. Begin search at position start. Return -1 if the substring does not appear in the CLOB.

Specified by:

position in interface Clob

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.

Throws:

SQLException - if a database access error occurs.

Since:

JDBC 2, not yet supported