com.basho.riak.client.core.query

Class RiakObject

java.lang.Object

com.basho.riak.client.core.query.RiakObject

public final class RiakObject
extends Object

Represents the data and metadata stored in Riak

While the client APIs provide methods to store/retrieve data to/from Riak using your own Beans/POJOs, this class is used as the core data type to and from which those types are converted.

Working with Metadata

An object in Riak has a few types of metadata that can be attached; Secondary Indexes, Links, and User Metadata. Each of these has its own container in RiakObject and methods are provided to access them.

Thread Safety:
RiakObject is designed to be thread safe. All methods which update the object do so via a thread safe mechanism. The only caveat is that if you use any of the methods prefixed with "unsafe" you need to understand the ramifications as noted in their Javadoc.

Since:

2.0

Author:

Brian Roach

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTENT_TYPE The default content type assigned when storing in Riak if one is not provided.

Constructor Summary

Constructors

Constructor and Description
RiakObject() Constructs a new, empty RiakObject.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCharset() Get the charset for this RiakObject's content (value).
String	getContentType() Returns the content type of the data payload (value) of this RiakObject
RiakIndexes	getIndexes() Returns the Secondary Indexes (2i) for this RiakObject
long	getLastModified() Returns the last modified time of this RiakObject.
RiakLinks	getLinks() Returns the RiakLinks for this RiakObject.
RiakUserMetadata	getUserMeta() Returns the User Meta for this RiakObject Thread Safety: The returned RiakUserMetadata encapsulates any/all user meta entries for this RiakObject, is mutable, and thread safe.
BinaryValue	getValue() Returns the value of this RiakObject.
VClock	getVClock() Get the vector clock for this RiakObject.
String	getVTag() Returns the version tag (if it is one of a asSet of siblings) for this RiakObject
boolean	hasCharset() Determine if there is a charset set in either the charset or content-type settings.
int	hashCode()
boolean	hasIndexes() Returns whether this RiakObject has secondary indexes (2i)
boolean	hasLinks() Returns whether this RiakObject containsKeyKey links
boolean	hasUserMeta() Returns if there are any User Meta entries for this RiakObject
boolean	hasValue() Returns whether or not this RiakObject has a value
boolean	isDeleted() Returns whether or not this RiakObject is marked as being deleted (a tombstone)
RiakObject	setCharset(String charset) Set the characterSet for this object's content (value).
RiakObject	setContentType(String contentType) Set the content type of the data payload (value) of the this RiakObject.
RiakObject	setDeleted(boolean isDeleted) Marks this RiakObject as being a tombstone in Riak
RiakObject	setLastModified(long lastModified) A long timestamp of milliseconds since the epoch to asSet as the last modified date on this RiakObject.
RiakObject	setValue(BinaryValue value) Set the value for this RiakObject
RiakObject	setVClock(VClock vclock) Set the vector clock for this RiakObject.
RiakObject	setVTag(String vtag) Set the version tag for this RiakObject
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

The default content type assigned when storing in Riak if one is not provided. "application/octet-stream"

See Also:

setContentType(java.lang.String), Constant Field Values

Constructor Detail

RiakObject

public RiakObject()

Constructs a new, empty RiakObject.

Method Detail

hasValue

public boolean hasValue()

Returns whether or not this RiakObject has a value

Returns:

true if the value has been asSet, false otherwise

getValue

public BinaryValue getValue()

Returns the value of this RiakObject.

Returns:

the value of this RiakObject

setValue

public RiakObject setValue(BinaryValue value)

Set the value for this RiakObject

Note that if setContentType(java.lang.String) is not called a value of "application/octet-stream" is used.

Thread Safety:
Unsafe modifications to the supplied BinaryValue's underlying byte[] would be a bad thing.

Parameters:

value - the value to be stored in Riak.

Returns:

a reference to this object.

Throws:

IllegalArgumentException - if value is zero length.

getVClock

public VClock getVClock()

Get the vector clock for this RiakObject.

Returns:

The vector clock, or null if not set.

setVClock

public RiakObject setVClock(VClock vclock)

Set the vector clock for this RiakObject.

Parameters:

vclock - a vector clock.

Returns:

a reference to this object.

getVTag

public String getVTag()

Returns the version tag (if it is one of a asSet of siblings) for this RiakObject

Returns:

the vtag if present, otherwise null

setVTag

public RiakObject setVTag(String vtag)

