io.cdap.wrangler.api

Class Row

java.lang.Object

io.cdap.wrangler.api.Row

All Implemented Interfaces:

Serializable

@PublicEvolving
public final class Row
extends Object
implements Serializable

Row defines the schema and data on which the wrangler will operate upon.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Row()
Row(List<String> columns) Initializes a row with list of columns.
Row(Row row) Makes a copy of the row.
Row(String name, Object value) Initializes the row with column name and value.

Method Summary

Modifier and Type	Method and Description
Row	add(String name, Object value) Adds a value into row with name.
void	addOrSet(String name, Object value) Adds or sets the value.
void	addOrSetAtIndex(int index, String name, Object value) Adds or sets the value to the beginning.
boolean	equals(Object o)
int	find(String col) Finds a column index based on the name of the column.
int	find(String col, int firstIdx) Finds a column index based on the name of the column.
String	getColumn(int idx) Gets a column name by index.
List<Pair<String,Object>>	getFields()
Object	getValue(int idx) Gets a value of row at specified index.
Object	getValue(String col) Gets value based on the column name.
int	hashCode()
int	length() Deprecated.
Row	remove(int idx) Removes the column and value at given index.
void	setColumn(int idx, String name) Sets the name of the column at a given index.
Row	setValue(int idx, Object value) Updates the value of the row at index idx.
int	width()

Methods inherited from class java.lang.Object

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

Constructor Detail

Row

public Row()

Row

public Row(Row row)

Makes a copy of the row.

Parameters:

row - to be copied to 'this' object.

Row

public Row(List<String> columns)

Initializes a row with list of columns.

Parameters:

columns - to set in the row.

Row

public Row(String name,
           Object value)

Initializes the row with column name and value.

Parameters:

name - of the column to be added to the row.

value - for the column defined above.

Method Detail

getColumn

public String getColumn(int idx)

Gets a column name by index.

Parameters:

idx - to retrieve the name of the column.

Returns:

name of the column.

setColumn

public void setColumn(int idx,
                      String name)

Sets the name of the column at a given index.

Parameters:

idx - at which the new name to be set.

name - of the column to be set at idx.

getValue

public Object getValue(int idx)

Gets a value of row at specified index.

Parameters:

idx - from where the value should be retrieved.

Returns:

value at index (idx).

getValue

public Object getValue(String col)

Gets value based on the column name.

Parameters:

col - name of the column for which the value is retrieved.

Returns:

value associated with column.

setValue

public Row setValue(int idx,
                    Object value)

Updates the value of the row at index idx.

Parameters:

idx - index at which the value needs to be updated.

value - value to be updated at index (idx).

add

public Row add(String name,
               Object value)

Adds a value into row with name.

Parameters:

name - of the value to be added to row.

value - to be added to row.

remove

public Row remove(int idx)

Removes the column and value at given index.

Parameters:

idx - for which the value and column are removed.

find

public int find(String col)

Finds a column index based on the name of the column. The col name is case insensitive.

Parameters:

col - to be searched within the row.

Returns:

-1 if not present, else the index at which the column is found.

find

public int find(String col,
                int firstIdx)

Finds a column index based on the name of the column. Starts the search from firstIdx index. The col name is case insensitive.

Parameters:

col - to be searched within the row.

firstIdx - first index to check

Returns:

-1 if not present, else the index at which the column is found.

length

@Deprecated
public int length()

Deprecated.

Returns:

width of the row.

width

public int width()

Returns:

width of the row.

getFields

public List<Pair<String,Object>> getFields()

Returns:

List of fields of record.

addOrSet

public void addOrSet(String name,
                     Object value)

Adds or sets the value.

Parameters:

name - of the field to be either set or added to record.

value - to be added.

addOrSetAtIndex

public void addOrSetAtIndex(int index,
                            String name,
                            Object value)

Adds or sets the value to the beginning.

Parameters:

index - at which the column need to be inserted.

name - of the field to be either set or added to record.

value - to be added.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object