|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.firebirdsql.jdbc.FBClob
public class FBClob
The mapping in the JavaTM programming language for the SQL CLOB type. An SQL CLOB is a built-in type that stores a Character Large Object as a column value in a row of a database table. CLOBS are not currently supported by the Jaybird driver. The Clob interface provides methods for getting the length of an SQL CLOB (Character Large Object) value, for materializing a CLOB value on the client, and for searching for a substring or CLOB object within a CLOB value. Methods in the interfaces ResultSet, CallableStatement, and PreparedStatement, such as getClob and setClob allow a programmer to access an SQL CLOB value. In addition, this interface has methods for updating a CLOB value.
Constructor Summary | |
---|---|
FBClob(FBBlob blob)
|
Method Summary | |
---|---|
void |
copyCharacterStream(java.io.Reader characterStream)
|
void |
free()
|
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.io.Reader |
getCharacterStream(long pos,
long length)
|
java.lang.String |
getSubString(long pos,
int length)
Returns a copy of the specified substring in the CLOB
value designated by this Clob object. |
FBBlob |
getWrappedBlob()
|
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 pos)
Set a byte stream to write the contents of this Clob. |
java.io.Writer |
setCharacterStream(long position)
Create a writer to add character data to this Clob. |
int |
setString(long start,
java.lang.String searchString)
This operation is not supported Writes the given Java String to the CLOB value that this Clob object designates at the
position pos . |
int |
setString(long param1,
java.lang.String param2,
int param3,
int param4)
This operation is not supported |
void |
truncate(long param1)
This operation is not currently supported Truncate this Clob to a given length. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FBClob(FBBlob blob)
Method Detail |
---|
public long length() throws java.sql.SQLException
CLOB
value
designated by this Clob
object.
length
in interface java.sql.Clob
CLOB
in characters
java.sql.SQLException
- if there is an error accessing the length of the
CLOB
public void truncate(long param1) throws java.sql.SQLException
Clob
to a given length.
truncate
in interface java.sql.Clob
param1
- The length to truncate this Clob to
java.sql.SQLException
- this operation is not supportedpublic java.lang.String getSubString(long pos, int length) throws java.sql.SQLException
CLOB
value designated by this Clob
object. The substring begins
at position pos
and has up to length
consecutive characters.
getSubString
in interface java.sql.Clob
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
String
that is the specified substring in the
CLOB
value designated by this Clob
object
java.sql.SQLException
- if there is an error accessing the CLOB
public java.io.Reader getCharacterStream() throws java.sql.SQLException
CLOB
value designated by this Clob
object as a Unicode stream.
getCharacterStream
in interface java.sql.Clob
CLOB
data
java.sql.SQLException
- if there is an error accessing the CLOB
valuepublic java.io.InputStream getAsciiStream() throws java.sql.SQLException
CLOB
value designated by this Clob
object as a stream of Ascii bytes.
getAsciiStream
in interface java.sql.Clob
CLOB
data
java.sql.SQLException
- if there is an error accessing the CLOB
valuepublic long position(java.lang.String searchstr, long start) throws java.sql.SQLException
searchstr
appears in the SQL CLOB
value
represented by this Clob
object. The search begins at
position start
.
position
in interface java.sql.Clob
searchstr
- the substring for which to searchstart
- the position at which to begin searching; the first position
is 1
java.sql.SQLException
- if there is an error accessing the CLOB
valuepublic long position(java.sql.Clob searchstr, long start) throws java.sql.SQLException
Clob
object searchstr
appears in this
Clob
object. The search begins at position
start
.
position
in interface java.sql.Clob
searchstr
- the Clob
object for which to searchstart
- the position at which to begin searching; the first position
is 1
Clob
object appears,
else -1; the first position is 1
java.sql.SQLException
- if there is an error accessing the CLOB
valuepublic int setString(long start, java.lang.String searchString) throws java.sql.SQLException
Clob
object designates at the
position pos
.
setString
in interface java.sql.Clob
start
- position at which to start writingsearchString
- The String
value to write
java.sql.SQLException
- because this operation is not supportedpublic int setString(long param1, java.lang.String param2, int param3, int param4) throws java.sql.SQLException
setString
in interface java.sql.Clob
param1
- param2
- param3
- param4
- java.sql.SQLException
- public java.io.OutputStream setAsciiStream(long pos) throws java.sql.SQLException
setAsciiStream
in interface java.sql.Clob
pos
- The position at which writing is to start.
java.sql.SQLException
- public java.io.Writer setCharacterStream(long position) throws java.sql.SQLException
setCharacterStream
in interface java.sql.Clob
position
- The position at which the Writer should start writing
java.sql.SQLException
- public void free() throws java.sql.SQLException
free
in interface java.sql.Clob
java.sql.SQLException
public java.io.Reader getCharacterStream(long pos, long length) throws java.sql.SQLException
getCharacterStream
in interface java.sql.Clob
java.sql.SQLException
public void copyCharacterStream(java.io.Reader characterStream) throws java.sql.SQLException
java.sql.SQLException
public FBBlob getWrappedBlob() throws java.sql.SQLException
java.sql.SQLException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |