algebra

Type Members

class AlgebraicMutableCache[K, V] extends AnyRef
class AlgebraicReadableStore[K, V] extends AnyRef
class AlgebraicStore[K, V] extends AnyRef
class BufferingMergeable[K, V] extends Mergeable[K, V]

A Mergeable that sits on top of another mergeable and pre-aggregates before pushing into merge/multiMerge.
A Mergeable that sits on top of another mergeable and pre-aggregates before pushing into merge/multiMerge. This is very useful for cases where you have some keys that are very hot, or you have a remote mergeable that you don't want to constantly hit.
class BufferingStore[K, V] extends BufferingMergeable[K, V] with MergeableStore[K, V]

A MergeableStore that does the same buffering as BufferingMergeable, but flushes on put/get.
class ConcurrentHashMapMergeableStore[K, V] extends MergeableStore[K, V]

A threadsafe local MergeableStore useful for testing or other local applications
class ConvertedMergeableStore[K1, -K2, V1, V2] extends storehaus.ConvertedStore[K1, K2, V1, V2] with MergeableStore[K2, V2]

Caveat Emptor! The semigroup on the resulting ConvertedMergeableStore will be the bijected semigroup from Semigroup[V1] => Semigroup[V2].
Caveat Emptor! The semigroup on the resulting ConvertedMergeableStore will be the bijected semigroup from Semigroup[V1] => Semigroup[V2]. This will not necessarily result in the behavior you'd expect.
class EnrichedMergeableStore[K, V] extends AnyRef

Enrichment on the com.twitter.storehaus.algebra.MergeableStore trait.
Enrichment on the com.twitter.storehaus.algebra.MergeableStore trait. Storehaus uses the enrichment pattern instead of adding these methods directly to the trait because many of the functions (mapValues, for example) have different meanings for ReadableStore, Store and MergeableStore.
```
import MergeableStore.enrich
```
to get access to these methods.
TODO: in scala 2.10 this should be a value class
case class ExpiredException[K, V](pair: (K, V)) extends RuntimeException with Product with Serializable

Injection that maps values paired with stale values of T => None on inversion.
trait Mergeable[-K, V] extends Closable

Main trait to represent objects that are used for aggregation
class MergeableJMapLongStore[K] extends MergeableJMapStore[K, Long]

MergeableStore instance that is backed by a ConcurrentHashMap This class is thread safe with a locking merge operation and thread safe put/get operations provided by the underlying ConcurrentHashMap There is no multi operation optimization so all multi operations use the default Store implementation.
MergeableStore instance that is backed by a ConcurrentHashMap This class is thread safe with a locking merge operation and thread safe put/get operations provided by the underlying ConcurrentHashMap There is no multi operation optimization so all multi operations use the default Store implementation.
This class is ideal for local testing of code that interacts with a MergeableStore[String,Long] such as RedisLongStore without the need to hit a remote database. Can also be used for data processing where you don't care about persistence beyond the running process.
class MergeableJMapStore[K, V] extends MergeableStore[K, V]
class MergeableMonoidStore[-K, V] extends MergeableStoreViaGetPut[K, V]

Uses the monoid and filters zeros on put.
Uses the monoid and filters zeros on put. On get, empty is replaced with Monoid.zero. This store never returns Future.None. The design choice of never returning None is to make sure users do not mistake zero for meaning empty. Clearly, we cannot tell the difference, but returning zero is assumed to make it less likely the user thinks the key is absent (which this store can never confirm).
trait MergeableProxy[K, V] extends Mergeable[K, V] with Proxied[Mergeable[K, V]]

Proxy for Mergeables.
Proxy for Mergeables. Methods not overrided in extensions will be forwared to Proxied self member
trait MergeableStore[-K, V] extends Store[K, V] with Mergeable[K, V]

Main trait to represent stores that are used for aggregation
trait MergeableStoreProxy[K, V] extends MergeableStore[K, V] with Proxied[MergeableStore[K, V]]

Proxy for MergeableStoress.
Proxy for MergeableStoress. Methods not overrided in extensions will be forwared to Proxied self member
class MergeableStoreViaGetPut[-K, V] extends MergeableStoreViaSingleGetPut[K, V]
class MergeableStoreViaSingleGetPut[-K, V] extends MergeableStore[K, V]

Just get, locally merge, then put.
Just get, locally merge, then put. This is only safe if there is only one writer thread per key. Otherwise you need to do some locking or compare-and-swap in the store
case class PromiseLink[V](promise: Promise[Option[V]], value: V) extends Product with Serializable

This class allows code to depends on the data that a value will be combined with, fulfilling the Promise with the value just before the value is added in.
class PromiseLinkMonoid[V] extends PromiseLinkSemigroup[V] with Monoid[PromiseLink[V]]

TODO: REMOVE WHEN NEXT VERSION OF ALGEBIRD IS PUBLISHED https://github.com/twitter/storehaus/issues/157 This Monoid allows code to depend on the result of computation asynchronously.
TODO: REMOVE WHEN NEXT VERSION OF ALGEBIRD IS PUBLISHED https://github.com/twitter/storehaus/issues/157 This Monoid allows code to depend on the result of computation asynchronously. This is a slightly less general version of the TunnelMonoid. See the documentation for TunnelMonoid for general motivation. NOTE: the Promise will be fulfilled with the value just before the PromiseLink is calculated.
class PromiseLinkSemigroup[V] extends Semigroup[PromiseLink[V]]
class ReadableStoreMonoid[K, V] extends ReadableStoreSemigroup[K, V] with Monoid[ReadableStore[K, V]]

