com.basho.riak.client.api.commands.mapreduce

Class IndexInput

java.lang.Object

com.basho.riak.client.api.commands.mapreduce.IndexInput

All Implemented Interfaces:

MapReduceInput

public class IndexInput
extends Object
implements MapReduceInput

MapReduce Input that uses the results of a Secondary Index(2i) query as the input for a MapReduce job.

Constructor Summary

Constructors

Constructor and Description
IndexInput(Namespace namespace, String index, com.basho.riak.client.api.commands.mapreduce.IndexInput.IndexCriteria criteria) Construct an IndexInput using the provided namespace, index name, and criteria.

Method Summary

Modifier and Type	Method and Description
com.basho.riak.client.api.commands.mapreduce.IndexInput.IndexCriteria	getCriteria() Gets the criteria for the 2i query.
String	getIndex() Gets the index name of the 2i query.
Namespace	getNamespace() Gets the namespace of the 2i query.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexInput

public IndexInput(Namespace namespace,
                  String index,
                  com.basho.riak.client.api.commands.mapreduce.IndexInput.IndexCriteria criteria)

Construct an IndexInput using the provided namespace, index name, and criteria.

Parameters:

namespace - the namespace that the index resides in

index - the secondary index to query

criteria - the secondary index criteria to search for

Method Detail

getNamespace

public Namespace getNamespace()

Gets the namespace of the 2i query.

Returns:

the namespace of the 2i query

getIndex

public String getIndex()

Gets the index name of the 2i query.

Returns:

the index name of the 2i query

getCriteria

public com.basho.riak.client.api.commands.mapreduce.IndexInput.IndexCriteria getCriteria()

Gets the criteria for the 2i query.

Returns:

the criteria for the 2i query