com.basho.riak.client.convert

Annotation Type RiakIndex

@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
public @interface RiakIndex

Annotation to declare a field as a RiakIndex.

You do not need to specify the index type prefix (_bin/_int). It will be inferred from the type of the annotated field. Only String/Long/long or Set<String> / Set<Long> fields may be annotated with RiakIndex. Prior to v1.1.0 the _int index support was implemented using int / Integer. The current code still supports this for legacy purposes but all new code should use long / Long

NOTE: if there are *multiple* values for the same named index and the field in the domain object is an long, Long, or String only the 1st will find it's way into the domain object

For example:

 
 public class MyClass {
     @RiakKey
     private String myKeyString;
     
     @RiakIndex(name="email")
     private String emailAddress; // will be indexed in email_bin index
     
     @RiakIndex(name="age")
     private long age; // will be index in age_int index
 }
  
 

Author:

russell

See Also:

JSONConverter, DefaultBucket

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name

Element Detail

name

public abstract String name

Returns:

the index name

Default:

""