org.teiid.core.types

Class ClobImpl

java.lang.Object

org.teiid.core.types.BaseLob

org.teiid.core.types.ClobImpl

All Implemented Interfaces:

Externalizable, Serializable, Clob, InputStreamFactory.StreamFactoryReference

public class ClobImpl
extends BaseLob
implements Clob

This object holds a chunk of char data and implements the JDBC Clob interface. This object presents a streaming interface and provides a way to access partial of the Clob data. Connectors can use this object when dealing with large objects.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClobImpl()
ClobImpl(char[] chars)
ClobImpl(InputStreamFactory streamFactory, long length) Creates a new ClobImpl.
ClobImpl(String str)

Method Summary

Modifier and Type	Method and Description
static Clob	createClob(char[] chars)
InputStream	getAsciiStream() Gets the CLOB value designated by this Clob object as a stream of Ascii bytes.
Reader	getCharacterStream(long arg0, long arg1)
String	getSubString(long pos, int length) Returns a copy of the specified substring in the CLOB value designated by this Clob object.
long	length() Returns the number of characters in the CLOB value designated by this Clob object.
long	position(Clob searchstr, long start) Determines the character position at which the specified Clob object searchstr appears in this Clob object.
long	position(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.
OutputStream	setAsciiStream(long arg0)
Writer	setCharacterStream(long arg0)
int	setString(long arg0, String arg1)
int	setString(long arg0, String arg1, int arg2, int arg3)
void	truncate(long arg0)

Methods inherited from class org.teiid.core.types.BaseLob

free, getBinaryStream, getCharacterStream, getCharset, getStreamFactory, readExternal, setCharset, setEncoding, setStreamFactory, writeExternal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.sql.Clob

free, getCharacterStream

Constructor Detail

ClobImpl

public ClobImpl()

ClobImpl

public ClobImpl(InputStreamFactory streamFactory,
                long length)

Creates a new ClobImpl. Note that the length is not taken from the InputStreamFactory since it refers to bytes and not chars.

Parameters:

streamFactory -

length -

ClobImpl

public ClobImpl(char[] chars)

ClobImpl

public ClobImpl(String str)

Method Detail

getAsciiStream

public InputStream getAsciiStream()
                           throws SQLException

Gets the CLOB value designated by this Clob object as a stream of Ascii bytes.

Specified by:

getAsciiStream in interface Clob

Returns:

an ascii stream containing the CLOB data

Throws:

SQLException - if there is an error accessing the CLOB value

getSubString

public String getSubString(long pos,
                           int length)
                    throws SQLException

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.

Specified by:

getSubString in interface Clob

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

Returns:

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

Throws:

SQLException - if there is an error accessing the CLOB

length

public long length()
            throws SQLException

Returns the number of characters in the CLOB value designated by this Clob object.

Specified by:

length in interface Clob

Overrides:

length in class BaseLob

Returns:

length of the CLOB in characters

Throws:

SQLException

position

public long position(Clob searchstr,
                     long start)
              throws SQLException

Determines the character position at which the specified Clob object searchstr appears in this Clob object. The search begins at position start.

Specified by:

position in interface Clob

Parameters:

searchstr - the Clob object for which to search

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

Returns:

the position at which the Clob object appears, else -1; the first position is 1

Throws:

SQLException

position

public long position(String searchstr,
                     long start)
              throws SQLException

Determines the character position at which the specified substring searchstr appears in the SQL CLOB value represented by this Clob object. The search begins at position start.

Specified by:

position in interface Clob

Parameters:

searchstr - the substring for which to search

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

Returns:

the position at which the substring appears, else -1; the first position is 1

Throws:

SQLException - if there is an error accessing the CLOB value

getCharacterStream

public Reader getCharacterStream(long arg0,
                                 long arg1)
                          throws SQLException

Specified by:

getCharacterStream in interface Clob

Throws:

SQLException

setAsciiStream

public OutputStream setAsciiStream(long arg0)
                            throws SQLException

Specified by:

setAsciiStream in interface Clob

Throws:

SQLException

setCharacterStream

public Writer setCharacterStream(long arg0)
                          throws SQLException

Specified by:

setCharacterStream in interface Clob

Throws:

SQLException

setString

public int setString(long arg0,
                     String arg1)
              throws SQLException

Specified by:

setString in interface Clob

Throws:

SQLException

setString

public int setString(long arg0,
                     String arg1,
                     int arg2,
                     int arg3)
              throws SQLException

Specified by:

setString in interface Clob

Throws:

SQLException

truncate

public void truncate(long arg0)
              throws SQLException

Specified by:

truncate in interface Clob

Throws:

SQLException

createClob

public static Clob createClob(char[] chars)