Apache Derby Client JDBC Driver 10.17.1.0 · org.apache.derby.client.net.NetCursor

Modifier and Type	Field and Description
pack-priv boolean	blocking_
pack-priv ArrayList<byte[]>	extdtaData_ Queue to hold EXTDTA data that hasn't been correlated to its column number.
pack-priv HashMap<Integer, Integer>	extdtaPositions_
pack-priv boolean[]	isGraphic_
pack-priv int	maximumRowSize_
private NetAgent	netAgent_
pack-priv NetResultSet	netResultSet_
private boolean	qryclsimpEnabled_ Flag indicating whether the result set on the server is implicitly closed when end-of-data is received.
pack-priv Typdef	qrydscTypdef_
pack-priv boolean	rtnextrow_
pack-priv int[]	typeToUseForComputingDataLength_

Access	Constructor and Description
pack-priv	NetCursor(NetAgent netAgent)
pack-priv	NetCursor(NetAgent netAgent, int qryprctyp)

Method Summary

Modifier and Type	Method and Description
private void	adjustColumnOffsetsForColumnsPreviouslyCalculated(int the index of the column that was split, or -1 when not fetching column data index) Adjust column offsets after fetching the next part of a split row.
private int[]	allocateColumnDataComputedLengthArray(int row)
private boolean[]	allocateColumnDataIsNullArray(int row)
private int[]	allocateColumnDataPositionArray(int row)
pack-priv void	allocateColumnOffsetAndLengthArrays()
protected boolean	Returns: `true` if the current row position is a valid row position. calculateColumnOffsetsForRow_(int row index rowIndex, boolean if true, allow fetching more data from server allowServerFetch) Implements abstract org.apache.derby.client.am.Cursor.calculateColumnOffsetsForRow_. Calculate the column offsets for a row.
pack-priv void	calculateLobColumnPositionsForRow()
private void	checkAndThrowReceivedEndqryrm()
private void	checkAndThrowReceivedEndqryrm(int lastValidBytePositionBeforeFetch)
private void	checkForSplitRowAndComplete(int the length in bytes of the data needed length, int the index of the column to be fetched, or -1 when not fetching column data index) Check if the data we want crosses a row split, and fetch more data if necessary.
private void	checkForSplitRowAndComplete(int the length in bytes of the data needed length) Check if the data we want crosses a row split, and fetch more data if necessary.
protected void	clearLobData_() Implements abstract org.apache.derby.client.am.Cursor.clearLobData_.
private int	Returns: the value of `lastValidBytePosition_` before more data was fetched completeSplitRow(int the index of the column that was split, or -1 when not fetching column data index) Fetch more data for a row that has been split up.
private byte[]	findExtdtaData(int column)
public ClientBlob	getBlobColumn_(int 1-based column index column, Agent associated agent agent, boolean whether the Blob will be published to the user toBePublished) Implements abstract org.apache.derby.client.am.Cursor.getBlobColumn_. Returns a `Blob` object.
public ClientClob	getClobColumn_(int 1-based column index column, Agent associated agent agent, boolean whether the Clob will be published to the user toBePublished) Implements abstract org.apache.derby.client.am.Cursor.getClobColumn_. Returns a `Clob` object.
protected int	getDecimalLength(int index)
protected void	getMoreData_() Implements abstract org.apache.derby.client.am.Cursor.getMoreData_.
pack-priv final boolean	Returns: true if QRYCLSIMP is enabled getQryclsimpEnabled() Check whether QRYCLSIMP is enabled on this cursor.
pack-priv void	initializeColumnInfoArrays(Typdef typdef, int columnCount)
private boolean	isNonTrivialDataLob(int index)
protected int	Returns: locator value, `Lob.INVALID_LOCATOR` if LOB value was sent instead of locator locator(int column number, starts at 1 column) Implements abstract org.apache.derby.client.am.Cursor.locator. Get locator for LOB of the designated column Note that this method cannot be invoked on a LOB column that is NULL.
public void	nullDataForGC() Overrides org.apache.derby.client.am.Cursor.nullDataForGC.
private NetSqlca[]	parseSQLCAGRP(Typdef typdef)
private NetSqlca[]	parseSQLCARD(Typdef typdef)
private void	parseSQLCAXGRP(Typdef typdef, NetSqlca netSqlca)
private NetSqlca	parseSQLDCGRP()
private NetSqlca	parseSQLDCROW()
private void	parseSQLDCTOKS()
private void	parseSQLDCXGRP()
private NetSqlca[]	parseSQLDIAGCI()
private void	parseSQLDIAGCN()
private NetSqlca[]	parseSQLDIAGGRP()
private void	parseSQLDIAGSTT()
private String	parseVCS(Typdef typdefInEffect)
private byte[]	readFdocaBytes(int length)
private int	readFdocaInt()
private int	readFdocaOneByte()
private int	readFdocaOneByte(int index)
private String	readFdocaString(int length, Charset encoding)
private int	readFdocaTwoByteLength()
private int	readFdocaTwoByteLength(int index)
private void	resetCurrentRowPosition()
pack-priv void	scanDataBufferForEndOfData() Scan the data buffer to see if end of data (SQL state 02000) has been received.
public final void	setAllRowsReceivedFromServer(boolean a `boolean` value indicating whether all rows are received from the server b) Overrides org.apache.derby.client.am.Cursor.setAllRowsReceivedFromServer. Set the value of value of allRowsReceivedFromServer_.
pack-priv final void	setQryclsimpEnabled(boolean true if QRYCLSIMP is enabled flag) Set a flag indicating whether QRYCLSIMP is enabled.
private void	shiftPartialRowToBeginning()
private int	skipFdocaBytes(int length)
private int	skipFdocaBytes(int length, int index)