Same as a ReadableStoreSemigroup except with a zero that the constant store always returning Monoid.zero[V]
class ReadableStoreSemigroup[K, V] extends Semigroup[ReadableStore[K, V]]

A semigroup that uses the future semigroup to add results of both gets
trait SummerConstructor[K] extends AnyRef

For any given V, construct a StatefulSummer of Map[K, V]
class TTLInjection[K, T, V] extends Injection[(K, V), (K, (T, V))]
class UnpivotedMergeableStore[-K, OuterK, InnerK, V] extends UnpivotedStore[K, OuterK, InnerK, V] with MergeableStore[K, V]

MergeableStore enrichment which presents a MergeableStore[K, V] over top of a packed MergeableStore[OuterK, Map[InnerK, V]].
class ConvertedStore[K1, -K2, V1, V2] extends ConvertedReadableStore[K1, K2, V1, V2] with Store[K2, V2]

Use an injection on V2,V1 to convert a store of values V2.
Use an injection on V2,V1 to convert a store of values V2. If the value stored in the underlying store cannot be converted back to V2, then you will get a Future.exception containing the string "cannot be converted" TODO: we should add a specific exception type here so we can safely filter these cases to Future.None if we so choose.

Annotations
@deprecated
Deprecated
(Since version 0.3.1) Use com.twitter.storehaus.ConvertedStore instead

Value Members

object Algebras

import Algebras._ to get Monoid/Semigroup on ReadableStore
object ConcurrentHashMapMergeableStore
object HHFilteredStore
object MergeableStore

Some factory methods and combinators on MergeableStore
object MutableCacheAlgebra

Enrichments and modifications to instances of MutableCache.
Enrichments and modifications to instances of MutableCache. Use these enrichments by importing MutableCacheAlgebra._.
object PromiseLink extends Serializable
object ReadableStoreAlgebra

Enrichments on ReadableStore.
object StoreAlgebra

Algebraic Enrichments on Store.
package query
package reporting

package algebra

Type Members

class AlgebraicMutableCache[K, V] extends AnyRef

class AlgebraicReadableStore[K, V] extends AnyRef

class AlgebraicStore[K, V] extends AnyRef

class BufferingMergeable[K, V] extends Mergeable[K, V]

class BufferingStore[K, V] extends BufferingMergeable[K, V] with MergeableStore[K, V]

class ConcurrentHashMapMergeableStore[K, V] extends MergeableStore[K, V]

class ConvertedMergeableStore[K1, -K2, V1, V2] extends storehaus.ConvertedStore[K1, K2, V1, V2] with MergeableStore[K2, V2]

class EnrichedMergeableStore[K, V] extends AnyRef

case class ExpiredException[K, V](pair: (K, V)) extends RuntimeException with Product with Serializable

trait Mergeable[-K, V] extends Closable

class MergeableJMapLongStore[K] extends MergeableJMapStore[K, Long]

class MergeableJMapStore[K, V] extends MergeableStore[K, V]

class MergeableMonoidStore[-K, V] extends MergeableStoreViaGetPut[K, V]

trait MergeableProxy[K, V] extends Mergeable[K, V] with Proxied[Mergeable[K, V]]

trait MergeableStore[-K, V] extends Store[K, V] with Mergeable[K, V]

trait MergeableStoreProxy[K, V] extends MergeableStore[K, V] with Proxied[MergeableStore[K, V]]

class MergeableStoreViaGetPut[-K, V] extends MergeableStoreViaSingleGetPut[K, V]

class MergeableStoreViaSingleGetPut[-K, V] extends MergeableStore[K, V]

case class PromiseLink[V](promise: Promise[Option[V]], value: V) extends Product with Serializable

class PromiseLinkMonoid[V] extends PromiseLinkSemigroup[V] with Monoid[PromiseLink[V]]

class PromiseLinkSemigroup[V] extends Semigroup[PromiseLink[V]]

class ReadableStoreMonoid[K, V] extends ReadableStoreSemigroup[K, V] with Monoid[ReadableStore[K, V]]

class ReadableStoreSemigroup[K, V] extends Semigroup[ReadableStore[K, V]]

trait SummerConstructor[K] extends AnyRef

class TTLInjection[K, T, V] extends Injection[(K, V), (K, (T, V))]

class UnpivotedMergeableStore[-K, OuterK, InnerK, V] extends UnpivotedStore[K, OuterK, InnerK, V] with MergeableStore[K, V]

class ConvertedStore[K1, -K2, V1, V2] extends ConvertedReadableStore[K1, K2, V1, V2] with Store[K2, V2]

Value Members

object Algebras

object ConcurrentHashMapMergeableStore

object HHFilteredStore

object MergeableStore

object MutableCacheAlgebra

object PromiseLink extends Serializable

object ReadableStoreAlgebra

object StoreAlgebra

package query

package reporting

Ungrouped