MonetClob (MonetDB JDBC new 2.32 API)

java.lang.Object
- nl.cwi.monetdb.jdbc.MonetClob

All Implemented Interfaces:

Serializable, Comparable<MonetClob>, Clob
```
public class MonetClob
extends Object
implements Clob, Serializable, Comparable<MonetClob>
```
The MonetClob class implements the Clob interface. Because MonetDB/SQL currently has no support for streams, this class is a shallow wrapper of a StringBuilder. It is more or less supplied to enable an application that depends on it to run. It may be obvious that it is a real resource expensive workaround that contradicts the sole reason for a Clob: avoidance of huge resource consumption. Use of this class is highly discouraged.

Author:

Fabian Groffen

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MonetClob(char[] toParse, int startPosition, int count)

MonetClob(String in)

Constructors
Constructor and Description
`MonetClob(char[] toParse, int startPosition, int count)`
`MonetClob(String in)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(MonetClob o)` Adding the compare to method.
`boolean`	`equals(Object obj)` Overriding the equals method for the byte array.
`void`	`free()` This method frees the Clob object and releases the resources the resources that it holds.
`InputStream`	`getAsciiStream()` Retrieves the CLOB value designated by this Clob object as an ascii stream.
`Reader`	`getCharacterStream()` Retrieves the CLOB value designated by this Clob object as a java.io.Reader object (or as a stream of characters).
`Reader`	`getCharacterStream(long pos, long length)` Returns a Reader object that contains a partial Clob value, starting with the character specified by pos, which is length characters in length.
`String`	`getSubString(long pos, int length)` Retrieves a copy of the specified substring in the CLOB value designated by this Clob object.
`int`	`hashCode()` Overriding the hashCode method for the byte array.
`long`	`length()` Retrieves the number of characters in the CLOB value designated by this Clob object.
`long`	`position(Clob searchstr, long start)` Retrieves the character position at which the specified Clob object searchstr appears in this Clob object.
`long`	`position(String searchstr, long start)` Retrieves the character position at which the specified substring searchstr appears in the SQL CLOB value represented by this Clob object.
`OutputStream`	`setAsciiStream(long pos)`
`Writer`	`setCharacterStream(long pos)`
`int`	`setString(long pos, String str)` Writes the given Java String to the CLOB value that this Clob object designates at the position pos.
`int`	`setString(long pos, String str, int offset, int len)` Writes len characters of str, starting at character offset, to the CLOB value that this Clob represents.
`String`	`toString()` Returns the String behind this Clob.
`void`	`truncate(long len)` Truncates the CLOB value that this Clob designates to have a length of len characters.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MonetClob
```
public MonetClob(String in)
```
  - MonetClob
```
public MonetClob(char[] toParse,
                 int startPosition,
                 int count)
```
- Method Detail
  - free
```
public void free()
```
    This method frees the Clob object and releases the resources the resources that it holds. The object is invalid once the free method is called. After free has been called, any attempt to invoke a method other than free will result in a SQLException being thrown. If free is called multiple times, the subsequent calls to free are treated as a no-op.
    
    Specified by:
    
    free in interface Clob
  - getAsciiStream
```
public InputStream getAsciiStream()
                           throws SQLException
```
    Retrieves the CLOB value designated by this Clob object as an ascii stream.
    
    Specified by:
    
    getAsciiStream in interface Clob
    
    Returns:
    
    a java.io.InputStream object containing the CLOB data
    
    Throws:
    
    SQLException - if there is an error accessing the CLOB value
  - getCharacterStream
```
public Reader getCharacterStream()
                          throws SQLException
```
    Retrieves the CLOB value designated by this Clob object as a java.io.Reader object (or as a stream of characters).
    
    Specified by:
    
    getCharacterStream in interface Clob
    
    Returns:
    
    a java.io.Reader object containing the CLOB data
    
    Throws:
    
    SQLException - if there is an error accessing the CLOB value
  - getCharacterStream
```
public Reader getCharacterStream(long pos,
                                 long length)
                          throws SQLException
```
    Returns a Reader object that contains a partial Clob value, starting with the character specified by pos, which is length characters in length.
    
    Specified by:
    
    getCharacterStream in interface Clob
    
    Parameters:
    
    pos - the offset to the first character of the partial value to be retrieved. The first character in the Clob is at position 1.
    
    length - the length in characters of the partial value to be retrieved.
    
    Returns:
    
    Reader through which the partial Clob value can be read.
    
    Throws:
    
    SQLException - if there is an error accessing the CLOB value
  - getSubString
```
public String getSubString(long pos,
                           int length)
                    throws SQLException
```
    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.
    
    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 value
  - length
```
public long length()
            throws SQLException
```
    Retrieves the number of characters in the CLOB value designated by this Clob object.
    
    Specified by:
    
    length in interface Clob
    
    Returns:
    
    length of the CLOB in characters
    
    Throws:
    
    SQLException - if there is an error accessing the length of the CLOB value
  - position
```
public long position(Clob searchstr,
                     long start)
              throws SQLException
```
    Retrieves 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 or -1 if it is not present; the first position is 1
    
    Throws:
    
    SQLException - if there is an error accessing the CLOB value
  - position
```
public long position(String searchstr,
                     long start)
              throws SQLException
```
    Retrieves 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 or -1 if it is not present; the first position is 1
    
    Throws:
    
    SQLException - if there is an error accessing the CLOB value
  - setAsciiStream
```
public OutputStream setAsciiStream(long pos)
                            throws SQLException
```
    Specified by:
    
    setAsciiStream in interface Clob
    
    Throws:
    
    SQLException
  - setCharacterStream
```
public Writer setCharacterStream(long pos)
                          throws SQLException
```
    Specified by:
    
    setCharacterStream in interface Clob
    
    Throws:
    
    SQLException
  - setString
```
public int setString(long pos,
                     String str)
              throws SQLException
```
    Writes the given Java String to the CLOB value that this Clob object designates at the position pos.
    
    Specified by:
    
    setString in interface Clob
    
    Parameters:
    
    pos - the position at which to start writing to the CLOB value that this Clob object represents
    
    str - the string to be written to the CLOB value that this Clob designates
    
    Returns:
    
    the number of characters written
    
    Throws:
    
    SQLException - if there is an error accessing the CLOB value
  - setString
```
public int setString(long pos,
                     String str,
                     int offset,
                     int len)
              throws SQLException
```
    Writes len characters of str, starting at character offset, to the CLOB value that this Clob represents.
    
    Specified by:
    
    setString in interface Clob
    
    Parameters:
    
    pos - the position at which to start writing to this CLOB object
    
    str - the string to be written to the CLOB value that this Clob object represents
    
    offset - the offset into str to start reading the characters to be written
    
    len - the number of characters to be written
    
    Returns:
    
    the number of characters written
    
    Throws:
    
    SQLException - if there is an error accessing the CLOB value
  - truncate
```
public void truncate(long len)
              throws SQLException
```
    Truncates the CLOB value that this Clob designates to have a length of len characters.
    
    Specified by:
    
    truncate in interface Clob
    
    Parameters:
    
    len - the length, in bytes, to which the CLOB value should be truncated
    
    Throws:
    
    SQLException - if there is an error accessing the CLOB value
  - toString
```
public String toString()
```
    Returns the String behind this Clob. This is a MonetClob extension that does not violate nor is described in the Clob interface.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the String this Clob wraps.
  - equals
```
public boolean equals(Object obj)
```
    Overriding the equals method for the byte array.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overriding the hashCode method for the byte array.
    
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(MonetClob o)
```
    Adding the compare to method.
    
    Specified by:
    
    compareTo in interface Comparable<MonetClob>

Class MonetClob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MonetClob

MonetClob

Method Detail

free

getAsciiStream

getCharacterStream

getCharacterStream

getSubString

length

position

position

setAsciiStream

setCharacterStream

setString

setString

truncate

toString

equals

hashCode

compareTo