io.cdap.cdap.api.dataset.table

Class Increment

java.lang.Object

io.cdap.cdap.api.dataset.table.Increment

public class Increment
extends Object

An Increment interprets the values of columns as 8-byte integers and increments them by the specified value.

• The operation fails if a column's existing value is not exactly 8 bytes long (with NumberFormatException).
• If a column to increment does not exist prior to the operation, then the column is created and the column's value is set to the increment value.
• An increment operation should at least change the value of one column.

Constructor Summary

Constructors

Constructor and Description
Increment(byte[] row) Changes the values of columns in a row.
Increment(byte[] row, byte[] column, long value) Changes the value of at least one column in a row.
Increment(String row) Changes the values of all of the columns in a row.
Increment(String row, String column, long value) Changes the value of at least one column in a row.

Method Summary

Modifier and Type	Method and Description
Increment	add(byte[] column, long value) Adds a column and sets the column's value.
Increment	add(String column, long value) Adds a column and sets the column's value.
byte[]	getRow()
Map<byte[],Long>	getValues()

Methods inherited from class java.lang.Object

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

Constructor Detail

Increment

public Increment(byte[] row)

Changes the values of columns in a row.

Parameters:

row - Row to change.

Increment

public Increment(byte[] row,
                 byte[] column,
                 long value)

Changes the value of at least one column in a row.

Parameters:

row - Row to change.

column - Column to change.

value - Value to increment by.

Increment

public Increment(String row)

Changes the values of all of the columns in a row.

Parameters:

row - Row in which all column values are incremented.

Increment

public Increment(String row,
                 String column,
                 long value)

Changes the value of at least one column in a row.

Parameters:

row - Row to change.

column - Column to change.

value - Value to increment the column value by.

Method Detail

getRow

public byte[] getRow()

Returns:

Row to change.

getValues

public Map<byte[],Long> getValues()

Returns:

Map of columns/values to increment each column's values by.

add

public Increment add(byte[] column,
                     long value)

Adds a column and sets the column's value.

Parameters:

column - Column to add.

value - Column value.

Returns:

Instance of this Increment.

add

public Increment add(String column,
                     long value)

Adds a column and sets the column's value.

Parameters:

column - Column to add.

value - Column value.

Returns:

Instance of this Increment.