io.cdap.cdap.api.dataset.lib

Interface ObjectMappedTable<T>

Type Parameters:

T - the type of objects in the table

All Superinterfaces:

AutoCloseable, BatchReadable<byte[],T>, BatchWritable<byte[],T>, Closeable, Dataset, RecordScannable<StructuredRecord>, RecordWritable<StructuredRecord>

Deprecated.

table based datasets will be removed in a future version

@Deprecated
public interface ObjectMappedTable<T>
extends Dataset, BatchReadable<byte[],T>, BatchWritable<byte[],T>, RecordScannable<StructuredRecord>, RecordWritable<StructuredRecord>

A Dataset that stores plain java Objects into a table by mapping object fields to table columns. Objects must be flat and can only contain fields of simple type. A simple type is an Integer, int, Long, long, Float, float, Double, double, String, byte[], ByteBuffer, or UUID. The object itself cannot be a simple type. This Dataset is RecordScannable, which means it can be explored through Hive. The Hive table for this Dataset will contain one column for each object field and one column for the row key. For example, if you are storing an Object of three fields ("id", "name", and "price"), the corresponding Hive table will have four columns: "rowkey", "id", "name", and "price". If you wish to change the name of the "rowkey" column you can do so by setting a property on the Dataset. See ObjectMappedTableProperties for more information on properties for this Dataset.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE Deprecated. Type name

Method Summary

Modifier and Type	Method and Description
void	delete(byte[] key) Deprecated. Delete the object for the specified key.
void	delete(String key) Deprecated. Delete the object for the specified key.
List<Split>	getSplits(int numSplits, byte[] start, byte[] stop) Deprecated. Returns splits for a range of keys in the table.
T	read(byte[] key) Deprecated. Read an object with a given key.
T	read(String key) Deprecated. Read an object with a given key.
CloseableIterator<KeyValue<byte[],T>>	scan(byte[] startRow, byte[] stopRow) Deprecated. Scans table.
CloseableIterator<KeyValue<byte[],T>>	scan(Scan scan) Deprecated. Scans table.
CloseableIterator<KeyValue<byte[],T>>	scan(String startRow, String stopRow) Deprecated. Scans table.
void	write(byte[] key, T object) Deprecated. Write an object with a given key.
void	write(String key, T object) Deprecated. Write an object with a given key.

Methods inherited from interface io.cdap.cdap.api.data.batch.BatchReadable

createSplitReader, getSplits

Methods inherited from interface io.cdap.cdap.api.data.batch.RecordScannable

createSplitRecordScanner, getRecordType, getSplits

Methods inherited from interface io.cdap.cdap.api.data.batch.RecordWritable

getRecordType, write

Methods inherited from interface java.io.Closeable

close

Field Detail

TYPE

static final String TYPE

Deprecated.

Type name

See Also:

Constant Field Values

Method Detail

write

void write(String key,
           T object)

Deprecated.

Write an object with a given key.

Parameters:

key - the key of the object

object - the object to be stored

write

void write(byte[] key,
           T object)

Deprecated.

Write an object with a given key.

Specified by:

write in interface BatchWritable<byte[],T>

Parameters:

key - the key of the object

object - the object to be stored

read

T read(String key)

Deprecated.

Read an object with a given key.

Parameters:

key - the key of the object

Returns:

the object if found, or null if not found

read

T read(byte[] key)

Deprecated.

Read an object with a given key.

Parameters:

key - the key of the object

Returns:

the object if found, or null if not found

scan

CloseableIterator<KeyValue<byte[],T>> scan(@Nullable
                                           String startRow,
                                           @Nullable
                                           String stopRow)

Deprecated.

Scans table.

Parameters:

startRow - start row inclusive. null means start from first row of the table

stopRow - stop row exclusive. null means scan all rows to the end of the table

Returns:

CloseableIterator over KeyValue<byte[], T>

scan

CloseableIterator<KeyValue<byte[],T>> scan(@Nullable
                                           byte[] startRow,
                                           @Nullable
                                           byte[] stopRow)

Deprecated.

Scans table.

Parameters:

startRow - start row inclusive. null means start from first row of the table

stopRow - stop row exclusive. null means scan all rows to the end of the table

Returns:

CloseableIterator over KeyValue<byte[], T>

scan

CloseableIterator<KeyValue<byte[],T>> scan(Scan scan)

Deprecated.

Scans table.

Parameters:

scan - Scan object to scan the table with.

Returns:

CloseableIterator over KeyValue<byte[], T>

delete

void delete(String key)

Deprecated.

Delete the object for the specified key.

Parameters:

key - key of the object to be deleted

delete

void delete(byte[] key)

Deprecated.

Delete the object for the specified key.

Parameters:

key - key of the object to be deleted

getSplits

List<Split> getSplits(int numSplits,
                      byte[] start,
                      byte[] stop)

Deprecated.

Returns splits for a range of keys in the table.

Parameters:

numSplits - Desired number of splits. If greater than zero, at most this many splits will be returned. If less than or equal to zero, any number of splits can be returned.

start - if non-null, the returned splits will only cover keys that are greater or equal

stop - if non-null, the returned splits will only cover keys that are less

Returns:

list of Split