io.cdap.cdap.api.dataset.lib

Class IndexedObjectStore<T>

java.lang.Object

io.cdap.cdap.api.dataset.lib.AbstractDataset

io.cdap.cdap.api.dataset.lib.IndexedObjectStore<T>

Type Parameters:

T - the type of objects in the store

All Implemented Interfaces:

Dataset, MeteredDataset, Closeable, AutoCloseable, org.apache.tephra.TransactionAware

Deprecated.

table based datasets will be removed in a future version

@Deprecated
public class IndexedObjectStore<T>
extends AbstractDataset

An ObjectStore Dataset extension that supports access to objects via indices; lookups by the index will return all the objects stored in the object store that have the index value. The dataset uses two tables: an object store, to store the actual data, and a second table for the index.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
IndexedObjectStore(String name, ObjectStore<T> objectStore, Table index) Deprecated. Constructs the IndexedObjectStore with name and type.

Method Summary

Modifier and Type	Method and Description
void	pruneIndex(byte[] key, byte[] secondaryKey) Deprecated. Deletes an index that is no longer needed.
T	read(byte[] key) Deprecated. See ObjectStore.read(byte[]).
T	read(String key) Deprecated. See ObjectStore.read(String).
List<T>	readAllByIndex(byte[] secondaryKey) Deprecated. Read all the objects from the objectStore for a given index.
void	updateIndex(byte[] key, byte[] secondaryKey) Deprecated. Updates the index value for an existing key.
void	write(byte[] key, T object) Deprecated.
void	write(byte[] key, T object, byte[][] secondaryKeys) Deprecated. Writes to the dataset, deleting any existing secondaryKey corresponding to the key and updates the indexTable with the secondaryKey that is passed.

Methods inherited from class io.cdap.cdap.api.dataset.lib.AbstractDataset

close, commitTx, getName, getTransactionAwareName, getTxChanges, postTxCommit, rollbackTx, setMetricsCollector, startTx, toString, updateTx

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

Deprecated.

Type name

See Also:

Constant Field Values

Constructor Detail

IndexedObjectStore

public IndexedObjectStore(String name,
                          ObjectStore<T> objectStore,
                          Table index)

Deprecated.

Constructs the IndexedObjectStore with name and type.

Parameters:

name - name of the dataset

objectStore - dataset to use as the objectStore

index - dataset to use as the index

Method Detail

read

public T read(byte[] key)

Deprecated.

See ObjectStore.read(byte[]).

read

public T read(String key)

Deprecated.

See ObjectStore.read(String).

readAllByIndex

public List<T> readAllByIndex(byte[] secondaryKey)

Deprecated.

Read all the objects from the objectStore for a given index. Returns all the objects that match the secondaryKey. Returns an empty list if no values are found. Never returns null.

Parameters:

secondaryKey - for the lookup.

Returns:

List of Objects matching the secondaryKey.

write

public void write(byte[] key,
                  T object,
                  byte[][] secondaryKeys)

Deprecated.

Writes to the dataset, deleting any existing secondaryKey corresponding to the key and updates the indexTable with the secondaryKey that is passed.

Parameters:

key - key for storing the object

object - object to be stored

secondaryKeys - indices that can be used to lookup the object

write

public void write(byte[] key,
                  T object)

Deprecated.

pruneIndex

public void pruneIndex(byte[] key,
                       byte[] secondaryKey)

Deprecated.

Deletes an index that is no longer needed. After deleting the index, lookups using the index value will no longer return the object.

Parameters:

key - key for the object

secondaryKey - index to be pruned

updateIndex

public void updateIndex(byte[] key,
                        byte[] secondaryKey)

Deprecated.

Updates the index value for an existing key. This will not delete the older secondaryKeys.

Parameters:

key - key for the object

secondaryKey - index to be pruned