com.basho.riak.client.core.query.indexes

Class StringBinIndex

java.lang.Object

com.basho.riak.client.core.query.indexes.RiakIndex<String>

com.basho.riak.client.core.query.indexes.StringBinIndex

All Implemented Interfaces:

Iterable<String>

public class StringBinIndex
extends RiakIndex<String>

RiakIndex implementation used to access a Riak _bin Secondary Index using String values.

Data in Riak including secondary indexes is stored as bytes. This implementation of RiakIndex provides access to those bytes by converting to and from String values. Its type is IndexType.BIN

Riak 2i _bin indexes and sorting

One of the key features of 2i is the ability to do range queries. As previously noted the values are stored in Riak as bytes. Comparison is done byte-by-byte. UTF-8 lends itself well to this as its byte ordering is the same as its lexical ordering.

If you are using a character asSet whose byte ordering differs from its lexical ordering, range queries will be affected.

Since:

2.0

Author:

Brian Roach

See Also:

RiakIndexes, RiakObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringBinIndex.Name Encapsulates the name, character asSet, and IndexType for a StringBinIndex

Method Summary

Methods

Modifier and Type	Method and Description
protected String	convert(BinaryValue value) Convert bytes to a value type.
protected BinaryValue	convert(String value) Convert a value to a BinaryValue.
static RiakIndex.Name<StringBinIndex>	named(String name)
static StringBinIndex.Name	named(String name, Charset charset)

Methods inherited from class com.basho.riak.client.core.query.indexes.RiakIndex

add, add, equals, getFullname, getName, getType, hashCode, hasValue, isEmpty, iterator, rawValues, remove, remove, removeAll, size, toString, values

Methods inherited from class java.lang.Object

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

Method Detail

convert

protected BinaryValue convert(String value)

Description copied from class: RiakIndex

Convert a value to a BinaryValue.

Index values are stored internally as bytes. Concrete classes implement this method to convert values to bytes.

Specified by:

convert in class RiakIndex<String>

Parameters:

value - the value to convert

Returns:

a BinaryValue containing the converted bytes

convert

protected String convert(BinaryValue value)

Description copied from class: RiakIndex

Convert bytes to a value type.

Index values are stored internally as bytes. Concrete classes implement this method to convert bytes to values.

Specified by:

convert in class RiakIndex<String>

Parameters:

value - the value to convert

Returns:

a value of type T

named

public static RiakIndex.Name<StringBinIndex> named(String name)

named

public static StringBinIndex.Name named(String name,
                        Charset charset)