java.sql

Interface Clob

public interface Clob

This interface contains methods for accessing a SQL CLOB (Character Large OBject) type.

Method Summary

InputStream
getAsciiStream()
This method returns a byte stream that reads the contents of the CLOB as a series of ASCII bytes.
Reader
getCharacterStream()
This method returns a character stream that reads the contents of the CLOB.
String
getSubString(long pos, int length)
This method returns the specified portion of the CLOB as a String.
long
length()
This method returns the number of characters in the CLOB.
long
position(String searchstr, long start)
This method returns the index into the CLOB of the first occurrence of the specified character pattern (supplied by the caller as a String).
long
position(Clob searchstr, long start)
This method returns the index into the CLOB of the first occurrence of the specified character pattern (supplied by the caller as a Clob).
OutputStream
setAsciiStream(long pos)
Writer
setCharacterStream(long pos)
int
setString(long pos, String str)
int
setString(long pos, String str, int offset, int len)
void
truncate(long len)

Method Details

getAsciiStream

public InputStream getAsciiStream()
            throws SQLException
This method returns a byte stream that reads the contents of the CLOB as a series of ASCII bytes.
Returns:
A stream to read the CLOB's contents.
Throws:
SQLException - If an error occurs.
Since:
1.2

getCharacterStream

public Reader getCharacterStream()
            throws SQLException
This method returns a character stream that reads the contents of the CLOB.
Returns:
A character stream to read the CLOB's contents.
Throws:
SQLException - If an error occurs.
Since:
1.2

getSubString

public String getSubString(long pos,
                           int length)
            throws SQLException
This method returns the specified portion of the CLOB as a String.
Parameters:
length - The requested number of characters to return.
Returns:
The requested CLOB section, as a String.
Throws:
SQLException - If an error occurs.
Since:
1.2

length

public long length()
            throws SQLException
This method returns the number of characters in the CLOB.
Returns:
The number of characters in the CLOB.
Throws:
SQLException - If an error occurs.
Since:
1.2

position

public long position(String searchstr,
                     long start)
            throws SQLException
This method returns the index into the CLOB of the first occurrence of the specified character pattern (supplied by the caller as a String). The search begins at the specified index.
Parameters:
searchstr - The character pattern to search for, passed as a String.
Returns:
The index at which the pattern was found (indexes start at 1), or -1 if the pattern was not found.
Throws:
SQLException - If an error occurs.
Since:
1.2

position

public long position(Clob searchstr,
                     long start)
            throws SQLException
This method returns the index into the CLOB of the first occurrence of the specified character pattern (supplied by the caller as a Clob). The search begins at the specified index.
Parameters:
searchstr - The character pattern to search for, passed as a Clob.
Returns:
The index at which the pattern was found (indexes start at 1), or -1 if the pattern was not found.
Throws:
SQLException - If an error occurs.
Since:
1.2

setAsciiStream

public OutputStream setAsciiStream(long pos)
            throws SQLException
Since:
1.4

setCharacterStream

public Writer setCharacterStream(long pos)
            throws SQLException
Since:
1.4

setString

public int setString(long pos,
                     String str)
            throws SQLException
Since:
1.4

setString

public int setString(long pos,
                     String str,
                     int offset,
                     int len)
            throws SQLException
Since:
1.4

truncate

public void truncate(long len)
            throws SQLException
Since:
1.4

Clob.java -- Access Character Large OBjects Copyright (C) 1999, 2000, 2002 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.