Language
Asturianu (ast)
Català (ca)
Čeština (cs)
Dansk (da)
Deutsch (de)
English [US] (en-US)
Español (es)
Esperanto (eo)
Eesti keel (et)
Euskara (eu)
Français (fr)
Gàidhlig (gd)
Galego (gl)
Italiano (it)
Lietuvių (lt)
Magyar (hu)
Nederlands (nl)
Norsk (no)
Polski (pl)
Português [do Brasil] (pt-BR)
Português [Europeu] (pt)
Română (ro)
Slovenčina (sk)
Slovenščina (sl)
Suomi (fi)
Svenska (sv)
Yкраїнська (uk)
Tiếng Việt (vi)
Türkçe (tr)
ኦሮሚኛ (om)
Հայերեն (hy)
Ελληνικά (el)
български език (bg)
Русский (ru)
Cрпски [ћирилицом] (sr)
עברית (he)
हिन्दी (hi)
ភាសាខ្មែរ (km)
தமிழ் (ta)
ภาษาไทย (th)
简体中文 (zh-CN)
正體中文 (zh-TW)
日本語 (ja)
한국어 (ko)
The Free and Open Productivity Suite
:: com :: sun :: star :: sdbc ::
interface XClob
Description
is the mapping for the SQL
CLOB
type.
A SQL
CLOB
is a built-in type
that stores a Character Large Object as a column value in a row of
a database table.
The driver implements a
Clob
object using a SQL
locator(CLOB)
, which means that a
Clob
object
contains a logical pointer to the SQL
CLOB
data rather than
the data itself. A
Clob
object is valid for the duration
of the transaction in which it was created.
The
Clob
interface provides methods for getting the
length of a 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
XResultSet
,
and
XPreparedStatement
, such as
getClob
and
setClob
allow a programmer to
access the SQL
CLOB
.
Methods' Summary
length
returns the number of characters in the
CLOB
value
designated by this
Clob
object.
getSubString
returns a copy of the specified substring in the
Clob
value
designated by this
Clob
object.
getCharacterStream
gets the
Clob
contents as a stream.
position
determines the character position at which the specified substring
searchstr
appears in the
Clob
. The search begins at position
start
.
positionOfClob
determines the position at which the specified
Clob
object
pattern
appears in this
Clob
object. The search begins at position
start
.
Methods' Details
length
Description
returns the number of characters in the
CLOB
value
designated by this
Clob
object.
Returns
the length of the CLOB object
Throws
SQLException
if a database access error occurs.
getSubString
string
getSubString (
[in] hyper
pos,
[in] long
length )
raises(
SQLException );
Description
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.
Parameter pos
the starting position
Parameter length
the length of the substring
Returns
the substring
Throws
SQLException
if a database access error occurs.
getCharacterStream
Description
gets the
Clob
contents as a stream.
Returns
the stream
Throws
SQLException
if a database access error occurs.
position
hyper
position (
[in] string
searchstr,
[in] long
start )
raises(
SQLException );
Description
determines the character position at which the specified substring
searchstr
appears in the
Clob
. The search begins at position
start
.
Parameter searchstr
the string to search
Parameter start
the starting position
Returns
the length of the CLOB object
Throws
SQLException
if a database access error occurs.
positionOfClob
Description
determines the position at which the specified
Clob
object
pattern
appears in this
Clob
object. The search begins at position
start
.
Parameter pattern
the CLOB to search
Parameter start
the starting position
Returns
the position of the CLOB inside
Throws
SQLException
if a database access error occurs.
Top of Page Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.