Cursor (Vertx Javadocs 4.0.3.GA API)

java.lang.Object
- io.vertx.db2client.impl.drda.Cursor

```
public class Cursor
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYTES`
`int[]`	`ccsid_`
`Charset[]`	`charset_`
`protected int[]`	`columnDataComputedLength_`
`protected ArrayList<boolean[]>`	`columnDataIsNullCache_`
`protected ArrayList<int[]>`	`columnDataLengthCache_`
`protected int[]`	`columnDataPosition_`
`protected ArrayList<int[]>`	`columnDataPositionCache_`
`int`	`columns_`
`protected int`	`currentRowPosition_`
`io.netty.buffer.ByteBuf`	`dataBuffer_`
`int[]`	`fdocaLength_`
`boolean`	`hasLobs_`
`boolean[]`	`isNull_`
`int[]`	`jdbcTypes_`
`int`	`lastValidBytePosition_`
`static int`	`NULL_TERMINATED_BYTES`
`static int`	`NULL_TERMINATED_STRING`
`boolean[]`	`nullable_`
`static int`	`STRING`
`static int`	`VARIABLE_SHORT_STRING`
`static int`	`VARIABLE_STRING`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`allocateCharBuffer()`
`boolean`	`allRowsReceivedFromServer()` Return `true` if all rows are received from the server.
`protected boolean`	`calculateColumnOffsetsForRow_(int rowIndex, boolean allowServerFetch)` Calculate the column offsets for a row.
`protected boolean`	`calculateColumnOffsetsForRow()`
`protected void`	`clearLobData_()`
`protected int`	`get_INTEGER(int column)`
`BigDecimal`	`getBigDecimal(int column)`
`Blob`	`getBlob(int column)`
`byte[]`	`getBytes(int column)`
`Clob`	`getClob(int column)`
`LocalDate`	`getDate(int column)`
`protected int`	`getDecimalLength(int index)`
`double`	`getDouble(int column)`
`float`	`getFloat(int column)`
`int`	`getInt(int column)`
`boolean`	`getIsRowUpdated()` Get updated status for this row.
`boolean`	`getIsUpdateDeleteHole()` Get deleted status for this row.
`long`	`getLong(int column)`
`protected void`	`getMoreData_()`
`Object`	`getObject(int column)`
`DB2RowId`	`getRowID(int column)`
`short`	`getShort(int column)`
`String`	`getString(int column)`
`LocalTime`	`getTime(int column)`
`Timestamp`	`getTimestamp(int column, Calendar cal)`
`void`	`incrementRowsReadEvent()`
`protected int`	`locator(int column)` Get locator for LOB of the designated column
`protected void`	`makeNextRowPositionCurrent()`
`protected void`	`markNextRowPosition()`
`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)`
`protected boolean`	`stepNext(boolean allowServerFetch)` Makes the next row the current row.

Methods inherited from class java.lang.Object
clone, equals, finalize, 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 io.netty.buffer.ByteBuf dataBuffer_
```
  - lastValidBytePosition_
```
public int lastValidBytePosition_
```
  - hasLobs_
```
public boolean hasLobs_
```
  - currentRowPosition_
```
protected int currentRowPosition_
```
  - columnDataPosition_
```
protected int[] columnDataPosition_
```
  - columnDataComputedLength_
```
protected int[] columnDataComputedLength_
```
  - columnDataPositionCache_
```
protected ArrayList<int[]> columnDataPositionCache_
```
  - columnDataLengthCache_
```
protected ArrayList<int[]> columnDataLengthCache_
```
  - columnDataIsNullCache_
```
protected ArrayList<boolean[]> columnDataIsNullCache_
```
  - jdbcTypes_
```
public int[] jdbcTypes_
```
  - columns_
```
public int columns_
```
  - nullable_
```
public boolean[] nullable_
```
  - charset_
```
public Charset[] charset_
```
  - isNull_
```
public boolean[] isNull_
```
  - fdocaLength_
```
public int[] fdocaLength_
```
  - ccsid_
```
public int[] ccsid_
```
- Method Detail
  - setNumberOfColumns
```
public void setNumberOfColumns(int numberOfColumns)
```
  - stepNext
```
protected boolean stepNext(boolean allowServerFetch)
```
    Makes the next row the current row. Returns true if the current row position is a valid row position.
    
    Parameters:
    
    allowServerFetch - if false, don't fetch more data from the server even if more data is needed
    
    Returns:
    
    true if current row position is valid
    
    Throws:
    
    SQLException - if an error occurs
  - next
```
public boolean next()
```
    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
  - 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)
  - markNextRowPosition
```
protected final void markNextRowPosition()
```
  - makeNextRowPositionCurrent
```
protected final void makeNextRowPositionCurrent()
```
  - incrementRowsReadEvent
```
public final void incrementRowsReadEvent()
```
  - get_INTEGER
```
protected final int get_INTEGER(int column)
```
  - getShort
```
public final short getShort(int column)
                     throws SQLException
