GenericRow (Paimon : 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.paimon.data.GenericRow

All Implemented Interfaces:

Serializable, DataGetters, InternalRow
```
@Public
public final class GenericRow
extends Object
implements InternalRow, Serializable
```
An internal data structure representing data of RowType.
GenericRow is a generic implementation of InternalRow which is backed by an array of Java Object. A GenericRow can have an arbitrary number of fields of different types. The fields in a row can be accessed by position (0-based) using either the generic getField(int) or type-specific getters (such as getInt(int)). A field can be updated by the generic setField(int, Object).
Note: All fields of this data structure must be internal data structures. See InternalRow for more information about internal data structures.
The fields in GenericRow can be null for representing nullability.

Since:

0.4.0

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.paimon.data.InternalRow
  InternalRow.FieldGetter

Constructor Summary

Constructors
Constructor and Description
`GenericRow(int arity)` Creates an instance of `GenericRow` with given number of fields.
`GenericRow(RowKind kind, int arity)` Creates an instance of `GenericRow` with given kind and number of fields.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`InternalArray`	`getArray(int pos)` Returns the array value at the given position.
`byte[]`	`getBinary(int pos)` Returns the binary value at the given position.
`boolean`	`getBoolean(int pos)` Returns the boolean value at the given position.
`byte`	`getByte(int pos)` Returns the byte value at the given position.
`Decimal`	`getDecimal(int pos, int precision, int scale)` Returns the decimal value at the given position.
`double`	`getDouble(int pos)` Returns the double value at the given position.
`Object`	`getField(int pos)` Returns the field value at the given position.
`int`	`getFieldCount()` Returns the number of fields in this row.
`float`	`getFloat(int pos)` Returns the float value at the given position.
`int`	`getInt(int pos)` Returns the integer value at the given position.
`long`	`getLong(int pos)` Returns the long value at the given position.
`InternalMap`	`getMap(int pos)` Returns the map value at the given position.
`InternalRow`	`getRow(int pos, int numFields)` Returns the row value at the given position.
`RowKind`	`getRowKind()` Returns the kind of change that this row describes in a changelog.
`short`	`getShort(int pos)` Returns the short value at the given position.
`BinaryString`	`getString(int pos)` Returns the string value at the given position.
`Timestamp`	`getTimestamp(int pos, int precision)` Returns the timestamp value at the given position.
`int`	`hashCode()`
`boolean`	`isNullAt(int pos)` Returns true if the element is null at the given position.
`static GenericRow`	`of(Object... values)` Creates an instance of `GenericRow` with given field values.
`static GenericRow`	`ofKind(RowKind kind, Object... values)` Creates an instance of `GenericRow` with given kind and field values.
`void`	`setField(int pos, Object value)` Sets the field value at the given position.
`void`	`setRowKind(RowKind kind)` Sets the kind of change that this row describes in a changelog.
`String`	`toString()`

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

Methods inherited from interface org.apache.paimon.data.InternalRow
createFieldGetter, getDataClass

- Constructor Detail
  - GenericRow
```
public GenericRow(RowKind kind,
                  int arity)
```
    Creates an instance of GenericRow with given kind and number of fields.
    Initially, all fields are set to null.
    Note: All fields of the row must be internal data structures.
    
    Parameters:
    
    kind - kind of change that this row describes in a changelog
    
    arity - number of fields
  - GenericRow
```
public GenericRow(int arity)
```
    Creates an instance of GenericRow with given number of fields.
    Initially, all fields are set to null. By default, the row describes a RowKind.INSERT in a changelog.
    Note: All fields of the row must be internal data structures.
    
    Parameters:
    
    arity - number of fields
- Method Detail
  - setField
```
public void setField(int pos,
                     Object value)
```
    Sets the field value at the given position.
    Note: The given field value must be an internal data structures. Otherwise the GenericRow is corrupted and may throw exception when processing. See InternalRow for more information about internal data structures.
    The field value can be null for representing nullability.
  - getField
```
public Object getField(int pos)
```
    Returns the field value at the given position.
    Note: The returned value is in internal data structure. See InternalRow for more information about internal data structures.
    The returned field value can be null for representing nullability.
  - getFieldCount
```
public int getFieldCount()
```
    Description copied from interface: InternalRow
    
    Returns the number of fields in this row.
    The number does not include RowKind. It is kept separately.
    
    Specified by:
    
    getFieldCount in interface InternalRow
  - getRowKind
```
public RowKind getRowKind()
```
    Description copied from interface: InternalRow
    
    Returns the kind of change that this row describes in a changelog.
    
    Specified by:
    
    getRowKind in interface InternalRow
    
    See Also:
    
    RowKind
  - setRowKind
```
public void setRowKind(RowKind kind)
```
    Description copied from interface: InternalRow
    
    Sets the kind of change that this row describes in a changelog.
    
    Specified by:
    
    setRowKind in interface InternalRow
    
    See Also:
    
    RowKind
  - isNullAt
```
public boolean isNullAt(int pos)
```
    Description copied from interface: DataGetters
    
    Returns true if the element is null at the given position.
    
    Specified by:
    
    isNullAt in interface DataGetters
  - getBoolean
```
public boolean getBoolean(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the boolean value at the given position.
    
    Specified by:
    
    getBoolean in interface DataGetters
  - getByte
```
public byte getByte(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the byte value at the given position.
    
    Specified by:
    
    getByte in interface DataGetters
  - getShort
```
public short getShort(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the short value at the given position.
    
    Specified by:
    
    getShort in interface DataGetters
  - getInt
```
public int getInt(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the integer value at the given position.
    
    Specified by:
    
    getInt in interface DataGetters
  - getLong
```
public long getLong(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the long value at the given position.
    
    Specified by:
    
    getLong in interface DataGetters
  - getFloat
```
public float getFloat(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the float value at the given position.
    
    Specified by:
    
    getFloat in interface DataGetters
  - getDouble
```
public double getDouble(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the double value at the given position.
    
    Specified by:
    
    getDouble in interface DataGetters
  - getString
```
public BinaryString getString(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the string value at the given position.
    
    Specified by:
    
    getString in interface DataGetters
  - getDecimal
```
public Decimal getDecimal(int pos,
                          int precision,
                          int scale)
```
    Description copied from interface: DataGetters
    
    Returns the decimal value at the given position.
    The precision and scale are required to determine whether the decimal value was stored in a compact representation (see Decimal).
    
    Specified by:
    
    getDecimal in interface DataGetters
  - getTimestamp
```
public Timestamp getTimestamp(int pos,
                              int precision)
```
    Description copied from interface: DataGetters
    
    Returns the timestamp value at the given position.
    The precision is required to determine whether the timestamp value was stored in a compact representation (see Timestamp).
    
    Specified by:
    
    getTimestamp in interface DataGetters
  - getBinary
```
public byte[] getBinary(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the binary value at the given position.
    
    Specified by:
    
    getBinary in interface DataGetters
  - getArray
```
public InternalArray getArray(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the array value at the given position.
    
    Specified by:
    
    getArray in interface DataGetters
  - getMap
```
public InternalMap getMap(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the map value at the given position.
    
    Specified by:
    
    getMap in interface DataGetters
  - getRow
```
public InternalRow getRow(int pos,
                          int numFields)
```
    Description copied from interface: DataGetters
    
    Returns the row value at the given position.
    The number of fields is required to correctly extract the row.
    
    Specified by:
    
    getRow in interface DataGetters
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - of
```
public static GenericRow of(Object... values)
```
    Creates an instance of GenericRow with given field values.
    By default, the row describes a RowKind.INSERT in a changelog.
    Note: All fields of the row must be internal data structures.
  - ofKind
```
public static GenericRow ofKind(RowKind kind,
                                Object... values)
```
    Creates an instance of GenericRow with given kind and field values.
    Note: All fields of the row must be internal data structures.

Back to Paimon Website

Class GenericRow

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.paimon.data.InternalRow

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.paimon.data.InternalRow

Constructor Detail

GenericRow

GenericRow

Method Detail

setField

getField

getFieldCount

getRowKind

setRowKind

isNullAt

getBoolean

getByte

getShort

getInt

getLong

getFloat

getDouble

getString

getDecimal

getTimestamp

getBinary

getArray

getMap

getRow

equals

hashCode

toString

of

ofKind

Back to Paimon Website