Top Fields Constructors Methods
org.postgresql.jdbc

public Class PgClob

extends AbstractBlobClob
implements Clob
Class Inheritance
All Implemented Interfaces
java.sql.Clob
Imports
org.postgresql.Driver, org.postgresql.core.BaseConnection, org.postgresql.largeobject.LargeObject, java.io.InputStream, .InputStreamReader, .OutputStream, .Reader, .Writer, java.nio.charset.Charset, java.sql.Clob, .SQLException

Field Summary

Inherited from org.postgresql.jdbc.AbstractBlobClob:
connlock

Constructor Summary

AccessConstructor and Description
public
PgClob(BaseConnection conn, long oid)

Method Summary

Modifier and TypeMethod and Description
public InputStream
getAsciiStream()

Implements java.sql.Clob.getAsciiStream.

Retrieves the CLOB value designated by this Clob object as an ascii stream.

public Reader
getCharacterStream(long
the offset to the first character of the partial value to be retrieved. The first character in the Clob is at position 1.
pos, long
the length in characters of the partial value to be retrieved.
length)

Implements java.sql.Clob.getCharacterStream.

Returns a Reader object that contains a partial Clob value, starting with the character specified by pos, which is length characters in length.

public Reader
getCharacterStream()

Implements java.sql.Clob.getCharacterStream.

Retrieves the CLOB value designated by this Clob object as a java.io.Reader object (or as a stream of characters).

public String
getSubString(long
the first character of the substring to be extracted. The first character is at position 1.
i, int
the number of consecutive characters to be copied; the value for length must be 0 or greater
j)

Implements java.sql.Clob.getSubString.

Retrieves a copy of the specified substring in the CLOB value designated by this Clob object.

public long
position(String
the substring for which to search
pattern, long
the position at which to begin searching; the first position is 1
start)

Implements java.sql.Clob.position.

For now, this is not implemented.

public long
position(Clob
the Clob object for which to search
pattern, long
the position at which to begin searching; the first position is 1
start)

Implements java.sql.Clob.position.

This should be simply passing the byte value of the pattern Blob.

public OutputStream
setAsciiStream(long
the position at which to start writing to this CLOB object; The first position is 1
pos)

Implements java.sql.Clob.setAsciiStream.

Retrieves a stream to be used to write Ascii characters to the CLOB value that this Clob object represents, starting at position pos.

public Writer
setCharacterStream(long
the position at which to start writing to the CLOB value; The first position is 1
pos)

Implements java.sql.Clob.setCharacterStream.

Retrieves a stream to be used to write a stream of Unicode characters to the CLOB value that this Clob object represents, at position pos.

public int
setString(long
the position at which to start writing to the CLOB value that this Clob object represents; the first position is 1.
pos, String
the string to be written to the CLOB value that this Clob designates
str)

Implements java.sql.Clob.setString.

Writes the given Java String to the CLOB value that this Clob object designates at the position pos.

public int
setString(long
the position at which to start writing to this CLOB object; The first position is 1
pos, String
the string to be written to the CLOB value that this Clob object represents
str, int
the offset into str to start reading the characters to be written
offset, int
the number of characters to be written
len)

Implements java.sql.Clob.setString.

Writes len characters of str, starting at character offset, to the CLOB value that this Clob represents.

Inherited from org.postgresql.jdbc.AbstractBlobClob:
addSubLOassertPositionassertPositioncheckFreedfreegetBinaryStreamgetBytesgetLolengthpositionpositionsetBinaryStreamtruncate

Constructor Detail

PgClobback to summary
public PgClob(BaseConnection conn, long oid) throws SQLException

Method Detail

getAsciiStreamback to summary
public InputStream getAsciiStream() throws SQLException

Implements java.sql.Clob.getAsciiStream.

Doc from java.sql.Clob.getAsciiStream.

Retrieves the CLOB value designated by this Clob object as an ascii stream.

Returns:InputStream

a java.io.InputStream object containing the CLOB data

Annotations
@Override
Exceptions
SQLException:
if there is an error accessing the CLOB value
getCharacterStreamback to summary
public Reader getCharacterStream(long pos, long length) throws SQLException

Implements java.sql.Clob.getCharacterStream.

Doc from java.sql.Clob.getCharacterStream.

Returns a Reader object that contains a partial Clob value, starting with the character specified by pos, which is length characters in length.

Parameters
pos:long

the offset to the first character of the partial value to be retrieved. The first character in the Clob is at position 1.

length:long

the length in characters of the partial value to be retrieved.

Returns:Reader

Reader through which the partial Clob value can be read.

Annotations
@Override
Exceptions
SQLException:
if pos is less than 1; or if pos is greater than the number of characters in the Clob; or if pos + length is greater than the number of characters in the Clob
getCharacterStreamback to summary
public Reader getCharacterStream() throws SQLException

Implements java.sql.Clob.getCharacterStream.

Doc from java.sql.Clob.getCharacterStream.

Retrieves the CLOB value designated by this Clob object as a java.io.Reader object (or as a stream of characters).

