Skip navigation links

oracle.streams
Interface ChunkColumnValue

All Superinterfaces:

ColumnValue

All Known Implementing Classes:

DefaultChunkColumnValue

public interface ChunkColumnValue

extends ColumnValue

The ChunkColumnValue interface encapsulates the information about a LOB, LONG, or XMLTYPE column in a RowLCR. This interface allows large column data to be divided into small chunks and streamed.
You can have a customized implementation of ChunkColumnValue by implementing this interface.

See Also:

RowLCR

Field Summary

static int	BLOB
static int	CLOB
static int	LONG
static int	LONGRAW
static int	NCLOB
static int	XMLTYPE

Fields inherited from interface oracle.streams.ColumnValue

BINARY_DOUBLE, BINARY_FLOAT, CHAR, DATE, INTERVALDS, INTERVALYM, NUMBER, RAW, TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPTZ

Method Summary

int	getCharSetId() Gets the chunk character set ID.
java.math.BigInteger	getChunkOffset() Gets the chunk operation offset.
java.math.BigInteger	getChunkOperationSize() Gets the chunk operation size.
int	getChunkType() Gets the chunk type.
boolean	isEmptyChunk() Indicates whether the chunk is empty.
boolean	isEndOfRow() Indicates whether the chunk is the end of the entire row change.
boolean	isLastChunk() Indicates whether the chunk is the last one for the column.
boolean	isXMLDiff() Indicates whether the XMLType chunk is an XMLDiff.
void	setCharSetId(int charSetId) Sets the character set ID for an XMLTYPE chunk.
void	setChunkOffset(java.math.BigInteger chunkOffset) Sets the chunk operation offset.
void	setChunkOperationSize(java.math.BigInteger chunkOperationSize) Sets the chunk operation size.
void	setChunkType(int chunkType) Sets the chunk type.
void	setEmptyChunk(boolean emptyChunk) Sets the empty chunk flag.
void	setEndOfRow(boolean endOfRow) Sets the endOfRow chunk flag.
void	setLastChunk(boolean lastChunk) Sets the last chunk flag.
void	setXMLDiff(boolean xmlDiff) Sets the XMLDiff flag.

Methods inherited from interface oracle.streams.ColumnValue

getCharsetId, getColumnData, getColumnDataType, getColumnName, getTDEFlag, setCharsetId, setColumnData, setColumnName, setTDEFlag

Field Detail

CLOB

static final int CLOB

See Also:

Constant Field Values

BLOB

static final int BLOB

See Also:

Constant Field Values

NCLOB

static final int NCLOB

See Also:

Constant Field Values

XMLTYPE

static final int XMLTYPE

See Also:

Constant Field Values

LONG

static final int LONG

See Also:

Constant Field Values

LONGRAW

static final int LONGRAW

See Also:

Constant Field Values

Method Detail

getChunkType

int getChunkType()

Gets the chunk type.
The chunk type indicates the type of the column that contains data that can be split into multiple chunks. Valid values are: BLOB, CLOB, NCLOB, and XMLTYPE.

Returns:

an integer that contains the chunk type as defined in this interface

getChunkOffset

java.math.BigInteger getChunkOffset()

Gets the chunk operation offset.
This method obtains the offset information for piecewise LOB operations. For DML operations, NULL is returned.
If there are multiple chunks for one LOB WRITE operation, then only the offset of the first chunk is relevant.

Returns:

a BigInteger that contains the chunk operation offset

getChunkOperationSize

java.math.BigInteger getChunkOperationSize()

Gets the chunk operation size.
This method obtains the size information for piecewise LOB operations LOB TRIM and LOB ERASE. For other operations, NULL is returned.
The chunk operation size is the number of bytes(for BLOBs) or characters (for CLOBs or NCLOBs).

Returns:

a BigInteger that contains the chunk operation size

getCharSetId

int getCharSetId()

Gets the chunk character set ID. This is only for XMLTTPE chunk
The character set ID indicates the character set used to interpret the XMLTYPE chunk data.
Check oracle.sql.CharacterSet for definition of Oracle CharacterSet ID.

Returns:

an integer that indicates the character set

setChunkType

void setChunkType(int chunkType)
                  throws StreamsException

Sets the chunk type.
The chunk type specifies the type of the column that contains data that can be split into mutliple chunks. Valid values are: BLOB, CLOB, NCLOB, and XMLTYPE.

Parameters:

chunkType - The chunk type as defined in this interface

Throws:

StreamsException - is thrown if chunk type is invalid.

setChunkOffset

void setChunkOffset(java.math.BigInteger chunkOffset)

Sets the chunk operation offset.
Use this method for a piecewise LOB operation in which the operation offset indicates the starting point for the LOB operation. The offset value starts from 1.

Parameters:

chunkOffset - The chunk operation offset

setChunkOperationSize

void setChunkOperationSize(java.math.BigInteger chunkOperationSize)

Sets the chunk operation size.
Use this method for a piecewise LOB operation where the size is the amount of data to be erased in the case of LOB ERASE or the trim size in the case of LOB TRIM. The chunk operation size is the number of bytes(for BLOBs) or characters (for CLOBs and NCLOBs).

Parameters:

chunkOperationSize - The chunk operation size

isLastChunk

boolean isLastChunk()

Indicates whether the chunk is the last one for the column.

Returns:

a boolean flag indicates if this is the last chunk

isEmptyChunk

boolean isEmptyChunk()

Indicates whether the chunk is empty. For a LOB column, an empty LOB is different than a column containing NULL value.

Returns:

a boolean flag indicates if this is an empty chunk

isXMLDiff

boolean isXMLDiff()

Indicates whether the XMLType chunk is an XMLDiff.

Returns:

a boolean flag indicates if this is an XMLDiff.

isEndOfRow

boolean isEndOfRow()

Indicates whether the chunk is the end of the entire row change.
This indicates if the chunk is the last chunk for the last column in an LCR.

Returns:

a boolean flag indicates if this is the end of row change.

setEmptyChunk

void setEmptyChunk(boolean emptyChunk)

Sets the empty chunk flag.
This flag indicates whether the chunk contains an empty LOB. For a LOB column, an empty LOB is different than a NULL value. Use this method to indicate whether this column contains an empty LOB.

Parameters:

emptyChunk - The empty chunk flag

setXMLDiff

void setXMLDiff(boolean xmlDiff)

Sets the XMLDiff flag.
This flag indicates whether the XMLType chunk is an XMLDiff.

Parameters:

xmlDiff - The XMLDiff flag

setLastChunk

void setLastChunk(boolean lastChunk)

Sets the last chunk flag.
This flag indicates whether the chunk is the last one for the current column.

Parameters:

lastChunk - The last chunk flag

setEndOfRow

void setEndOfRow(boolean endOfRow)

Sets the endOfRow chunk flag.
This flag indicates whether the chunk is the last one for the last column in an LCR, which also indicates the end of entire row change.

Parameters:

endOfRow - The endOfRow chunk flag

setCharSetId

void setCharSetId(int charSetId)

Sets the character set ID for an XMLTYPE chunk.
Check oracle.sql.CharacterSet for definition of Oracle CharacterSet ID.

Parameters:

charSetId - The character set id

Skip navigation links