com.basho.riak.client.core.query.search

Class YokozunaIndex

java.lang.Object

com.basho.riak.client.core.query.search.YokozunaIndex

public class YokozunaIndex
extends Object

Represents a Yokozuna Index.

Author:

Brian Roach

Constructor Summary

Constructors

Constructor and Description
YokozunaIndex(String name) Constructs a Yokozuna index without naming the schema.
YokozunaIndex(String name, String schema) Constructs a Yokozuna index.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of this index as a UTF-8.
Integer	getNVal() Get the nVal.
String	getSchema() Returns the schema name for this index.
boolean	hasNVal() Determine if an nVal value has been set.
YokozunaIndex	withNVal(int nVal) Set the nVal.

Methods inherited from class java.lang.Object

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

Constructor Detail

YokozunaIndex

public YokozunaIndex(String name)

Constructs a Yokozuna index without naming the schema. Due to an implementation detail on the Riak side, the index name is restricted to US-ASCII characters. The supplied String is converted to bytes using the UTF-8 Charset.

Parameters:

name - The name for this index.

YokozunaIndex

public YokozunaIndex(String name,
                     String schema)

Constructs a Yokozuna index. Due to an implementation detail on the Riak side, the index name is restricted to US-ASCII characters. The supplied String is converted to bytes using the UTF-8 Charset.

Parameters:

name - The name of the index.

schema - The name of a schema

Method Detail

withNVal

public YokozunaIndex withNVal(int nVal)

Set the nVal.

Parameters:

nVal - the number of replicas.

Returns:

a reference to this object.

getName

public String getName()

Returns the name of this index as a UTF-8.

Returns:

The name of the index as UTF-8 encoded String.

getSchema

public String getSchema()

Returns the schema name for this index.

Returns:

The schema name.

hasNVal

public boolean hasNVal()

Determine if an nVal value has been set.

Returns:

true if set, false otherwise.

getNVal

public Integer getNVal()

Get the nVal.

Returns:

the nVal value or null if not set.