Inherited from org.apache.derby.client.am.Cursor:: allocateCharBuffer allRowsReceivedFromServer get_INTEGER getIsRowUpdated getIsUpdateDeleteHole incrementRowsReadEvent makeNextRowPositionCurrent markNextRowPosition next resetDataBuffer setIsRowUpdated setIsUpdataDeleteHole setNumberOfColumns stepNext

blocking_	back to summary
pack-priv boolean blocking_

extdtaData_	back to summary
pack-priv ArrayList<byte[]> extdtaData_ Queue to hold EXTDTA data that hasn't been correlated to its column number.

extdtaPositions_	back to summary
pack-priv HashMap<Integer, Integer> extdtaPositions_

isGraphic_	back to summary
pack-priv boolean[] isGraphic_

maximumRowSize_	back to summary
pack-priv int maximumRowSize_

netAgent_	back to summary
private NetAgent netAgent_

netResultSet_	back to summary
pack-priv NetResultSet netResultSet_

qryclsimpEnabled_	back to summary
private boolean qryclsimpEnabled_ Flag indicating whether the result set on the server is implicitly closed when end-of-data is received.

qrydscTypdef_	back to summary
pack-priv Typdef qrydscTypdef_

rtnextrow_	back to summary
pack-priv boolean rtnextrow_

typeToUseForComputingDataLength_	back to summary
pack-priv int[] typeToUseForComputingDataLength_

NetCursor	back to summary
pack-priv NetCursor(NetAgent netAgent)

NetCursor	back to summary
pack-priv NetCursor(NetAgent netAgent, int qryprctyp)

Method Detail

adjustColumnOffsetsForColumnsPreviouslyCalculated	back to summary
private void adjustColumnOffsetsForColumnsPreviouslyCalculated(int index) Adjust column offsets after fetching the next part of a split row. Parameters index:int the index of the column that was split, or -1 when not fetching column data

adjustColumnOffsetsForColumnsPreviouslyCalculated

back to summary

private void adjustColumnOffsetsForColumnsPreviouslyCalculated(int index)

Adjust column offsets after fetching the next part of a split row.

Parameters

index:int: the index of the column that was split, or -1 when not fetching column data

allocateColumnDataComputedLengthArray	back to summary
private int[] allocateColumnDataComputedLengthArray(int row)

allocateColumnDataIsNullArray	back to summary
private boolean[] allocateColumnDataIsNullArray(int row)

allocateColumnDataPositionArray	back to summary
private int[] allocateColumnDataPositionArray(int row)

