DefaultBucket (Riak Client for Java 1.0.5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.basho.riak.client.bucket
Class DefaultBucket

java.lang.Object
  com.basho.riak.client.bucket.DefaultBucket

All Implemented Interfaces:: Bucket, BucketProperties

public class DefaultBucket
extends Object
implements Bucket
extends Object
implements Bucket

Default implementation of Bucket for creating RiakOperations on k/v data and accessing BucketProperties.

Obtain a DefaultBucket from FetchBucket or WriteBucket operations from DefaultRiakClient.fetchBucket(String), DefaultRiakClient.createBucket(String)

   final String bucketName = UUID.randomUUID().toString();
   
   Bucket b = client.createBucket(bucketName).execute();
   //store something
   IRiakObject o = b.store("k", "v").execute();
   //fetch it back
   IRiakObject fetched = b.fetch("k").execute();
   // now update that riak object
   b.store("k", "my new value").execute();
   //fetch it back again
   fetched = b.fetch("k").execute();
   //delete it
   b.delete("k").execute();

All operations created by instances of this class are configured with the Retrier and RawClient passed at construction.

Author:: russell
See Also:: DomainBucket, RiakBucket

Constructor Summary
`protected`	`DefaultBucket(String name, BucketProperties properties, RawClient client, Retrier retrier)` All `RiakOperation`s created by this instance will use the `RawClient` and `Retrier` provided here.

Method Summary

DeleteObject delete(String key)
Creates a DeleteObject operation that will delete the data at key on execute().





<T> DeleteObject

delete(T o)
Creates a DeleteObject operation that will delete the data at o's RiakKey annotated field value on execute().

FetchObject<IRiakObject> fetch(String key)
Creates a FetchObject that returns the data at key as an IRiakObject on execute().





<T> FetchObject<T>

fetch(String key,
      Class<T> type)

Creates a FetchObject operation that returns the data at key as an instance of type T on execute().





<T> FetchObject<T>

fetch(T o)
Creates a FetchObject operation that returns the data at o's annotated RiakKey field as an instance of type T on execute().





<T> FetchIndex<T>

fetchIndex(RiakIndex<T> index)
Creates a FetchIndex operation for the given index name and type

Boolean getAllowSiblings()
The allow_mult value for the bucket.

String getBackend()
The backend used by this bucket.

Boolean getBasicQuorum()
Should a read request return early in some failure cases? E.g.

Integer getBigVClock()
the big_vclock property for this bucket.

NamedErlangFunction getChashKeyFunction()
The chash_keyfun for this bucket.

Quorum getDW()
The default dw quorum for this bucket.

Boolean getLastWriteWins()
The last_write_wins value for the bucket.

NamedErlangFunction getLinkWalkFunction()
The linkwalk_fun for this bucket.

String getName()
Get this Buckets name.

Boolean getNotFoundOK()
True if a vnode returning notfound for a key increments the r tally.

Integer getNVal()
This bucket's n_val.

Long getOldVClock()
the old_vclock property for this bucket.

Collection<NamedErlangFunction> getPostcommitHooks()
The set of postcommit hooks for this bucket.

Quorum getPR()
The default pr quorum for this bucket.

Collection<NamedFunction> getPrecommitHooks()
The set of precommit_hooks for this bucket.

Quorum getPW()
The default pw quorum for this bucket.

Quorum getR()
The default r quorum for this bucket.

Quorum getRW()
The default rw quorum for this bucket.

Boolean getSearch()
The search property

Integer getSmallVClock()
the small_vclock property for this bucket.

Quorum getW()
The default w quorum for this bucket.

Long getYoungVClock()
The young_vclcok property for this bucket.

boolean isSearchEnabled()
Is search enabled on this bucket

Iterable<String> keys()
Iterate over the keys for this bucket (Expensive, are you sure?) Beware: at present all RawClient.listKeys(String) operations return a stream of keys.

StoreObject<IRiakObject> store(String key, byte[] value)
Convenience method to create a RiakObject with a payload of application/octect-stream

StoreObject<IRiakObject> store(String key, String value)
Convenience methods will create an IRiakObject with value as the data payload and text/plain:charset=utf-8 as the contentType





<T> StoreObject<T>

store(String key,
      T o)

Store an instance of T in Riak.





<T> StoreObject<T>

store(T o)
Store an instance of T in Riak.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

DefaultBucket

protected DefaultBucket(String name,
                        BucketProperties properties,
                        RawClient client,
                        Retrier retrier)

All RiakOperations created by this instance will use the RawClient and Retrier provided here.

Parameters:: name - this bucket's name; properties - the BucketProperties for this bucket; client - a RawClient to use for all RiakOperations; retrier - a Retrier to use for all RiakOperations

Method Detail

getName

public String getName()

Description copied from interface: Bucket

Get this Buckets name.

Specified by:: getName in interface Bucket

Returns:: the name of the bucket