io.cdap.cdap.api.dataset.table

Class RowColumns<T>

java.lang.Object

io.cdap.cdap.api.dataset.table.RowColumns<T>

Type Parameters:

T - implementor type - to support handy builder-like methods.

Direct Known Subclasses:

Delete, Get

public abstract class RowColumns<T>
extends Object

Base class for defining a row with set of columns.

Constructor Summary

Constructors

Constructor and Description
RowColumns(byte[] row) Defines a row with all columns included.
RowColumns(byte[] row, byte[]... columns) Defines a row, with the specified set of columns.
RowColumns(String row) Defines a row with all columns included.
RowColumns(String row, String... columns) Defines a row, including all columns, unless additional columns are specified.

Method Summary

Modifier and Type	Method and Description
T	add(byte[][] columns) Specifies column(s) to be included.
T	add(byte[] firstColumn, byte[]... moreColumns) Specifies column(s) to be included.
T	add(String[] columns) Specifies column(s) to be included.
T	add(String firstColumn, String... moreColumns) Specifies column(s) to be included.
List<byte[]>	getColumns()
byte[]	getRow()

Methods inherited from class java.lang.Object

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

Constructor Detail

RowColumns

public RowColumns(byte[] row)

Defines a row with all columns included. If any of the add method is called, only columns specified through those add method calls are included.

Parameters:

row - the row to define.

RowColumns

public RowColumns(byte[] row,
                  byte[]... columns)

Defines a row, with the specified set of columns.

Parameters:

row - the row to define

columns - the set of columns of the row to included

RowColumns

public RowColumns(String row)

Defines a row with all columns included. If any of the add method is called, only columns specified through those add method calls are included.

Parameters:

row - the row to define. Note: It will be converted to byte[] with UTF-8 encoding.

RowColumns

public RowColumns(String row,
                  String... columns)

Defines a row, including all columns, unless additional columns are specified. Note that the provided strings will be converted to byte[] with UTF-8 encoding.

Parameters:

row - the row to define

columns - the set of columns of the row to included

Method Detail

add

public T add(byte[] firstColumn,
             byte[]... moreColumns)

Specifies column(s) to be included.

Parameters:

firstColumn - the first column being included

moreColumns - a collection of additional columns being included

Returns:

the RowColumns object being defined

add

public T add(byte[][] columns)

Specifies column(s) to be included.

Parameters:

columns - a collection of columns being included

Returns:

the RowColumns object being defined

add

public T add(String firstColumn,
             String... moreColumns)

Specifies column(s) to be included. Note that the provided strings will be converted to byte[] with UTF-8 encoding.

Parameters:

firstColumn - the first column being included

moreColumns - a collection of additional columns being included

Returns:

the RowColumns object being defined

add

public T add(String[] columns)

Specifies column(s) to be included.

Parameters:

columns - a collection of columns being included

Returns:

the RowColumns object being defined

getRow

public byte[] getRow()

Returns:

the row that was included

getColumns

@Nullable
public List<byte[]> getColumns()

Returns:

a list of columns of this object. null indicates ALL columns.