allocateColumnOffsetAndLengthArrays	back to summary
pack-priv void allocateColumnOffsetAndLengthArrays()

calculateColumnOffsetsForRow_ back to summary

calculateColumnOffsetsForRow_	back to summary
protected boolean calculateColumnOffsetsForRow_(int rowIndex, boolean allowServerFetch) throws SqlException, DisconnectException Implements abstract org.apache.derby.client.am.Cursor.calculateColumnOffsetsForRow_. Calculate the column offsets for a row. Pseudo-code: parse thru the current row in dataBuffer computing column offsets if (we hit the super.lastValidBytePosition, ie. encounter partial row) shift partial row bytes to beginning of dataBuffer (this.shiftPartialRowToBeginning()) reset current row position (also done by this.shiftPartialRowToBeginning()) send and recv continue-query into commBuffer (rs.flowContinueQuery()) parse commBuffer up to QRYDTA (rs.flowContinueQuery()) copy query data from reply's commBuffer to our dataBuffer (this.copyQrydta()) Parameters rowIndex:int row index allowServerFetch:boolean if true, allow fetching more data from server Returns:boolean `true` if the current row position is a valid row position. Exceptions SqlException: Doc from org.apache.derby.client.am.Cursor.calculateColumnOffsetsForRow_. on error DisconnectException: Doc from org.apache.derby.client.am.Cursor.calculateColumnOffsetsForRow_. on error

protected boolean calculateColumnOffsetsForRow_(int rowIndex, boolean allowServerFetch) throws SqlException, DisconnectException

Implements abstract org.apache.derby.client.am.Cursor.calculateColumnOffsetsForRow_.

Calculate the column offsets for a row.

Pseudo-code:

parse thru the current row in dataBuffer computing column offsets
if (we hit the super.lastValidBytePosition, ie. encounter partial row)
1. shift partial row bytes to beginning of dataBuffer (this.shiftPartialRowToBeginning())
2. reset current row position (also done by this.shiftPartialRowToBeginning())
3. send and recv continue-query into commBuffer (rs.flowContinueQuery())
4. parse commBuffer up to QRYDTA (rs.flowContinueQuery())
5. copy query data from reply's commBuffer to our dataBuffer (this.copyQrydta())

Parameters

rowIndex:int: row index
allowServerFetch:boolean: if true, allow fetching more data from server

Returns:boolean

true if the current row position is a valid row position.

Exceptions

SqlException:

Doc from org.apache.derby.client.am.Cursor.calculateColumnOffsetsForRow_.

on error

DisconnectException:

Doc from org.apache.derby.client.am.Cursor.calculateColumnOffsetsForRow_.

on error

calculateLobColumnPositionsForRow	back to summary
pack-priv void calculateLobColumnPositionsForRow()

checkAndThrowReceivedEndqryrm	back to summary
private void checkAndThrowReceivedEndqryrm() throws SqlException

checkAndThrowReceivedEndqryrm	back to summary
private void checkAndThrowReceivedEndqryrm(int lastValidBytePositionBeforeFetch) throws SqlException

checkForSplitRowAndComplete	back to summary
private void checkForSplitRowAndComplete(int length, int index) throws SqlException Check if the data we want crosses a row split, and fetch more data if necessary. Parameters length:int the length in bytes of the data needed index:int the index of the column to be fetched, or -1 when not fetching column data

checkForSplitRowAndComplete

back to summary

private void checkForSplitRowAndComplete(int length, int index) throws SqlException

Check if the data we want crosses a row split, and fetch more data if necessary.

Parameters

length:int: the length in bytes of the data needed
index:int: the index of the column to be fetched, or -1 when not fetching column data

checkForSplitRowAndComplete back to summary

checkForSplitRowAndComplete	back to summary
private void checkForSplitRowAndComplete(int length) throws SqlException Check if the data we want crosses a row split, and fetch more data if necessary. This method is not for column data; use `checkForSplitRowAndComplete(int, int)` for that. Parameters length:int the length in bytes of the data needed

private void checkForSplitRowAndComplete(int length) throws SqlException

