org.apache.derby.client.am

Class Cursor

java.lang.Object

org.apache.derby.client.am.Cursor

public abstract class Cursor
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	BYTES
int[]	ccsid_
java.nio.charset.Charset[]	charset_
int	columns_
byte[]	dataBuffer_
java.io.ByteArrayOutputStream	dataBufferStream_
int[]	fdocaLength_
boolean	hasLobs_
boolean[]	isNull_
int[]	jdbcTypes_
int	lastValidBytePosition_
static int	NULL_TERMINATED_BYTES
static int	NULL_TERMINATED_STRING
boolean[]	nullable_
int	position_
static int	STRING
static int	VARIABLE_SHORT_STRING
static int	VARIABLE_STRING

Constructor Summary

Constructors

Constructor and Description
Cursor(Agent agent)

Method Summary

Modifier and Type	Method and Description
void	allocateCharBuffer()
boolean	allRowsReceivedFromServer() Return true if all rows are received from the server.
abstract ClientBlob	getBlobColumn_(int column, Agent agent, boolean toBePublished) Returns a Blob object.
abstract ClientClob	getClobColumn_(int column, Agent agent, boolean toBePublished) Returns a Clob object.
boolean	getIsRowUpdated() Get updated status for this row.
boolean	getIsUpdateDeleteHole() Get deleted status for this row.
void	incrementRowsReadEvent()
boolean	next() Makes the next row the current row.
void	nullDataForGC()
void	resetDataBuffer()
void	setAllRowsReceivedFromServer(boolean b) Set the value of value of allRowsReceivedFromServer_.
void	setIsRowUpdated(boolean isRowUpdated) Keep track of updated status for this row.
void	setIsUpdataDeleteHole(int row, boolean isRowNull)
void	setNumberOfColumns(int numberOfColumns)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STRING

public static final int STRING

See Also:

Constant Field Values

VARIABLE_STRING

public static final int VARIABLE_STRING

See Also:

Constant Field Values

VARIABLE_SHORT_STRING

public static final int VARIABLE_SHORT_STRING

See Also:

Constant Field Values

NULL_TERMINATED_STRING

public static final int NULL_TERMINATED_STRING

See Also:

Constant Field Values

BYTES

public static final int BYTES

See Also:

Constant Field Values

NULL_TERMINATED_BYTES

public static final int NULL_TERMINATED_BYTES

See Also:

Constant Field Values

dataBuffer_

public byte[] dataBuffer_

dataBufferStream_

public java.io.ByteArrayOutputStream dataBufferStream_

position_

public int position_

lastValidBytePosition_

public int lastValidBytePosition_

hasLobs_

public boolean hasLobs_

jdbcTypes_

public int[] jdbcTypes_

columns_

public int columns_

nullable_

public boolean[] nullable_

charset_

public java.nio.charset.Charset[] charset_

isNull_

public boolean[] isNull_

fdocaLength_

public int[] fdocaLength_

ccsid_

public int[] ccsid_

Constructor Detail

Cursor

public Cursor(Agent agent)

Method Detail

setNumberOfColumns

public void setNumberOfColumns(int numberOfColumns)

next

public boolean next()
             throws SqlException

Makes the next row the current row. Returns true if the current row position is a valid row position.

Returns:

true if current row position is valid

Throws:

SqlException - if an error occurs

setAllRowsReceivedFromServer

public void setAllRowsReceivedFromServer(boolean b)

Set the value of value of allRowsReceivedFromServer_.

Parameters:

b - a boolean value indicating whether all rows are received from the server

allRowsReceivedFromServer

public final boolean allRowsReceivedFromServer()

Return true if all rows are received from the server.

Returns:

true if all rows are received from the server.

resetDataBuffer

public final void resetDataBuffer()

setIsUpdataDeleteHole

public final void setIsUpdataDeleteHole(int row,
                                        boolean isRowNull)

setIsRowUpdated

public final void setIsRowUpdated(boolean isRowUpdated)

Keep track of updated status for this row.

Parameters:

isRowUpdated - true if row has been updated

See Also:

getIsRowUpdated()

getIsRowUpdated

public final boolean getIsRowUpdated()

Get updated status for this row. Minion of ResultSet#rowUpdated.

See Also:

setIsRowUpdated(boolean)

getIsUpdateDeleteHole

public final boolean getIsUpdateDeleteHole()

Get deleted status for this row. Minion of ResultSet#rowDeleted.

See Also:

setIsUpdataDeleteHole(int, boolean)

incrementRowsReadEvent

public final void incrementRowsReadEvent()

getBlobColumn_

public abstract ClientBlob getBlobColumn_(int column,
                                          Agent agent,
                                          boolean toBePublished)
                                   throws SqlException

Returns a Blob object.

Parameters:

column - 1-based column index

agent - associated agent

toBePublished - whether the Blob will be published to the user

Returns:

A Blob object.

Throws:

SqlException - if getting the Blob fails

getClobColumn_

public abstract ClientClob getClobColumn_(int column,
                                          Agent agent,
                                          boolean toBePublished)
                                   throws SqlException

Returns a Clob object.

Parameters:

column - 1-based column index

agent - associated agent

toBePublished - whether the Clob will be published to the user

Returns:

A java.sql.Clob object.

Throws:

SqlException - if getting the Clob fails

allocateCharBuffer

public final void allocateCharBuffer()

nullDataForGC

public void nullDataForGC()