RowResult

java.lang.Object
- org.apache.kudu.client.RowResult

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public abstract class RowResult
extends Object

RowResult represents one row from a scanner.

Field Summary

Fields
Modifier and Type Field and Description

protected int index

protected static int INDEX_RESET_LOCATION

protected Schema schema

Fields
Modifier and Type	Field and Description
`protected int`	`index`
`protected static int`	`INDEX_RESET_LOCATION`
`protected Schema`	`schema`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkNull(int columnIndex)`
`protected void`	`checkType(int columnIndex, Type... types)`
`protected void`	`checkValidColumn(int columnIndex)`
`abstract ByteBuffer`	`getBinary(int columnIndex)` Get the specified column's binary data.
`ByteBuffer`	`getBinary(String columnName)` Get the specified column's binary data.
`abstract byte[]`	`getBinaryCopy(int columnIndex)` Get a copy of the specified column's binary data.
`byte[]`	`getBinaryCopy(String columnName)` Get a copy of the specified column's binary data.
`abstract boolean`	`getBoolean(int columnIndex)` Get the specified column's boolean
`boolean`	`getBoolean(String columnName)` Get the specified column's boolean
`abstract byte`	`getByte(int columnIndex)` Get the specified column's byte
`byte`	`getByte(String columnName)` Get the specified column's byte
`Schema`	`getColumnProjection()` Get the schema used for this scanner's column projection.
`Type`	`getColumnType(int columnIndex)` Get the type of a column in this result.
`Type`	`getColumnType(String columnName)` Get the type of a column in this result.
`Date`	`getDate(int columnIndex)` Get the specified column's Date.
`Date`	`getDate(String columnName)` Get the specified column's Date.
`abstract BigDecimal`	`getDecimal(int columnIndex)` Get the specified column's Decimal.
`BigDecimal`	`getDecimal(String columnName)` Get the specified column's Decimal.
`abstract double`	`getDouble(int columnIndex)` Get the specified column's double
`double`	`getDouble(String columnName)` Get the specified column's double
`abstract float`	`getFloat(int columnIndex)` Get the specified column's float
`float`	`getFloat(String columnName)` Get the specified column's float
`abstract int`	`getInt(int columnIndex)` Get the specified column's integer
`int`	`getInt(String columnName)` Get the specified column's integer
`abstract long`	`getLong(int columnIndex)` Get the specified column's long If this is a UNIXTIME_MICROS column, the long value corresponds to a number of microseconds since midnight, January 1, 1970 UTC.
`long`	`getLong(String columnName)` Get the specified column's long If this is a UNIXTIME_MICROS column, the long value corresponds to a number of microseconds since midnight, January 1, 1970 UTC.
`Object`	`getObject(int columnIndex)` Get the specified column's value as an Object.
`Object`	`getObject(String columnName)` Get the specified column's value as an Object.
`Schema`	`getSchema()` Get the schema associated with this result.
`abstract short`	`getShort(int columnIndex)` Get the specified column's short
`short`	`getShort(String columnName)` Get the specified column's short
`String`	`getString(int columnIndex)` Get the specified column's string.
`String`	`getString(String columnName)` Get the specified column's string.
`abstract Timestamp`	`getTimestamp(int columnIndex)` Get the specified column's Timestamp.
`Timestamp`	`getTimestamp(String columnName)` Get the specified column's Timestamp.
`String`	`getVarchar(int columnIndex)` Get the specified column's varchar.
`String`	`getVarchar(String columnName)` Get the specified column's varchar.
`protected abstract String`	`getVarLengthData(int columnIndex)`
`abstract boolean`	`isNull(int columnIndex)` Get if the specified column is NULL
`boolean`	`isNull(String columnName)` Get if the specified column is NULL
`String`	`rowToString()` Return the actual data from this row in a stringified key=value form.
`String`	`toStringLongFormat()`

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

- Field Detail
  - INDEX_RESET_LOCATION
```
protected static final int INDEX_RESET_LOCATION
```
    See Also:
    
    Constant Field Values
  - index
```
protected int index
```
  - schema
```
protected final Schema schema
```
- Method Detail
  - getInt
```
public final int getInt(String columnName)
```
    Get the specified column's integer
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    an integer
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, or if the type doesn't match the column's type
  - getInt
```
public abstract int getInt(int columnIndex)
```
    Get the specified column's integer
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    an integer
    
    Throws:
    
    IllegalArgumentException - if the column is null or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getShort
```
public final short getShort(String columnName)
```
    Get the specified column's short
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a short
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, or if the type doesn't match the column's type
  - getShort
```
public abstract short getShort(int columnIndex)
```
    Get the specified column's short
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a short
    
    Throws:
    
    IllegalArgumentException - if the column is null or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getBoolean
```
public final boolean getBoolean(String columnName)
```
    Get the specified column's boolean
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a boolean
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, or if the type doesn't match the column's type
  - getBoolean
```
public abstract boolean getBoolean(int columnIndex)
```
    Get the specified column's boolean
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a boolean
    
    Throws:
    
    IllegalArgumentException - if the column is null or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getByte
```
public final byte getByte(String columnName)
```
    Get the specified column's byte
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a byte
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, or if the type doesn't match the column's type
  - getByte
```
public abstract byte getByte(int columnIndex)
```
    Get the specified column's byte
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a byte
    
    Throws:
    
    IllegalArgumentException - if the column is null or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getLong
```
public final long getLong(String columnName)
```
    Get the specified column's long If this is a UNIXTIME_MICROS column, the long value corresponds to a number of microseconds since midnight, January 1, 1970 UTC.
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a positive long
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist or is null
  - getLong
```
public abstract long getLong(int columnIndex)
```
    Get the specified column's long If this is a UNIXTIME_MICROS column, the long value corresponds to a number of microseconds since midnight, January 1, 1970 UTC.
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a positive long
    
    Throws:
    
    IllegalArgumentException - if the column is null
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getFloat
```
public final float getFloat(String columnName)
```
    Get the specified column's float
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a float
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, or if the type doesn't match the column's type
  - getFloat
```
public abstract float getFloat(int columnIndex)
```
    Get the specified column's float
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a float
    
    Throws:
    
    IllegalArgumentException - if the column is null or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getDouble
```
public final double getDouble(String columnName)
```
    Get the specified column's double
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a double
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, or if the type doesn't match the column's type
  - getDouble
```
public abstract double getDouble(int columnIndex)
```
    Get the specified column's double
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a double
    
    Throws:
    
    IllegalArgumentException - if the column is null or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getDecimal
```
public final BigDecimal getDecimal(String columnName)
```
    Get the specified column's Decimal.
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a BigDecimal
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist or is null
  - getDecimal
```
public abstract BigDecimal getDecimal(int columnIndex)
```
    Get the specified column's Decimal.
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a BigDecimal.
    
    Throws:
    
    IllegalArgumentException - if the column is null
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getTimestamp
```
public final Timestamp getTimestamp(String columnName)
```
    Get the specified column's Timestamp.
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a Timestamp
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type
  - getTimestamp
```
public abstract Timestamp getTimestamp(int columnIndex)
```
    Get the specified column's Timestamp.
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a Timestamp
    
    Throws:
    
    IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getDate
```
public final Date getDate(String columnName)
```
    Get the specified column's Date.
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a Date
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, is unset, or the type doesn't match the column's type
  - getDate
```
public final Date getDate(int columnIndex)
```
    Get the specified column's Date.
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a Date
    
    Throws:
    
    IllegalArgumentException - if the column is null, is unset, or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getColumnProjection
```
public final Schema getColumnProjection()
```
    Get the schema used for this scanner's column projection.
    
    Returns:
    
    a column projection as a schema.
  - getString
```
public final String getString(String columnName)
```
    Get the specified column's string.
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a string
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, or if the type doesn't match the column's type
  - getString
```
public final String getString(int columnIndex)
```
    Get the specified column's string.
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a string
    
    Throws:
    
    IllegalArgumentException - if the column is null or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getVarLengthData
```
protected abstract String getVarLengthData(int columnIndex)
```
  - getVarchar
```
public final String getVarchar(int columnIndex)
```
    Get the specified column's varchar.
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a string
    
    Throws:
    
    IllegalArgumentException - if the column is null or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getVarchar
```
public final String getVarchar(String columnName)
```
    Get the specified column's varchar.
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a string
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, or if the type doesn't match the column's type
  - getBinaryCopy
```
public final byte[] getBinaryCopy(String columnName)
```
    Get a copy of the specified column's binary data.
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a byte[] with the binary data.
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getBinaryCopy
```
public abstract byte[] getBinaryCopy(int columnIndex)
```
    Get a copy of the specified column's binary data.
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a byte[] with the binary data.
    
    Throws:
    
    IllegalArgumentException - if the column is null or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getBinary
```
public final ByteBuffer getBinary(String columnName)
```
    Get the specified column's binary data. This doesn't copy the data and instead returns a ByteBuffer that wraps it.
    
    Parameters:
    
    columnName - name of the column to get data for
    
    Returns:
    
    a ByteBuffer with the binary data.
    
    Throws:
    
    IllegalArgumentException - if the column doesn't exist, is null, or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getBinary
```
public abstract ByteBuffer getBinary(int columnIndex)
```
    Get the specified column's binary data. This doesn't copy the data and instead returns a ByteBuffer that wraps it.
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    a ByteBuffer with the binary data.
    
    Throws:
    
    IllegalArgumentException - if the column is null or if the type doesn't match the column's type
    
    IndexOutOfBoundsException - if the column doesn't exist
  - isNull
```
public final boolean isNull(String columnName)
```
    Get if the specified column is NULL
    
    Parameters:
    
    columnName - name of the column in the schema
    
    Returns:
    
    true if the column cell is null and the column is nullable, false otherwise
    
    Throws:
    
    IndexOutOfBoundsException - if the column doesn't exist
  - isNull
```
public abstract boolean isNull(int columnIndex)
```
    Get if the specified column is NULL
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    true if the column cell is null and the column is nullable, false otherwise
    
    Throws:
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getObject
```
public final Object getObject(String columnName)
```
    Get the specified column's value as an Object. This method is useful when you don't care about autoboxing and your existing type handling logic is based on Java types. The Object type is based on the column's Type: Type.BOOL -> java.lang.Boolean Type.INT8 -> java.lang.Byte Type.INT16 -> java.lang.Short Type.INT32 -> java.lang.Integer Type.INT64 -> java.lang.Long Type.UNIXTIME_MICROS -> java.sql.Timestamp Type.FLOAT -> java.lang.Float Type.DOUBLE -> java.lang.Double Type.VARCHAR -> java.lang.String Type.STRING -> java.lang.String Type.BINARY -> byte[] Type.DECIMAL -> java.math.BigDecimal
    
    Parameters:
    
    columnName - name of the column in the schema
    
    Returns:
    
    the column's value as an Object, null if the value is null
    
    Throws:
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getObject
```
public final Object getObject(int columnIndex)
```
    Get the specified column's value as an Object. This method is useful when you don't care about autoboxing and your existing type handling logic is based on Java types. The Object type is based on the column's Type: Type.BOOL -> java.lang.Boolean Type.INT8 -> java.lang.Byte Type.INT16 -> java.lang.Short Type.INT32 -> java.lang.Integer Type.INT64 -> java.lang.Long Type.UNIXTIME_MICROS -> java.sql.Timestamp Type.FLOAT -> java.lang.Float Type.DOUBLE -> java.lang.Double Type.VARCHAR -> java.lang.String Type.STRING -> java.lang.String Type.BINARY -> byte[] Type.DECIMAL -> java.math.BigDecimal Type.Date -> java.sql.Date
    
    Parameters:
    
    columnIndex - Column index in the schema
    
    Returns:
    
    the column's value as an Object, null if the value is null
    
    Throws:
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getColumnType
```
public final Type getColumnType(String columnName)
```
    Get the type of a column in this result.
    
    Parameters:
    
    columnName - name of the column
    
    Returns:
    
    a type
  - getColumnType
```
public final Type getColumnType(int columnIndex)
```
    Get the type of a column in this result.
    
    Parameters:
    
    columnIndex - column index in the schema
    
    Returns:
    
    a type
    
    Throws:
    
    IndexOutOfBoundsException - if the column doesn't exist
  - getSchema
```
public final Schema getSchema()
```
    Get the schema associated with this result.
    
    Returns:
    
    a schema
  - checkValidColumn
```
protected final void checkValidColumn(int columnIndex)
```
    Throws:
    
    IndexOutOfBoundsException - if the column doesn't exist
  - checkNull
```
protected final void checkNull(int columnIndex)
```
    Throws:
    
    IllegalArgumentException - if the column is null
  - checkType
```
protected final void checkType(int columnIndex,
                               Type... types)
```
  - rowToString
```
public String rowToString()
```
    Return the actual data from this row in a stringified key=value form.
  - toStringLongFormat
```
public String toStringLongFormat()
```
    Returns:
    
    a string describing the location of this row result within the iterator as well as its data.

Class RowResult

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INDEX_RESET_LOCATION

index

schema

Method Detail

getInt

getInt

getShort

getShort

getBoolean

getBoolean

getByte

getByte

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getDecimal

getDecimal

getTimestamp

getTimestamp

getDate

getDate

getColumnProjection

getString

getString

getVarLengthData

getVarchar

getVarchar

getBinaryCopy

getBinaryCopy

getBinary

getBinary

isNull

isNull

getObject

getObject

getColumnType

getColumnType

getSchema

checkValidColumn

checkNull

checkType

rowToString

toStringLongFormat