Check if the data we want crosses a row split, and fetch more data if necessary. This method is not for column data; use checkForSplitRowAndComplete(int, int) for that.

Parameters

length:int: the length in bytes of the data needed

clearLobData_	back to summary
protected void clearLobData_() Implements abstract org.apache.derby.client.am.Cursor.clearLobData_.

completeSplitRow back to summary

completeSplitRow	back to summary
private int completeSplitRow(int index) throws DisconnectException, SqlException Fetch more data for a row that has been split up. Parameters index:int the index of the column that was split, or -1 when not fetching column data Returns:int the value of `lastValidBytePosition_` before more data was fetched

private int completeSplitRow(int index) throws DisconnectException, SqlException

Fetch more data for a row that has been split up.

Parameters

index:int: the index of the column that was split, or -1 when not fetching column data

Returns:int

the value of lastValidBytePosition_ before more data was fetched

findExtdtaData	back to summary
private byte[] findExtdtaData(int column)

getBlobColumn_ back to summary

getBlobColumn_	back to summary
public ClientBlob getBlobColumn_(int column, Agent agent, boolean toBePublished) throws SqlException Implements abstract org.apache.derby.client.am.Cursor.getBlobColumn_. Doc from org.apache.derby.client.am.Cursor.getBlobColumn_. Returns a `Blob` object. Parameters column:int 1-based column index agent:Agent associated agent toBePublished:boolean whether the Blob will be published to the user Returns:ClientBlob A Blob object. Exceptions SqlException: if getting the `Blob` fails See Also `org.apache.derby.client.am.Cursor#getBlobColumn_`

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

Implements abstract org.apache.derby.client.am.Cursor.getBlobColumn_.

Doc from org.apache.derby.client.am.Cursor.getBlobColumn_.

Returns a Blob object.

Parameters

column:int: 1-based column index
agent:Agent: associated agent
toBePublished:boolean: whether the Blob will be published to the user

Returns:ClientBlob

A Blob object.

Exceptions

SqlException:: if getting the Blob fails

getClobColumn_ back to summary

getClobColumn_	back to summary
public ClientClob getClobColumn_(int column, Agent agent, boolean toBePublished) throws SqlException Implements abstract org.apache.derby.client.am.Cursor.getClobColumn_. Doc from org.apache.derby.client.am.Cursor.getClobColumn_. Returns a `Clob` object. Parameters column:int 1-based column index agent:Agent associated agent toBePublished:boolean whether the Clob will be published to the user Returns:ClientClob A `java.sql.Clob` object. Exceptions SqlException: if getting the `Clob` fails See Also `org.apache.derby.client.am.Cursor#getClobColumn_`

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

Implements abstract org.apache.derby.client.am.Cursor.getClobColumn_.

Doc from org.apache.derby.client.am.Cursor.getClobColumn_.

Returns a Clob object.

Parameters

column:int: 1-based column index
agent:Agent: associated agent
toBePublished:boolean: whether the Clob will be published to the user

Returns:ClientClob

A java.sql.Clob object.

Exceptions

SqlException:: if getting the Clob fails

getDecimalLength	back to summary
protected int getDecimalLength(int index)

getMoreData_	back to summary
protected void getMoreData_() throws SqlException Implements abstract org.apache.derby.client.am.Cursor.getMoreData_.

getQryclsimpEnabled	back to summary
pack-priv final boolean getQryclsimpEnabled() Check whether QRYCLSIMP is enabled on this cursor. Returns:boolean true if QRYCLSIMP is enabled

getQryclsimpEnabled

back to summary

pack-priv final boolean getQryclsimpEnabled()

Check whether QRYCLSIMP is enabled on this cursor.

Returns:boolean: true if QRYCLSIMP is enabled

initializeColumnInfoArrays	back to summary
pack-priv void initializeColumnInfoArrays(Typdef typdef, int columnCount) throws DisconnectException

isNonTrivialDataLob	back to summary
private boolean isNonTrivialDataLob(int index)

locator back to summary

locator	back to summary
protected int locator(int column) Implements abstract org.apache.derby.client.am.Cursor.locator. Get locator for LOB of the designated column Note that this method cannot be invoked on a LOB column that is NULL. Parameters column:int column number, starts at 1 Returns:int locator value, `Lob.INVALID_LOCATOR` if LOB value was sent instead of locator

