RiakIndex (Riak Client for Java 2.0.0 API)

java.lang.Object
- com.basho.riak.client.core.query.indexes.RiakIndex<T>

All Implemented Interfaces:

Iterable<T>

Direct Known Subclasses:

BigIntIndex, LongIntIndex, RawIndex, StringBinIndex
```
public abstract class RiakIndex<T>
extends Object
implements Iterable<T>
```
Abstract base class for modeling a Riak Secondary Index (2i).
Secondary Indexing (2i) in Riak gives developers the ability, at write time, to tag an object stored in Riak with one or more queryable values. Since the KV data is completely opaque to 2i, the user must tell 2i exactly what attribute to index on and what its index value should be, via key/value metadata. This is different from Search, which parses the data and builds indexes based on a schema. Riak 2i currently requires the LevelDB or Memory backend.

A RiakIndex is made up of the index name, a type, then one or more queryable index values.

RiakIndex instances are created and managed via the RiakIndexes container.

Since:

2.0

Author:

Brian Roach

See Also:
RiakIndexes, Using Secondary Indexes in Riak

Thread Safety:
This class is designed to be thread safe.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RiakIndex.Name<T extends RiakIndex>
Abstract base class used to encapsulate a RiakIndex name and type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RiakIndex.Name<T extends RiakIndex>` Abstract base class used to encapsulate a `RiakIndex` name and type.

Constructor Summary

Constructors
Modifier Constructor and Description

protected RiakIndex(RiakIndex.Name<?> name)
Constructs a RiakIndex from the supplied RiakIndex.Name

Constructors
Modifier	Constructor and Description
`protected`	`RiakIndex(RiakIndex.Name<?> name)` Constructs a RiakIndex from the supplied RiakIndex.Name

Method Summary

Methods
Modifier and Type	Method and Description
`RiakIndex<T>`	`add(Collection<T> values)` Add a asSet of values to this secondary index.
`RiakIndex<T>`	`add(T value)` Add a value to this secondary index.
`protected abstract T`	`convert(BinaryValue value)` Convert bytes to a value type.
`protected abstract BinaryValue`	`convert(T value)` Convert a value to a BinaryValue.
`boolean`	`equals(Object obj)` Indicates whether this RiakIndex is "equal to" another RiakIndex.
`String`	`getFullname()` Get the fully qualified name of this index
`String`	`getName()` Get the index's name.
`IndexType`	`getType()` Get the type of this index.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`hasValue(T value)` Determine if this index contains a value
`boolean`	`isEmpty()` Determine if this index has any values.
`Iterator<T>`	`iterator()` Returns an iterator over the asSet of values in this index.
`Set<BinaryValue>`	`rawValues()` Return the values in this index as raw bytes.
`RiakIndex<T>`	`remove(Collection<T> values)` Remove a asSet of values from this index
`RiakIndex<T>`	`remove(T value)` Remove a value from this index.
`RiakIndex<T>`	`removeAll()` Remove all values from this index
`int`	`size()` Return the number of values in this index.
`String`	`toString()`
`Set<T>`	`values()` Return the values in this index.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RiakIndex
```
protected RiakIndex(RiakIndex.Name<?> name)
```
    Constructs a RiakIndex from the supplied RiakIndex.Name
    
    Parameters:
    name - A RiakIndex.Name to build this RiakIndex from.
- Method Detail
  - add
```
public final RiakIndex<T> add(T value)
```
    Add a value to this secondary index.
    
    Parameters:
    value - the value to add
    
    Returns:
    a reference to this object
  - add
```
public final RiakIndex<T> add(Collection<T> values)
```
    Add a asSet of values to this secondary index.
    
    Parameters:
    values - a collection of values to add
    
    Returns:
    a reference to this object
  - hasValue
```
public final boolean hasValue(T value)
```
    Determine if this index contains a value
    
    Parameters:
    value - the value to check for
    
    Returns:
    true if this index contains the value, false otherwise.
  - remove
```
public final RiakIndex<T> remove(T value)
```
    Remove a value from this index.
    
    Parameters:
    value - the value to remove
    
    Returns:
    a reference to this object
  - remove
```
public final RiakIndex<T> remove(Collection<T> values)
```
    Remove a asSet of values from this index
    
    Parameters:
    values - a collection of values to remove
    
    Returns:
    a reference to this object
  - removeAll
```
public final RiakIndex<T> removeAll()
```
    Remove all values from this index
    
    Returns:
    a reference to this object
  - iterator
```
public final Iterator<T> iterator()
```
    Returns an iterator over the asSet of values in this index. This iterator is a "weakly consistent" iterator that will never throw ConcurrentModificationException, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.
    
    Specified by:
    
    iterator in interface Iterable<T>
    
    Returns:
    an Iterator.
  - size
```
public final int size()
```
    Return the number of values in this index.
    
    Returns:
    the number of values
  - isEmpty
```
public final boolean isEmpty()
```
    Determine if this index has any values.
    
    Returns:
    true if this index has no values, false otherwise.
  - rawValues
```
public final Set<BinaryValue> rawValues()
```
    Return the values in this index as raw bytes.
    
    Returns:
    an unmodifiable view of the raw values in this index.
  - values
```
public final Set<T> values()
```
    Return the values in this index. The returned Set is unmodifiable.
    
    Returns:
    an unmodifiable view of the values in this index.
  - getType
```
public final IndexType getType()
```
    Get the type of this index.
    
    Returns:
    the enum representing the type of this index
  - getName
```
public final String getName()
```
    Get the index's name.
    
    Returns:
    the name of this index without the type suffix
  - getFullname
```
public final String getFullname()
```
    Get the fully qualified name of this index
    
    Returns:
    the name of this index including the type suffix
  - convert
```
protected abstract BinaryValue convert(T value)
```
    Convert a value to a BinaryValue.
    Index values are stored internally as bytes. Concrete classes implement this method to convert values to bytes.
    
    Parameters:
    value - the value to convert
    
    Returns:
    a BinaryValue containing the converted bytes
  - convert
```
protected abstract T convert(BinaryValue value)
```
    Convert bytes to a value type.
    Index values are stored internally as bytes. Concrete classes implement this method to convert bytes to values.
    
    Parameters:
    value - the value to convert
    
    Returns:
    a value of type T
  - hashCode
```
public final int hashCode()
```
    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hash code value for this object.
    See Also:
    RiakIndex.equals(java.lang.Object)
  - equals
```
public final boolean equals(Object obj)
```
    Indicates whether this RiakIndex is "equal to" another RiakIndex.
    Only the name and index type of the RiakIndex are used to determine equality.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - a RiakIndex
    
    Returns:
    true if this RiakIndex has the same name and type
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RiakIndex<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RiakIndex

Method Detail

add

add

hasValue

remove

remove

removeAll

iterator

size

isEmpty

rawValues

values

getType

getName

getFullname

convert

convert

hashCode

equals

toString