voldemort.store.compress
Class CompressingStore

java.lang.Object
  voldemort.store.AbstractStore<ByteArray,byte[],byte[]>
      voldemort.store.compress.CompressingStore

All Implemented Interfaces:

Store<ByteArray,byte[],byte[]>

public class CompressingStore
extends AbstractStore<ByteArray,byte[],byte[]>

A Store Decorator that compresses keys and values as it stores them and uncompresses them as it reads them based on the CompressionStrategy objects provided. A NoopCompressionStrategy can be used if no compression is desired for either keys or values. Transforms are not compressed

See Also:

CompressionStrategy, NoopCompressionStrategy, GzipCompressionStrategy

Constructor Summary

CompressingStore(Store<ByteArray,byte[],byte[]> innerStore, CompressionStrategy keysCompressionStrategy, CompressionStrategy valuesCompressionStrategy)

Method Summary

void	close() Close the store.
boolean	delete(ByteArray key, Version version) Delete all entries prior to the given version
java.util.List<Versioned<byte[]>>	get(ByteArray key, byte[] transforms) Get the value associated with the given key
java.util.Map<ByteArray,java.util.List<Versioned<byte[]>>>	getAll(java.lang.Iterable<ByteArray> keys, java.util.Map<ByteArray,byte[]> transforms) Get the values associated with the given keys and returns them in a Map of keys to a list of versioned values.
java.lang.Object	getCapability(StoreCapabilityType capability) Get some capability of the store.
java.util.List<Version>	getVersions(ByteArray key) Get the versions associated with the given key.
void	put(ByteArray key, Versioned<byte[]> value, byte[] transforms) Associate the value with the key and version in this store

Methods inherited from class voldemort.store.AbstractStore

delete, get, getAll, getName, put

Methods inherited from class java.lang.Object

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

Constructor Detail

CompressingStore

public CompressingStore(Store<ByteArray,byte[],byte[]> innerStore,
                        CompressionStrategy keysCompressionStrategy,
                        CompressionStrategy valuesCompressionStrategy)

Method Detail

getAll

public java.util.Map<ByteArray,java.util.List<Versioned<byte[]>>> getAll(java.lang.Iterable<ByteArray> keys,
                                                                         java.util.Map<ByteArray,byte[]> transforms)
                                                                  throws VoldemortException

Description copied from interface: Store

Get the values associated with the given keys and returns them in a Map of keys to a list of versioned values. Note that the returned map will only contain entries for the keys which have a value associated with them.

Specified by:

getAll in interface Store<ByteArray,byte[],byte[]>

Overrides:

getAll in class AbstractStore<ByteArray,byte[],byte[]>

Parameters:

keys - The keys to check for.

Returns:

A Map of keys to a list of versioned values.

Throws:

VoldemortException

get

public java.util.List<Versioned<byte[]>> get(ByteArray key,
                                             byte[] transforms)
                                      throws VoldemortException

Description copied from interface: Store

Get the value associated with the given key

Specified by:

get in interface Store<ByteArray,byte[],byte[]>

Overrides:

get in class AbstractStore<ByteArray,byte[],byte[]>

Parameters:

key - The key to check for

Returns:

The value associated with the key or an empty list if no values are found.

Throws:

VoldemortException

getVersions

public java.util.List<Version> getVersions(ByteArray key)

Description copied from interface: Store

Get the versions associated with the given key. This is used in a put call to write a new value for this key

Specified by:

getVersions in interface Store<ByteArray,byte[],byte[]>

Overrides:

getVersions in class AbstractStore<ByteArray,byte[],byte[]>

Parameters:

key - The key to retrieve the versions for

Returns:

List of Versions associated with this key.

put

public void put(ByteArray key,
                Versioned<byte[]> value,
                byte[] transforms)
         throws VoldemortException

Description copied from interface: Store

Associate the value with the key and version in this store

Specified by:

put in interface Store<ByteArray,byte[],byte[]>

Overrides:

put in class AbstractStore<ByteArray,byte[],byte[]>

Parameters:

key - The key to use

value - The value to store and its version.

Throws:

VoldemortException

close

public void close()
           throws VoldemortException

Description copied from interface: Store

Close the store.

Specified by:

close in interface Store<ByteArray,byte[],byte[]>

Overrides:

close in class AbstractStore<ByteArray,byte[],byte[]>

Throws:

VoldemortException - If closing fails.

getCapability

public java.lang.Object getCapability(StoreCapabilityType capability)

Description copied from interface: Store

Get some capability of the store. Examples would be the serializer used, or the routing strategy. This provides a mechanism to verify that the store hierarchy has some set of capabilities without knowing the precise layering.

Specified by:

getCapability in interface Store<ByteArray,byte[],byte[]>

Overrides:

getCapability in class AbstractStore<ByteArray,byte[],byte[]>

Parameters:

capability - The capability type to retrieve

Returns:

The given capaiblity

delete

public boolean delete(ByteArray key,
                      Version version)
               throws VoldemortException

Description copied from interface: Store

Delete all entries prior to the given version

Specified by:

delete in interface Store<ByteArray,byte[],byte[]>

Overrides:

delete in class AbstractStore<ByteArray,byte[],byte[]>

Parameters:

key - The key to delete

version - The current value of the key

Returns:

True if anything was deleted

Throws:

VoldemortException