```
    Throws:
    
    SQLException
  - getInt
```
public final int getInt(int column)
                 throws SQLException
```
    Throws:
    
    SQLException
  - getLong
```
public final long getLong(int column)
                   throws SQLException
```
    Throws:
    
    SQLException
  - getFloat
```
public final float getFloat(int column)
                     throws SQLException
```
    Throws:
    
    SQLException
  - getDouble
```
public final double getDouble(int column)
                       throws SQLException
```
    Throws:
    
    SQLException
  - getBigDecimal
```
public final BigDecimal getBigDecimal(int column)
                               throws SQLException
```
    Throws:
    
    SQLException
  - getDate
```
public final LocalDate getDate(int column)
```
  - getTime
```
public final LocalTime getTime(int column)
```
  - getTimestamp
```
public final Timestamp getTimestamp(int column,
                                    Calendar cal)
```
  - getString
```
public final String getString(int column)
```
  - getBytes
```
public final byte[] getBytes(int column)
```
  - getRowID
```
public final DB2RowId getRowID(int column)
```
  - getBlob
```
public final Blob getBlob(int column)
```
  - getClob
```
public final Clob getClob(int column)
```
  - getObject
```
public final Object getObject(int column)
```
  - allocateCharBuffer
```
public final void allocateCharBuffer()
```
  - calculateColumnOffsetsForRow_
```
protected boolean calculateColumnOffsetsForRow_(int rowIndex,
                                                boolean allowServerFetch)
```
    Calculate the column offsets for a row.
    Pseudo-code:
    1. parse thru the current row in dataBuffer computing column offsets
    2. 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 - row index
    
    allowServerFetch - if true, allow fetching more data from server
    
    Returns:
    
    true if the current row position is a valid row position.
  - clearLobData_
```
protected void clearLobData_()
```
  - locator
```
protected int locator(int column)
```
    Get locator for LOB of the designated column
    Note that this method cannot be invoked on a LOB column that is NULL.
    
    Parameters:
    
    column - column number, starts at 1
    
    Returns:
    
    locator value, Lob.INVALID_LOCATOR if LOB value was sent instead of locator
  - getMoreData_
```
protected void getMoreData_()
```
  - nullDataForGC
```
public void nullDataForGC()
```
  - getDecimalLength
```
protected int getDecimalLength(int index)
```
  - setAllRowsReceivedFromServer
```
public final 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
  - calculateColumnOffsetsForRow
```
protected boolean calculateColumnOffsetsForRow()
```

Class Cursor

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STRING

VARIABLE_STRING

VARIABLE_SHORT_STRING

NULL_TERMINATED_STRING

BYTES

NULL_TERMINATED_BYTES

dataBuffer_

lastValidBytePosition_

hasLobs_

currentRowPosition_

columnDataPosition_

columnDataComputedLength_

columnDataPositionCache_

columnDataLengthCache_

columnDataIsNullCache_

jdbcTypes_

columns_

nullable_

charset_

isNull_

fdocaLength_

ccsid_

Method Detail

setNumberOfColumns

stepNext

next

allRowsReceivedFromServer

resetDataBuffer

setIsUpdataDeleteHole

setIsRowUpdated

getIsRowUpdated

getIsUpdateDeleteHole

markNextRowPosition

makeNextRowPositionCurrent

incrementRowsReadEvent

get_INTEGER

getShort

getInt

getLong

getFloat

getDouble

getBigDecimal

getDate

getTime

getTimestamp

getString

getBytes

getRowID

getBlob

getClob

getObject

allocateCharBuffer

calculateColumnOffsetsForRow_

clearLobData_

locator

getMoreData_

nullDataForGC

getDecimalLength

setAllRowsReceivedFromServer

calculateColumnOffsetsForRow