com.basho.riak.client.api.convert

Class Converter<T>

java.lang.Object

com.basho.riak.client.api.convert.Converter<T>

Type Parameters:

T - the type to convert to

Direct Known Subclasses:

JSONConverter, PassThroughConverter, StringConverter

public abstract class Converter<T>
extends Object

The Converter acts as a bridge between the core and the user level API, specifically for ORM.

Subclasses will override the fromDomain(java.lang.Object) and fromDomain(java.lang.Object) methods to convert the value portion of a RiakObject to a domain object.

Since:

2.0

Author:

Brian Roach

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Converter.ContentAndType
static class	Converter.OrmExtracted Encapsulation of ORM data extracted from a domain object.

Field Summary

Fields

Modifier and Type	Field and Description
protected Type	type

Constructor Summary

Constructors

Constructor and Description
Converter(Type type)

Method Summary

Modifier and Type	Method and Description
abstract Converter.ContentAndType	fromDomain(T domainObject) Provide the value portion of a RiakObject from the domain object.
Converter.OrmExtracted	fromDomain(T domainObject, Namespace namespace, BinaryValue key) Convert from a domain object to a RiakObject.
protected T	newDomainInstance()
abstract T	toDomain(BinaryValue value, String contentType) Convert the value portion of a RiakObject to a domain object.
T	toDomain(RiakObject obj, Location location) Converts from a RiakObject to a domain object.

Methods inherited from class java.lang.Object

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

Field Detail

type

protected final Type type

Constructor Detail

Converter

public Converter(Type type)

Method Detail

newDomainInstance

protected final T newDomainInstance()

toDomain

public T toDomain(RiakObject obj,
                  Location location)

Converts from a RiakObject to a domain object.

Parameters:

obj - the RiakObject to be converted

location - The location of this RiakObject in Riak

Returns:

an instance of the domain type T

toDomain

public abstract T toDomain(BinaryValue value,
                           String contentType)
                    throws ConversionException

Convert the value portion of a RiakObject to a domain object.

Implementations override this method to convert the value contained in a RiakObject to an instance of a domain object.

Parameters:

value - the value portion of a RiakObject to convert to a domain object

contentType - The content type of the RiakObject

Returns:

a new instance of the domain object

Throws:

ConversionException

fromDomain

public Converter.OrmExtracted fromDomain(T domainObject,
                                         Namespace namespace,
                                         BinaryValue key)

Convert from a domain object to a RiakObject.

The domain object itself may be completely annotated with everything required to produce a RiakObject except for the value portion. This will prefer annotated items over the Location passed in.

Parameters:

domainObject - a domain object to be stored in Riak.

namespace - the namespace in Riak

key - the key for the object

Returns:

data to be stored in Riak.

fromDomain

public abstract Converter.ContentAndType fromDomain(T domainObject)
                                             throws ConversionException

Provide the value portion of a RiakObject from the domain object.

Implementations override this method to provide the value portion of the RiakObject to be stored from the supplied domain object.

Parameters:

domainObject - the domain object.

Returns:

A BinaryValue to be stored in Riak

Throws:

ConversionException