com.metamatrix.jdbc
Class MMClob

java.lang.Object
  extended by com.metamatrix.jdbc.MMClob
All Implemented Interfaces:
java.sql.Clob

public class MMClob
extends java.lang.Object
implements java.sql.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.


Constructor Summary
MMClob(StreamingLobChunckProducer.Factory lobChunkFactory, ClobType clob)
           
 
Method Summary
 void free()
           
 java.io.InputStream getAsciiStream()
          Gets the CLOB value designated by this Clob object as a stream of Ascii bytes.
 java.io.Reader getCharacterStream()
          Gets the CLOB value designated by this Clob object as a Unicode stream.
 java.io.Reader getCharacterStream(long arg0, long arg1)
           
 java.lang.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.
static java.sql.Clob newInstance(StreamingLobChunckProducer.Factory lobChunckFactory, ClobType clob)
           
 long position(java.sql.Clob searchstr, long start)
          Determines the character position at which the specified Clob object searchstr appears in this Clob object.
 long position(java.lang.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.
 java.io.OutputStream setAsciiStream(long arg0)
           
 java.io.Writer setCharacterStream(long arg0)
           
 int setString(long arg0, java.lang.String arg1)
           
 int setString(long arg0, java.lang.String arg1, int arg2, int arg3)
           
 void truncate(long arg0)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MMClob

public MMClob(StreamingLobChunckProducer.Factory lobChunkFactory,
              ClobType clob)
       throws java.sql.SQLException
Throws:
java.sql.SQLException
Method Detail

newInstance

public static java.sql.Clob newInstance(StreamingLobChunckProducer.Factory lobChunckFactory,
                                        ClobType clob)
                                 throws java.sql.SQLException
Throws:
java.sql.SQLException

getAsciiStream

public java.io.InputStream getAsciiStream()
                                   throws java.sql.SQLException
Gets the CLOB value designated by this Clob object as a stream of Ascii bytes.

Specified by:
getAsciiStream in interface java.sql.Clob
Returns:
an ascii stream containing the CLOB data
Throws:
java.sql.SQLException - if there is an error accessing the CLOB value

getCharacterStream

public java.io.Reader getCharacterStream()
                                  throws java.sql.SQLException
Gets the CLOB value designated by this Clob object as a Unicode stream.

Specified by:
getCharacterStream in interface java.sql.Clob
Returns:
a Unicode stream containing the CLOB data
Throws:
java.sql.SQLException - if there is an error accessing the CLOB value

getSubString

public java.lang.String getSubString(long pos,
                                     int length)
                              throws java.sql.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 java.sql.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:
java.sql.SQLException - if there is an error accessing the CLOB

length

public long length()
            throws java.sql.SQLException
Returns the number of characters in the CLOB value designated by this Clob object.

Specified by:
length in interface java.sql.Clob
Returns:
length of the CLOB in characters
Throws:
java.sql.SQLException

position

public long position(java.sql.Clob searchstr,
                     long start)
              throws java.sql.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 java.sql.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:
java.sql.SQLException

position

public long position(java.lang.String searchstr,
                     long start)
              throws java.sql.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 java.sql.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:
java.sql.SQLException - if there is an error accessing the CLOB value

free

public void free()
          throws java.sql.SQLException
Specified by:
free in interface java.sql.Clob
Throws:
java.sql.SQLException

getCharacterStream

public java.io.Reader getCharacterStream(long arg0,
                                         long arg1)
                                  throws java.sql.SQLException
Specified by:
getCharacterStream in interface java.sql.Clob
Throws:
java.sql.SQLException

setAsciiStream

public java.io.OutputStream setAsciiStream(long arg0)
                                    throws java.sql.SQLException
Specified by:
setAsciiStream in interface java.sql.Clob
Throws:
java.sql.SQLException

setCharacterStream

public java.io.Writer setCharacterStream(long arg0)
                                  throws java.sql.SQLException
Specified by:
setCharacterStream in interface java.sql.Clob
Throws:
java.sql.SQLException

setString

public int setString(long arg0,
                     java.lang.String arg1)
              throws java.sql.SQLException
Specified by:
setString in interface java.sql.Clob
Throws:
java.sql.SQLException

setString

public int setString(long arg0,
                     java.lang.String arg1,
                     int arg2,
                     int arg3)
              throws java.sql.SQLException
Specified by:
setString in interface java.sql.Clob
Throws:
java.sql.SQLException

truncate

public void truncate(long arg0)
              throws java.sql.SQLException
Specified by:
truncate in interface java.sql.Clob
Throws:
java.sql.SQLException


Copyright © 2009. All Rights Reserved.