protected int locator(int column)

Implements abstract org.apache.derby.client.am.Cursor.locator.

Get locator for LOB of the designated column

Note that this method cannot be invoked on a LOB column that is NULL.

Parameters

column:int: column number, starts at 1

Returns:int

locator value, Lob.INVALID_LOCATOR if LOB value was sent instead of locator

nullDataForGC	back to summary
public void nullDataForGC() Overrides org.apache.derby.client.am.Cursor.nullDataForGC.

parseSQLCAGRP	back to summary
private NetSqlca[] parseSQLCAGRP(Typdef typdef) throws DisconnectException, SqlException

parseSQLCARD	back to summary
private NetSqlca[] parseSQLCARD(Typdef typdef) throws DisconnectException, SqlException

parseSQLCAXGRP	back to summary
private void parseSQLCAXGRP(Typdef typdef, NetSqlca netSqlca) throws DisconnectException, SqlException

parseSQLDCGRP	back to summary
private NetSqlca parseSQLDCGRP() throws DisconnectException, SqlException

parseSQLDCROW	back to summary
private NetSqlca parseSQLDCROW() throws DisconnectException, SqlException

parseSQLDCTOKS	back to summary
private void parseSQLDCTOKS() throws DisconnectException, SqlException

parseSQLDCXGRP	back to summary
private void parseSQLDCXGRP() throws DisconnectException, SqlException

parseSQLDIAGCI	back to summary
private NetSqlca[] parseSQLDIAGCI() throws DisconnectException, SqlException

parseSQLDIAGCN	back to summary
private void parseSQLDIAGCN() throws DisconnectException, SqlException

parseSQLDIAGGRP	back to summary
private NetSqlca[] parseSQLDIAGGRP() throws DisconnectException, SqlException

parseSQLDIAGSTT	back to summary
private void parseSQLDIAGSTT() throws DisconnectException, SqlException

parseVCS	back to summary
private String parseVCS(Typdef typdefInEffect) throws DisconnectException, SqlException

readFdocaBytes	back to summary
private byte[] readFdocaBytes(int length) throws DisconnectException, SqlException

readFdocaInt	back to summary
private int readFdocaInt() throws DisconnectException, SqlException

readFdocaOneByte	back to summary
private int readFdocaOneByte() throws DisconnectException, SqlException

readFdocaOneByte	back to summary
private int readFdocaOneByte(int index) throws DisconnectException, SqlException

readFdocaString	back to summary
private String readFdocaString(int length, Charset encoding) throws SqlException

readFdocaTwoByteLength	back to summary
private int readFdocaTwoByteLength() throws DisconnectException, SqlException

readFdocaTwoByteLength	back to summary
private int readFdocaTwoByteLength(int index) throws DisconnectException, SqlException

resetCurrentRowPosition	back to summary
private void resetCurrentRowPosition()

scanDataBufferForEndOfData	back to summary
pack-priv void scanDataBufferForEndOfData() throws SqlException Scan the data buffer to see if end of data (SQL state 02000) has been received. This method should only be called when the cursor is being closed since the pointer to the current row can be modified.

setAllRowsReceivedFromServer back to summary

public final void setAllRowsReceivedFromServer(boolean b)

Overrides org.apache.derby.client.am.Cursor.setAllRowsReceivedFromServer.

Set the value of value of allRowsReceivedFromServer_.

Parameters

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

setQryclsimpEnabled

back to summary

pack-priv final void setQryclsimpEnabled(boolean flag)

Set a flag indicating whether QRYCLSIMP is enabled.

Parameters

flag:boolean: true if QRYCLSIMP is enabled

shiftPartialRowToBeginning	back to summary
private void shiftPartialRowToBeginning()

skipFdocaBytes	back to summary
private int skipFdocaBytes(int length) throws DisconnectException, SqlException

skipFdocaBytes	back to summary
private int skipFdocaBytes(int length, int index) throws DisconnectException, SqlException

pack-priv Class NetCursor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail