XdevClob (XDEV Application Framework 6.0.0 API)

java.lang.Object
- xdev.vt.XdevClob

All Implemented Interfaces:

Serializable, Comparable<CharHolder>, CharHolder
```
public class XdevClob
extends Object
implements CharHolder, Serializable, Comparable<CharHolder>
```
The mapping in XDEV for the SQL CLOB type. A XdevClob stores a Character Large Object as a column value in a row of a VirtualTable.
The XdevClob holds either an reference to a Clob object or plain chars.

Author:

XDEV Software Corp.

See Also:

Clob, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`XdevClob()` Initializes a new instance of `XdevClob`.
`XdevClob(char[] chars)` Initializes a new instance of `XdevBlob`.
`XdevClob(Clob clob)` Initializes a new instance of `XdevClob`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(CharHolder other)` Compares this `XdevClob` with another `CharHolder`.
`boolean`	`equals(Object obj)`
`Reader`	`getCharacterStream()` Retrieves the CLOB value designated by this Clob object as a `Reader` object (or as a stream of characters).
`Reader`	`getCharacterStream(int position, int 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(int pos, int length)` Returns a part of this `XdevClob` as a `String`.
`int`	`hashCode()` Generates a hashcode for this `XdevBlob`.
`int`	`length()` Returns the number of characters of this `XdevBlob`.
`Writer`	`setCharacterStream(int position)` Retrieves a stream to be used to write a stream of Unicode characters to the CLOB value that this Clob object represents, at position pos.
`int`	`setString(int position, String str)` Writes the given Java String to the CLOB value that this Clob object designates at the position pos.
`int`	`setString(int position, String str, int offset, int length)` Writes len characters of str, starting at character offset, to the CLOB value that this Clob represents.
`char[]`	`toCharArray()` Returns a copied `char array` of this `XdevClob`.
`Clob`	`toJDBCClob()` Returns a copied `Clob` for this `XdevClob`.
`String`	`toString()`
`void`	`truncate(long length)` Truncates the CLOB value that this `XdevClob` object represents to be len characters in length.

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

- Constructor Detail
  - XdevClob
```
public XdevClob()
```
    Initializes a new instance of XdevClob.
  - XdevClob
```
public XdevClob(char[] chars)
```
    Initializes a new instance of XdevBlob.
    
    Parameters:
    
    chars - a character array initially to be set
  - XdevClob
```
public XdevClob(Clob clob)
         throws DBException
```
    Initializes a new instance of XdevClob.
    
    Parameters:
    
    clob - a Clob initially to be set.
    
    Throws:
    
    DBException - if the specified clob could not be set.
- Method Detail
  - length
```
public int length()
```
    Returns the number of characters of this XdevBlob.
    
    Specified by:
    
    length in interface CharHolder
    
    Returns:
    
    the number of characters or -1 if the length couldn't be retrieved
  - truncate
```
public void truncate(long length)
              throws DBException
```
    Truncates the CLOB value that this XdevClob object represents to be len characters in length.
    
    Parameters:
    
    length - the length, in characters, to which the CLOB value that this Blob object represents should be truncated
    
    Throws:
    
    DBException - if truncate was not successful.
  - getCharacterStream
```
public Reader getCharacterStream()
                          throws DBException
```
    Retrieves the CLOB value designated by this Clob object as a Reader object (or as a stream of characters).
    
    Returns:
    
    a Reader object containing the CLOB data
    
    Throws:
    
    DBException - if there is an error accessing the CLOB value
  - getCharacterStream
```
public Reader getCharacterStream(int position,
                                 int length)
                          throws DBException
```
    Returns a Reader object that contains a partial Clob value, starting with the character specified by pos, which is length characters in length.
    
    Parameters:
    
    position - the offset to the first character of the partial value to be retrieved
    
    length - the length in characters of the partial value to be retrieved
    
    Returns:
    
    a Reader through which the partial Clob value can be read
    
    Throws:
    
    DBException - if there is an error accessing the CLOB value
  - setCharacterStream
```
public Writer setCharacterStream(int position)
                          throws DBException
```
    Retrieves a stream to be used to write a stream of Unicode characters to the CLOB value that this Clob object represents, at position pos. Characters written to the stream will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing characters to the stream, then the length of the Clob value will be increased to accomodate the extra characters.
    
    Parameters:
    
    position - the position at which to start writing to the CLOB value
    
    Returns:
    
    a Writer to which Unicode encoded characters can be written
    
    Throws:
    
    DBException - if there is an error accessing the CLOB value
  - getSubString
```
public String getSubString(int pos,
                           int length)
                    throws DBException
```
    Returns a part of this XdevClob as a String.
    
    Parameters:
    
    pos - the position of the first character to be returned.
    
    length - the number of characters to be returned.
    
    Returns:
    
    a String representation for a part of this XdevClob.
    
    Throws:
    
    DBException
  - setString
```
public int setString(int position,
                     String str)
              throws DBException
```
    Writes the given Java String to the CLOB value that this Clob object designates at the position pos. The string will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing the given string, then the length of the Clob value will be increased to accomodate the extra characters.
    
    Parameters:
    
    position - 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:
    
    DBException - if there is an error accessing the CLOB value
  - setString
```
public int setString(int position,
                     String str,
                     int offset,
                     int length)
              throws DBException
```
    Writes len characters of str, starting at character offset, to the CLOB value that this Clob represents. The string will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing the given string, then the length of the Clob value will be increased to accomodate the extra characters.
    
    Parameters:
    
    position - 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
    
    length - the number of characters to be written
    
    Returns:
    
    the number of characters written
    
    Throws:
    
    DBException - if there is an error accessing the CLOB value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toCharArray
```
public char[] toCharArray()
```
    Returns a copied char array of this XdevClob.
    
    Specified by:
    
    toCharArray in interface CharHolder
    
    Returns:
    
    a char array
  - compareTo
```
public int compareTo(CharHolder other)
```
    Compares this XdevClob with another CharHolder.
    The length of the CharHolder objects is used for this comparison.
    Specified by:
    
    compareTo in interface Comparable<CharHolder>
    
    Parameters:
    other - the other CharHolder.
    
    0 - if the length of both objects is equal
    
    -1 - if the length of this CharHolder is greater
    
    1 - if the length of this CharHolder is smaller
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toJDBCClob
```
public Clob toJDBCClob()
                throws DBException
```
    Returns a copied Clob for this XdevClob.
    
    Returns:
    
    a Clob
    
    Throws:
    
    DBException - if Clob could not be created.
  - hashCode
```
public int hashCode()
```
    Generates a hashcode for this XdevBlob.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hashcode

Class XdevClob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XdevClob

XdevClob

XdevClob

Method Detail

length

truncate

getCharacterStream

getCharacterStream

setCharacterStream

getSubString

setString

setString

toString

toCharArray

compareTo

equals

toJDBCClob

hashCode