org.apache.flink.types

Class Row

java.lang.Object

org.apache.flink.types.Row

All Implemented Interfaces:

Serializable

@PublicEvolving
public class Row
extends Object
implements Serializable

A Row can have arbitrary number of fields and contain a set of fields, which may all be different types. The fields in Row can be null. Due to Row is not strongly typed, Flink's type extraction mechanism can't extract correct field types. So that users should manually tell Flink the type information via creating a RowTypeInfo.

The fields in the Row can be accessed by position (zero-based) getField(int). And can set fields by setField(int, Object).

Row is in principle serializable. However, it may contain non-serializable fields, in which case serialization will fail.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Row(int arity) Create a new Row instance.

Method Summary

Modifier and Type	Method and Description
static Row	copy(Row row) Creates a new Row which copied from another row.
boolean	equals(Object o)
int	getArity() Get the number of fields in the Row.
Object	getField(int pos) Gets the field at the specified position.
int	hashCode()
static Row	of(Object... values) Creates a new Row and assigns the given values to the Row's fields.
static Row	project(Row row, int[] fields) Creates a new Row with projected fields from another row.
void	setField(int pos, Object value) Sets the field at the specified position.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Row

public Row(int arity)

Create a new Row instance.

Parameters:

arity - The number of fields in the Row

Method Detail

getArity

public int getArity()

Get the number of fields in the Row.

Returns:

The number of fields in the Row.

getField

public Object getField(int pos)

Gets the field at the specified position.

Parameters:

pos - The position of the field, 0-based.

Returns:

The field at the specified position.

Throws:

IndexOutOfBoundsException - Thrown, if the position is negative, or equal to, or larger than the number of fields.

setField

public void setField(int pos,
                     Object value)

Sets the field at the specified position.

Parameters:

pos - The position of the field, 0-based.

value - The value to be assigned to the field at the specified position.

Throws:

IndexOutOfBoundsException - Thrown, if the position is negative, or equal to, or larger than the number of fields.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

of

public static Row of(Object... values)

Creates a new Row and assigns the given values to the Row's fields. This is more convenient than using the constructor.

For example:

     Row.of("hello", true, 1L);}
 

instead of

     Row row = new Row(3);
     row.setField(0, "hello");
     row.setField(1, true);
     row.setField(2, 1L);
 

copy

public static Row copy(Row row)

Creates a new Row which copied from another row. This method does not perform a deep copy.

Parameters:

row - The row being copied.

Returns:

The cloned new Row

project

public static Row project(Row row,
                          int[] fields)

Creates a new Row with projected fields from another row. This method does not perform a deep copy.

Parameters:

fields - fields to be projected

Returns:

the new projected Row