-
- All Known Subinterfaces:
- NClob
- All Known Implementing Classes:
- SerialClob
public interface Clob
The mapping in the JavaTM programming language for the SQLCLOB
type. An SQLCLOB
is a built-in type that stores a Character Large Object as a column value in a row of a database table. By default drivers implement aClob
object using an SQLlocator(CLOB)
, which means that aClob
object contains a logical pointer to the SQLCLOB
data rather than the data itself. AClob
object is valid for the duration of the transaction in which it was created.The
Clob
interface provides methods for getting the length of an SQLCLOB
(Character Large Object) value, for materializing aCLOB
value on the client, and for searching for a substring orCLOB
object within aCLOB
value. Methods in the interfacesResultSet
,CallableStatement
, andPreparedStatement
, such asgetClob
andsetClob
allow a programmer to access an SQLCLOB
value. In addition, this interface has methods for updating aCLOB
value.All methods on the
Clob
interface must be fully implemented if the JDBC driver supports the data type.- Since:
- 1.2
-
-
Method Summary
Methods Modifier and Type Method and Description void
free()
This method frees theClob
object and releases the resources the resources that it holds.InputStream
getAsciiStream()
Retrieves theCLOB
value designated by thisClob
object as an ascii stream.Reader
getCharacterStream()
Retrieves theCLOB
value designated by thisClob
object as ajava.io.Reader
object (or as a stream of characters).Reader
getCharacterStream(long pos, long length)
Returns aReader
object that contains a partialClob
value, starting with the character specified by pos, which is length characters in length.String
getSubString(long pos, int length)
Retrieves a copy of the specified substring in theCLOB
value designated by thisClob
object.long
length()
Retrieves the number of characters in theCLOB
value designated by thisClob
object.long
position(Clob searchstr, long start)
Retrieves the character position at which the specifiedClob
objectsearchstr
appears in thisClob
object.long
position(String searchstr, long start)
Retrieves the character position at which the specified substringsearchstr
appears in the SQLCLOB
value represented by thisClob
object.OutputStream
setAsciiStream(long pos)
Retrieves a stream to be used to write Ascii characters to theCLOB
value that thisClob
object represents, starting at positionpos
.Writer
setCharacterStream(long pos)
Retrieves a stream to be used to write a stream of Unicode characters to theCLOB
value that thisClob
object represents, at positionpos
.int
setString(long pos, String str)
Writes the given JavaString
to theCLOB
value that thisClob
object designates at the positionpos
.int
setString(long pos, String str, int offset, int len)
Writeslen
characters ofstr
, starting at characteroffset
, to theCLOB
value that thisClob
represents.void
truncate(long len)
Truncates theCLOB
value that thisClob
designates to have a length oflen
characters.
-
-
-
Method Detail
-
length
long length() throws SQLException
Retrieves the number of characters in theCLOB
value designated by thisClob
object.- Returns:
- length of the
CLOB
in characters - Throws:
SQLException
- if there is an error accessing the length of theCLOB
valueSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
getSubString
String getSubString(long pos, int length) throws SQLException
Retrieves a copy of the specified substring in theCLOB
value designated by thisClob
object. The substring begins at positionpos
and has up tolength
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; the value for length must be 0 or greater- Returns:
- a
String
that is the specified substring in theCLOB
value designated by thisClob
object - Throws:
SQLException
- if there is an error accessing theCLOB
value; if pos is less than 1 or length is less than 0SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
getCharacterStream
Reader getCharacterStream() throws SQLException
Retrieves theCLOB
value designated by thisClob
object as ajava.io.Reader
object (or as a stream of characters).- Returns:
- a
java.io.Reader
object containing theCLOB
data - Throws:
SQLException
- if there is an error accessing theCLOB
valueSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
- See Also:
setCharacterStream(long)
-
getAsciiStream
InputStream getAsciiStream() throws SQLException
Retrieves theCLOB
value designated by thisClob
object as an ascii stream.- Returns:
- a
java.io.InputStream
object containing theCLOB
data - Throws:
SQLException
- if there is an error accessing theCLOB
valueSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
- See Also:
setAsciiStream(long)
-
position
long position(String searchstr, long start) throws SQLException
Retrieves the character position at which the specified substringsearchstr
appears in the SQLCLOB
value represented by thisClob
object. The search begins at positionstart
.- Parameters:
searchstr
- the substring for which to searchstart
- the position at which to begin searching; the first position is 1- Returns:
- the position at which the substring appears or -1 if it is not present; the first position is 1
- Throws:
SQLException
- if there is an error accessing theCLOB
value or if pos is less than 1SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
position
long position(Clob searchstr, long start) throws SQLException
Retrieves the character position at which the specifiedClob
objectsearchstr
appears in thisClob
object. The search begins at positionstart
.- Parameters:
searchstr
- theClob
object for which to searchstart
- the position at which to begin searching; the first position is 1- Returns:
- the position at which the
Clob
object appears or -1 if it is not present; the first position is 1 - Throws:
SQLException
- if there is an error accessing theCLOB
value or if start is less than 1SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.2
-
setString
int setString(long pos, String str) throws SQLException
Writes the given JavaString
to theCLOB
value that thisClob
object designates at the positionpos
. The string will overwrite the existing characters in theClob
object starting at the positionpos
. If the end of theClob
value is reached while writing the given string, then the length of theClob
value will be increased to accomodate the extra characters.Note: If the value specified for
pos
is greater then the length+1 of theCLOB
value then the behavior is undefined. Some JDBC drivers may throw aSQLException
while other drivers may support this operation.- Parameters:
pos
- the position at which to start writing to theCLOB
value that thisClob
object represents; The first position is 1str
- the string to be written to theCLOB
value that thisClob
designates- Returns:
- the number of characters written
- Throws:
SQLException
- if there is an error accessing theCLOB
value or if pos is less than 1SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-
setString
int setString(long pos, String str, int offset, int len) throws SQLException
Writeslen
characters ofstr
, starting at characteroffset
, to theCLOB
value that thisClob
represents. The string will overwrite the existing characters in theClob
object starting at the positionpos
. If the end of theClob
value is reached while writing the given string, then the length of theClob
value will be increased to accomodate the extra characters.Note: If the value specified for
pos
is greater then the length+1 of theCLOB
value then the behavior is undefined. Some JDBC drivers may throw aSQLException
while other drivers may support this operation.- Parameters:
pos
- the position at which to start writing to thisCLOB
object; The first position is 1str
- the string to be written to theCLOB
value that thisClob
object representsoffset
- the offset intostr
to start reading the characters to be writtenlen
- the number of characters to be written- Returns:
- the number of characters written
- Throws:
SQLException
- if there is an error accessing theCLOB
value or if pos is less than 1SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-
setAsciiStream
OutputStream setAsciiStream(long pos) throws SQLException
Retrieves a stream to be used to write Ascii characters to theCLOB
value that thisClob
object represents, starting at positionpos
. Characters written to the stream will overwrite the existing characters in theClob
object starting at the positionpos
. If the end of theClob
value is reached while writing characters to the stream, then the length of theClob
value will be increased to accomodate the extra characters.Note: If the value specified for
pos
is greater then the length+1 of theCLOB
value then the behavior is undefined. Some JDBC drivers may throw aSQLException
while other drivers may support this operation.- Parameters:
pos
- the position at which to start writing to thisCLOB
object; The first position is 1- Returns:
- the stream to which ASCII encoded characters can be written
- Throws:
SQLException
- if there is an error accessing theCLOB
value or if pos is less than 1SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
getAsciiStream()
-
setCharacterStream
Writer setCharacterStream(long pos) throws SQLException
Retrieves a stream to be used to write a stream of Unicode characters to theCLOB
value that thisClob
object represents, at positionpos
. Characters written to the stream will overwrite the existing characters in theClob
object starting at the positionpos
. If the end of theClob
value is reached while writing characters to the stream, then the length of theClob
value will be increased to accomodate the extra characters.Note: If the value specified for
pos
is greater then the length+1 of theCLOB
value then the behavior is undefined. Some JDBC drivers may throw aSQLException
while other drivers may support this operation.- Parameters:
pos
- the position at which to start writing to theCLOB
value; The first position is 1- Returns:
- a stream to which Unicode encoded characters can be written
- Throws:
SQLException
- if there is an error accessing theCLOB
value or if pos is less than 1SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
getCharacterStream()
-
truncate
void truncate(long len) throws SQLException
Truncates theCLOB
value that thisClob
designates to have a length oflen
characters.Note: If the value specified for
pos
is greater then the length+1 of theCLOB
value then the behavior is undefined. Some JDBC drivers may throw aSQLException
while other drivers may support this operation.- Parameters:
len
- the length, in characters, to which theCLOB
value should be truncated- Throws:
SQLException
- if there is an error accessing theCLOB
value or if len is less than 0SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-
free
void free() throws SQLException
This method frees theClob
object and releases the resources the resources that it holds. The object is invalid once thefree
method is called.After
free
has been called, any attempt to invoke a method other thanfree
will result in aSQLException
being thrown. Iffree
is called multiple times, the subsequent calls tofree
are treated as a no-op.- Throws:
SQLException
- if an error occurs releasing the Clob's resourcesSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
getCharacterStream
Reader getCharacterStream(long pos, long length) throws SQLException
Returns aReader
object that contains a partialClob
value, starting with the character specified by pos, which is length characters in length.- Parameters:
pos
- the offset to the first character of the partial value to be retrieved. The first character in the Clob is at position 1.length
- the length in characters of the partial value to be retrieved.- Returns:
Reader
through which the partialClob
value can be read.- Throws:
SQLException
- if pos is less than 1 or if pos is greater than the number of characters in theClob
or if pos + length is greater than the number of characters in theClob
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-java/sql/Clob.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.