com.ibm.as400.access
Class AS400JDBCClob

java.lang.Object
  |
  +--com.ibm.as400.access.AS400JDBCClob
All Implemented Interfaces:
java.sql.Clob

public class AS400JDBCClob
extends java.lang.Object
implements java.sql.Clob

The AS400JDBCClob class provides access to character large objects. The data is valid only within the current transaction.


Method Summary
 java.io.InputStream getAsciiStream()
          Returns the entire CLOB as a stream of ASCII characters.
 java.io.Reader getCharacterStream()
          Returns the entire CLOB as a character stream.
 java.lang.String getSubString(long start, int length)
          Returns part of the contents of the CLOB.
 long length()
          Returns the length of the CLOB.
 long position(java.sql.Clob pattern, long start)
          Returns the position at which a pattern is found in the CLOB.
 long position(java.lang.String pattern, long start)
          Returns the position at which a pattern is found in the CLOB.
 java.io.OutputStream setAsciiStream(long positionToStartWriting)
          Returns a stream that an application can use to write Ascii characters to this CLOB.
 java.io.Writer setCharacterStream(long positionToStartWriting)
          Returns a stream that an application can use to write a stream of Unicode characters to this CLOB.
 int setString(long positionToStartWriting, java.lang.String stringToWrite)
          Writes a String to this CLOB, starting at position positionToStartWriting.
 int setString(long positionToStartWriting, java.lang.String string, int offset, int lengthOfWrite)
          Writes a String to this CLOB, starting at position positionToStartWriting in the CLOB.
 void truncate(long lengthOfCLOB)
          Truncates this CLOB to a length of lengthOfCLOB characters.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getAsciiStream

public java.io.InputStream getAsciiStream()
                                   throws java.sql.SQLException
Returns the entire CLOB as a stream of ASCII characters.
Specified by:
getAsciiStream in interface java.sql.Clob
Returns:
The stream.
Throws:
java.sql.SQLException - If an error occurs.

getCharacterStream

public java.io.Reader getCharacterStream()
                                  throws java.sql.SQLException
Returns the entire CLOB as a character stream.
Specified by:
getCharacterStream in interface java.sql.Clob
Returns:
The stream.
Throws:
java.sql.SQLException - If an error occurs.

getSubString

public java.lang.String getSubString(long start,
                                     int length)
                              throws java.sql.SQLException
Returns part of the contents of the CLOB.
Specified by:
getSubString in interface java.sql.Clob
Parameters:
start - The start position within the CLOB (1-based).
length - The length to return.
Returns:
The contents.
Throws:
java.sql.SQLException - If the start position is not valid, if the length is not valid, or an error occurs.

length

public long length()
            throws java.sql.SQLException
Returns the length of the CLOB.
Specified by:
length in interface java.sql.Clob
Returns:
The length of the CLOB, in characters.
Throws:
java.sql.SQLException - If an error occurs.

position

public long position(java.lang.String pattern,
                     long start)
              throws java.sql.SQLException
Returns the position at which a pattern is found in the CLOB.
Specified by:
position in interface java.sql.Clob
Parameters:
pattern - The pattern.
start - The position within the CLOB to begin searching (1-based).
Returns:
The position at which the pattern is found, or -1 if the pattern is not found.
Throws:
java.sql.SQLException - If the pattern is null, the position is not valid, or an error occurs.

position

public long position(java.sql.Clob pattern,
                     long start)
              throws java.sql.SQLException
Returns the position at which a pattern is found in the CLOB.
Specified by:
position in interface java.sql.Clob
Parameters:
pattern - The pattern.
start - The position within the CLOB to begin searching (1-based).
Returns:
The position at which the pattern is found, or -1 if the pattern is not found.
Throws:
java.sql.SQLException - If the pattern is null, the position is not valid, or an error occurs.

setAsciiStream

public java.io.OutputStream setAsciiStream(long positionToStartWriting)
                                    throws java.sql.SQLException
Returns a stream that an application can use to write Ascii characters to this CLOB. The stream begins at position positionToStartWriting, and the CLOB will be truncated after the last character of the write.
Parameters:
positionToStartWriting - The position (1-based) in the CLOB where writes should start.
Returns:
An OutputStream object to which data can be written by an application.
Throws:
java.sql.SQLException - If there is an error accessing the CLOB or if the position specified is greater than the length of the CLOB.
Since:
Modification 5

setCharacterStream

public java.io.Writer setCharacterStream(long positionToStartWriting)
                                  throws java.sql.SQLException
Returns a stream that an application can use to write a stream of Unicode characters to this CLOB. The stream begins at position positionToStartWriting, and the CLOB will be truncated after the last character of the write.
Parameters:
positionToStartWriting - The position (1-based) in the CLOB where writes should start.
Returns:
An OutputStream object to which data can be written by an application.
Throws:
java.sql.SQLException - If there is an error accessing the CLOB or if the position specified is greater than the length of the CLOB.
Since:
Modification 5

setString

public int setString(long positionToStartWriting,
                     java.lang.String stringToWrite)
              throws java.sql.SQLException
Writes a String to this CLOB, starting at position positionToStartWriting. The CLOB will be truncated after the last character written.
Parameters:
positionToStartWriting - The position (1-based) in the CLOB where writes should start.
stringToWrite - The string that will be written to the CLOB.
Returns:
The number of characters that were written.
Throws:
java.sql.SQLException - If there is an error accessing the CLOB or if the position specified is greater than the length of the CLOB.
Since:
Modification 5

setString

public int setString(long positionToStartWriting,
                     java.lang.String string,
                     int offset,
                     int lengthOfWrite)
              throws java.sql.SQLException
Writes a String to this CLOB, starting at position positionToStartWriting in the CLOB. The CLOB will be truncated after the last character written. The lengthOfWrite characters written will start from offset in the string that was provided by the application.
Parameters:
positionToStartWriting - The position (1-based) in the CLOB where writes should start.
string - The string that will be written to the CLOB.
offset - The offset into string to start reading characters (1-based).
lengthOfWrite - The number of characters to write.
Returns:
The number of characters written.
Throws:
java.sql.SQLException - If there is an error accessing the CLOB value or if the position specified is greater than the length of the CLOB.
Since:
Modification 5

truncate

public void truncate(long lengthOfCLOB)
              throws java.sql.SQLException
Truncates this CLOB to a length of lengthOfCLOB characters.
Parameters:
lengthOfCLOB - The length, in characters, that this CLOB should be after truncation.
Throws:
java.sql.SQLException - If there is an error accessing the CLOB or if the length specified is greater than the length of the CLOB.
Since:
Modification 5