org.apache.fluo.recipes.core.combine

Interface CombineQueue<K,V>

public interface CombineQueue<K,V>

See the project level documentation for information about this recipe.

Since:

1.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CombineQueue.FluentArg1 Part of a fluent API for configuring a combine queue.
static interface	CombineQueue.FluentArg2 Part of a fluent API for configuring a combine queue.
static interface	CombineQueue.FluentArg3 Part of a fluent API for configuring a combine queue.
static interface	CombineQueue.FluentOptions Part of a fluent API for configuring a combine queue.
static interface	CombineQueue.Initializer<K2,V2>
static class	CombineQueue.Optimizer

Method Summary

Modifier and Type	Method and Description
void	addAll(org.apache.fluo.api.client.TransactionBase tx, Map<K,V> updates) Queues updates for this combine queue.
static CombineQueue.FluentArg1	configure(String combineQueueId) Call this method before initializing Fluo to configure a combine queue.
static <K2,V2> CombineQueue.Initializer<K2,V2>	getInitializer(String cqId, int numBuckets, SimpleSerializer serializer) A CombineQueue stores data in its own data format in the Fluo table.
static <K2,V2> CombineQueue<K2,V2>	getInstance(String combineQueueId, org.apache.fluo.api.config.SimpleConfiguration appConfig) Get a combiner queue instance.
void	registerObserver(org.apache.fluo.api.observer.ObserverProvider.Registry obsRegistry, Combiner<K,V> combiner, ChangeObserver<K,V> updateObserver) Used to register a Fluo Observer that processes updates to this combine queue.

Method Detail

addAll

void addAll(org.apache.fluo.api.client.TransactionBase tx,
            Map<K,V> updates)

Queues updates for this combine queue. These updates will be made by an Observer executing in another transaction. This method will not collide with other transaction queuing updates for the same keys.

Parameters:

tx - This transaction will be used to make the updates.

updates - The keys in the map should correspond to keys in the collision free map being updated. The values in the map will be queued for updating.

registerObserver

void registerObserver(org.apache.fluo.api.observer.ObserverProvider.Registry obsRegistry,
                      Combiner<K,V> combiner,
                      ChangeObserver<K,V> updateObserver)

Used to register a Fluo Observer that processes updates to this combine queue. If this is not called, then updates will never be processed.

getInstance

static <K2,V2> CombineQueue<K2,V2> getInstance(String combineQueueId,
                                               org.apache.fluo.api.config.SimpleConfiguration appConfig)

Get a combiner queue instance.

Parameters:

combineQueueId - This should be the same id passed to configure(String) before initializing Fluo.

appConfig - Application configuration obtained from FluoClient.getAppConfiguration(), FluoConfiguration.getAppConfiguration(), or ObserverProvider.Context.getAppConfiguration()

configure

static CombineQueue.FluentArg1 configure(String combineQueueId)

Call this method before initializing Fluo to configure a combine queue.

Parameters:

combineQueueId - An id that uniquely identifies a combine queue. This id is used in the keys in the Fluo table and in the keys in the Fluo application configuration.

Returns:

A Fluent configurator.

getInitializer

static <K2,V2> CombineQueue.Initializer<K2,V2> getInitializer(String cqId,
                                                              int numBuckets,
                                                              SimpleSerializer serializer)

A CombineQueue stores data in its own data format in the Fluo table. When initializing a Fluo table with something like Map Reduce or Spark, data will need to be written in this format. Thats the purpose of this method, it provides a simple class that can do this conversion.