Returns:Reader

a java.io.Reader object containing the CLOB data

Annotations
@Override
Exceptions
SQLException:
if there is an error accessing the CLOB value
getSubStringback to summary
public String getSubString(long i, int j) throws SQLException

Implements java.sql.Clob.getSubString.

Doc from java.sql.Clob.getSubString.

Retrieves 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.

Parameters
i:long

the first character of the substring to be extracted. The first character is at position 1.

j:int

the number of consecutive characters to be copied; the value for length must be 0 or greater

Returns:String

a String that is the specified substring in the CLOB value designated by this Clob object

Annotations
@Override
Exceptions
SQLException:
if there is an error accessing the CLOB value; if pos is less than 1 or length is less than 0
positionback to summary
public long position(String pattern, long start) throws SQLException

Implements java.sql.Clob.position.

For now, this is not implemented.

Parameters
pattern:String

Doc from java.sql.Clob.position.

the substring for which to search

start:long

Doc from java.sql.Clob.position.

the position at which to begin searching; the first position is 1

Returns:long

Doc from java.sql.Clob.position.

the position at which the substring appears or -1 if it is not present; the first position is 1

Annotations
@Override
Exceptions
SQLException:

Doc from java.sql.Clob.position.

if there is an error accessing the CLOB value or if pos is less than 1

positionback to summary
public long position(Clob pattern, long start) throws SQLException

Implements java.sql.Clob.position.

This should be simply passing the byte value of the pattern Blob.

Parameters
pattern:Clob

Doc from java.sql.Clob.position.

the Clob object for which to search

start:long

Doc from java.sql.Clob.position.

the position at which to begin searching; the first position is 1

Returns:long

Doc from java.sql.Clob.position.

the position at which the Clob object appears or -1 if it is not present; the first position is 1

Annotations
@Override
Exceptions
SQLException:

Doc from java.sql.Clob.position.

if there is an error accessing the CLOB value or if start is less than 1

setAsciiStreamback to summary
public OutputStream setAsciiStream(long pos) throws SQLException

Implements java.sql.Clob.setAsciiStream.

Doc from java.sql.Clob.setAsciiStream.

Retrieves a stream to be used to write Ascii characters to the CLOB value that this Clob object represents, starting at position pos. Characters written to the stream will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing characters to the stream, then the length of the Clob value will be increased to accommodate the extra characters.

Note

If the value specified for pos is greater than the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw an SQLException while other drivers may support this operation.

Parameters
pos:long

the position at which to start writing to this CLOB object; The first position is 1

Returns:OutputStream

the stream to which ASCII encoded characters can be written

Annotations
@Override
Exceptions
SQLException:
if there is an error accessing the CLOB value or if pos is less than 1
setCharacterStreamback to summary
public Writer setCharacterStream(long pos) throws SQLException

Implements java.sql.Clob.setCharacterStream.

Doc from java.sql.Clob.setCharacterStream.

Retrieves a stream to be used to write a stream of Unicode characters to the CLOB value that this Clob object represents, at position pos. Characters written to the stream will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing characters to the stream, then the length of the Clob value will be increased to accommodate the extra characters.

Note

If the value specified for pos is greater than the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw an SQLException while other drivers may support this operation.

Parameters
pos:long

the position at which to start writing to the CLOB value; The first position is 1

Returns:Writer

a stream to which Unicode encoded characters can be written

Annotations
@Override
Exceptions
SQLException:
if there is an error accessing the CLOB value or if pos is less than 1
setStringback to summary
public int setString(long pos, String str) throws SQLException

Implements java.sql.Clob.setString.

Doc from java.sql.Clob.setString.

Writes the given Java String to the CLOB value that this Clob object designates at the position pos. The string will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing the given string, then the length of the Clob value will be increased to accommodate the extra characters.

Note

If the value specified for pos is greater than the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw an SQLException while other drivers may support this operation.

Parameters
pos:long

the position at which to start writing to the CLOB value that this Clob object represents; the first position is 1.

str:String

the string to be written to the CLOB value that this Clob designates

Returns:int

the number of characters written

Annotations
@Override
Exceptions
SQLException:
if there is an error accessing the CLOB value or if pos is less than 1
setStringback to summary
public int setString(long pos, String str, int offset, int len) throws SQLException

Implements java.sql.Clob.setString.

Doc from java.sql.Clob.setString.

Writes len characters of str, starting at character offset, to the CLOB value that this Clob represents. The string will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing the given string, then the length of the Clob value will be increased to accommodate the extra characters.

Note

If the value specified for pos is greater than the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw an SQLException while other drivers may support this operation.

Parameters
pos:long

the position at which to start writing to this CLOB object; The first position is 1

str:String

the string to be written to the CLOB value that this Clob object represents

offset:int

the offset into str to start reading the characters to be written

len:int

the number of characters to be written

Returns:int

the number of characters written

Annotations
@Override
Exceptions
SQLException:
if there is an error accessing the CLOB value or if pos is less than 1