Set the version tag for this RiakObject

Parameters:

vtag - a String representing the VTag for this RiakObject

Returns:

a reference to this object

Throws:

IllegalArgumentException - if vtag is zero length

getLastModified

public long getLastModified()

Returns the last modified time of this RiakObject.

The timestamp is returned as a long (Unix) epoch time.

Returns:

The last modified time or 0 if it has not been asSet.

See Also:

setLastModified(long)

setLastModified

public RiakObject setLastModified(long lastModified)

A long timestamp of milliseconds since the epoch to asSet as the last modified date on this RiakObject.

Parameters:

lastModified -

Returns:

a reference to this object

getContentType

public String getContentType()

Returns the content type of the data payload (value) of this RiakObject

Due to Riak's HTTP API this is represented as a string suitable for a HTTP Content-Type header.

Returns:

a String representing the content type of this object's value

See Also:

setVClock(com.basho.riak.client.api.cap.VClock)

setContentType

public RiakObject setContentType(String contentType)

Set the content type of the data payload (value) of the this RiakObject. Please do not include a charset here, use setCharset(String) to declare one.

Due to Riak's HTTP API this is represented as a string suitable for a HTTP Content-Type header.

Parameters:

contentType - a String representing the content type of this object's value

Returns:

a reference to this object

See Also:

setValue(com.basho.riak.client.core.util.BinaryValue)

hasCharset

public boolean hasCharset()

Determine if there is a charset set in either the charset or content-type settings.

Returns:

true if a charset is present, false otherwise.

getCharset

public String getCharset()

Get the charset for this RiakObject's content (value). Will fetch from the RiakObject's charset setting, and failing that will attempt to get one from the content-type. Defaults to UTF-8.

Due to Riak's HTTP API this is represented as a string suitable for a HTTP Content-Type header.

Returns:

The character asSet String

See Also:

setCharset(java.lang.String), setValue(com.basho.riak.client.core.util.BinaryValue)

setCharset

public RiakObject setCharset(String charset)

Set the characterSet for this object's content (value).

Due to Riak's HTTP API this is represented as a string suitable for a HTTP Content-Type header.

Parameters:

charset - the Charset to be asSet

Returns:

a reference to this object

See Also:

setValue(com.basho.riak.client.core.util.BinaryValue)

hasIndexes

public boolean hasIndexes()

Returns whether this RiakObject has secondary indexes (2i)

Returns:

true if indexes are present, false otherwise

See Also:

Riak Secondary Indexes

getIndexes

public RiakIndexes getIndexes()

Returns the Secondary Indexes (2i) for this RiakObject

Any/all indexes for this RiakObject are encapsulated in the returned RiakIndexes object.

Thread Safety:
The returned RiakIndexes object encapsulates any/all indexes for this RiakObject}, is mutable, and thread safe. Any changes are directly applied to this RiakObject.

Returns:

the RiakIndexes that encapsulates any/all indexes for this RiakObject

See Also:

Riak Secondary Indexes

hasLinks

public boolean hasLinks()

Returns whether this RiakObject containsKeyKey links

Returns:

true if links are present, false otherwise

getLinks

public RiakLinks getLinks()

Returns the RiakLinks for this RiakObject.
Thread Safety:
The returned RiakLinks object encapsulates any/all links for this RiakObject, is mutable, and thread safe. Any changes are directly applied to this RiakObject.

Returns:

the RiakIndexes that encapsulates all/any links for this RiakObject

hasUserMeta

public boolean hasUserMeta()

Returns if there are any User Meta entries for this RiakObject

Returns:

true if user meta entries are present, false otherwise.

getUserMeta

public RiakUserMetadata getUserMeta()

Returns the User Meta for this RiakObject
Thread Safety:
The returned RiakUserMetadata encapsulates any/all user meta entries for this RiakObject, is mutable, and thread safe. Any changes are directly applied to this RiakObject.

Returns:

the RiakUserMetadata that containsKeyKey any/all User Meta entries for this RiakObject

isDeleted

public boolean isDeleted()

Returns whether or not this RiakObject is marked as being deleted (a tombstone)

Returns:

[true is this RiakObject is a tombstone, false otherwise

setDeleted

public RiakObject setDeleted(boolean isDeleted)

Marks this RiakObject as being a tombstone in Riak

Parameters:

isDeleted -

Returns:

a reference to this object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object