org.firebirdsql.jdbc
Class FBClob

java.lang.Object
  extended byorg.firebirdsql.jdbc.FBClob
All Implemented Interfaces:
java.sql.Clob

public class FBClob
extends java.lang.Object
implements java.sql.Clob

Describe class FBClob here.

Version:
1.0
Author:
David Jencks

Constructor Summary
FBClob()
           
 
Method Summary
 java.io.InputStream getAsciiStream()
          Gets the CLOB value designated by this Clob object as a stream of Ascii bytes.
 java.io.Reader getCharacterStream()
          Gets the CLOB value designated by this Clob object as a Unicode stream.
 java.lang.String getSubString(long pos, int length)
          Returns a copy of the specified substring in the CLOB value designated by this Clob object.
 long length()
          Returns the number of characters in the CLOB value designated by this Clob object.
 long position(java.sql.Clob searchstr, long start)
          Determines the character position at which the specified Clob object searchstr appears in this Clob object.
 long position(java.lang.String searchstr, long start)
          Determines the character position at which the specified substring searchstr appears in the SQL CLOB value represented by this Clob object.
 java.io.OutputStream setAsciiStream(long param1)
           
 java.io.Writer setCharacterStream(long param1)
           
 int setString(long param1, java.lang.String param2)
           
 int setString(long param1, java.lang.String param2, int param3, int param4)
           
 void truncate(long param1)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FBClob

public FBClob()
Method Detail

length

public long length()
            throws java.sql.SQLException
Returns the number of characters in the CLOB value designated by this Clob object.

Specified by:
length in interface java.sql.Clob
Returns:
length of the CLOB in characters
Throws:
java.sql.SQLException - if there is an error accessing the length of the CLOB
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

truncate

public void truncate(long param1)
              throws java.sql.SQLException
Specified by:
truncate in interface java.sql.Clob
Parameters:
param1 -
Throws:
java.sql.SQLException -

getSubString

public java.lang.String getSubString(long pos,
                                     int length)
                              throws java.sql.SQLException
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.

Specified by:
getSubString in interface java.sql.Clob
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 object
Throws:
java.sql.SQLException - if there is an error accessing the CLOB
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

getCharacterStream

public java.io.Reader getCharacterStream()
                                  throws java.sql.SQLException
Gets the CLOB value designated by this Clob object as a Unicode stream.

Specified by:
getCharacterStream in interface java.sql.Clob
Returns:
a Unicode stream containing the CLOB data
Throws:
java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

getAsciiStream

public java.io.InputStream getAsciiStream()
                                   throws java.sql.SQLException
Gets the CLOB value designated by this Clob object as a stream of Ascii bytes.

Specified by:
getAsciiStream in interface java.sql.Clob
Returns:
an ascii stream containing the CLOB data
Throws:
java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

position

public long position(java.lang.String searchstr,
                     long start)
              throws java.sql.SQLException
Determines the character position at which the specified substring searchstr appears in the SQL CLOB value represented by this Clob object. The search begins at position start.

Specified by:
position in interface java.sql.Clob
Parameters:
searchstr - the substring for which to search
start - the position at which to begin searching; the first position is 1
Returns:
the position at which the substring appears, else -1; the first position is 1
Throws:
java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

position

public long position(java.sql.Clob searchstr,
                     long start)
              throws java.sql.SQLException
Determines the character position at which the specified Clob object searchstr appears in this Clob object. The search begins at position start.

Specified by:
position in interface java.sql.Clob
Parameters:
searchstr - the Clob object for which to search
start - the position at which to begin searching; the first position is 1
Returns:
the position at which the Clob object appears, else -1; the first position is 1
Throws:
java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.2
See Also:
What Is in the JDBC 2.0 API

setString

public int setString(long param1,
                     java.lang.String param2)
              throws java.sql.SQLException
Specified by:
setString in interface java.sql.Clob
Parameters:
param1 -
param2 -
Returns:
Throws:
java.sql.SQLException -

setString

public int setString(long param1,
                     java.lang.String param2,
                     int param3,
                     int param4)
              throws java.sql.SQLException
Specified by:
setString in interface java.sql.Clob
Parameters:
param1 -
param2 -
param3 -
param4 -
Returns:
Throws:
java.sql.SQLException -

setAsciiStream

public java.io.OutputStream setAsciiStream(long param1)
                                    throws java.sql.SQLException
Specified by:
setAsciiStream in interface java.sql.Clob
Parameters:
param1 -
Returns:
Throws:
java.sql.SQLException -

setCharacterStream

public java.io.Writer setCharacterStream(long param1)
                                  throws java.sql.SQLException
Specified by:
setCharacterStream in interface java.sql.Clob
Parameters:
param1 -
Returns:
Throws:
java.sql.SQLException -


Copyright © 2001 David Jencks and other authors. All rights reserved.