org.apache.kudu.client

Class RowResult

java.lang.Object

org.apache.kudu.client.RowResult

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

RowResult represents one row from a scanner. Do not reuse or store the objects.

Method Summary

Modifier and Type	Method and Description
ByteBuffer	getBinary(int columnIndex) Get the specified column's binary data.
ByteBuffer	getBinary(String columnName) Get the specified column's binary data.
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.
boolean	getBoolean(int columnIndex) Get the specified column's boolean
boolean	getBoolean(String columnName) Get the specified column's boolean
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.
BigDecimal	getDecimal(int columnIndex) Get the specified column's Decimal.
BigDecimal	getDecimal(String columnName) Get the specified column's Decimal.
double	getDouble(int columnIndex) Get the specified column's double
double	getDouble(String columnName) Get the specified column's double
float	getFloat(int columnIndex) Get the specified column's float
float	getFloat(String columnName) Get the specified column's float
int	getInt(int columnIndex) Get the specified column's integer
int	getInt(String columnName) Get the specified column's integer
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.
Schema	getSchema() Get the schema associated with this result.
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.
Timestamp	getTimestamp(int columnIndex) Get the specified column's Timestamp.
Timestamp	getTimestamp(String columnName) Get the specified column's Timestamp.
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	toString()
String	toStringLongFormat()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInt

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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

getColumnProjection

public Schema getColumnProjection()

Get the schema used for this scanner's column projection.

Returns:

a column projection as a schema.

getString

public 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 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

getBinaryCopy

public 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 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 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 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 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 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

getColumnType

public Type getColumnType(String columnName)

Get the type of a column in this result.

Parameters:

columnName - name of the column

Returns:

a type

getColumnType

public 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 Schema getSchema()

Get the schema associated with this result.

Returns:

a schema

toString

public String toString()

Overrides:

toString in class Object

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.