com.basho.riak.client.api.commands.indexes.BinIndexQuery Maven / Gradle / Ivy
/*
* Copyright 2014 Basho Technologies Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.basho.riak.client.api.commands.indexes;
import com.basho.riak.client.api.commands.CoreFutureAdapter;
import com.basho.riak.client.core.RiakCluster;
import com.basho.riak.client.core.RiakFuture;
import com.basho.riak.client.core.operations.SecondaryIndexQueryOperation;
import com.basho.riak.client.core.query.Location;
import com.basho.riak.client.core.query.Namespace;
import com.basho.riak.client.core.query.indexes.IndexNames;
import com.basho.riak.client.core.util.BinaryValue;
import com.basho.riak.client.core.util.DefaultCharset;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
/**
* Performs a 2i query where the 2i index keys are strings.
*
*
* A RawIndexQuery is used when you are using strings for your 2i keys. The
* parameters are provided as String objects.
*
*
* {@code
* Namespace ns = new Namespace("my_type", "my_bucket");
* String key = "some_key";
* BinIndexQuery q = new BinIndexQuery.Builder(ns, "my_index", key).build();
* BinIndexQuery.Response resp = client.execute(q);}
*
* @author Brian Roach
* @since 2.0
*/
public class BinIndexQuery extends SecondaryIndexQuery
{
private final Charset charset;
private final IndexConverter converter;
protected BinIndexQuery(Init builder)
{
super(builder);
this.charset = builder.charset;
this.converter = new StringIndexConverter();
}
@Override
protected IndexConverter getConverter()
{
return converter;
}
@Override
protected RiakFuture executeAsync(RiakCluster cluster)
{
RiakFuture coreFuture =
executeCoreAsync(cluster);
BinQueryFuture future = new BinQueryFuture(coreFuture);
coreFuture.addListener(future);
return future;
}
@Override
public boolean equals(Object o)
{
if (this == o)
{
return true;
}
if (o == null || getClass() != o.getClass())
{
return false;
}
if (!super.equals(o))
{
return false;
}
BinIndexQuery that = (BinIndexQuery) o;
if (!charset.equals(that.charset))
{
return false;
}
if (!converter.equals(that.converter))
{
return false;
}
return true;
}
@Override
public int hashCode()
{
int result = super.hashCode();
result = 31 * result + charset.hashCode();
result = 31 * result + converter.hashCode();
return result;
}
protected static abstract class Init> extends SecondaryIndexQuery.Init
{
private Charset charset = DefaultCharset.get();
public Init(Namespace namespace, String indexName, S start, S end)
{
super(namespace, generateIndexName(indexName), start, end);
}
public Init(Namespace namespace, String indexName, S match)
{
super(namespace, generateIndexName(indexName), match);
}
public Init(Namespace namespace, String indexName, byte[] coverContext)
{
super(namespace, generateIndexName(indexName), coverContext);
}
private static String generateIndexName(String baseIndexName)
{
if(IndexNames.BUCKET.equalsIgnoreCase(baseIndexName) ||
IndexNames.KEY.equalsIgnoreCase(baseIndexName))
{
return baseIndexName;
}
return baseIndexName + Type._BIN;
}
T withCharacterSet(Charset charset)
{
this.charset = charset;
return self();
}
}
/**
* Builder used to construct a BinIndexQuery.
*/
public static class Builder extends Init
{
/**
* Construct a Builder for a BinIndexQuery with a cover context.
*
* Note that your index name should not include the Riak {@literal _int} or
* {@literal _bin} extension.
*
* @param namespace The namespace in Riak to query.
* @param indexName The name of the index in Riak.
* @param coverContext cover context.
*/
public Builder(Namespace namespace, String indexName, byte[] coverContext)
{
super(namespace, indexName, coverContext);
}
/**
* Construct a Builder for a BinIndexQuery with a range.
*
* Note that your index name should not include the Riak {@literal _int} or
* {@literal _bin} extension.
*
*
* @param namespace The namespace in Riak to query.
* @param indexName The index name in Riak to query.
* @param start The start of the 2i range.
* @param end The end of the 2i range.
*/
public Builder(Namespace namespace, String indexName, String start, String end)
{
super(namespace, indexName, start, end);
}
/**
* Construct a Builder for a BinIndexQuery with a single 2i key.
*
* Note that your index name should not include the Riak {@literal _int} or
* {@literal _bin} extension.
*
*
* @param namespace The namespace in Riak to query.
* @param indexName The name of the index in Riak.
* @param match the 2i key.
*/
public Builder(Namespace namespace, String indexName, String match)
{
super(namespace, indexName, match);
}
@Override
protected Builder self()
{
return this;
}
/**
* Construct the query.
*
* @return a new BinIndexQuery
*/
public BinIndexQuery build()
{
return new BinIndexQuery(this);
}
}
public static class Response extends SecondaryIndexQuery.Response
{
protected Response(Namespace queryLocation,
SecondaryIndexQueryOperation.Response coreResponse,
IndexConverter converter)
{
super(queryLocation, coreResponse, converter);
}
@Override
public List getEntries()
{
List convertedList = new ArrayList();
for (SecondaryIndexQueryOperation.Response.Entry e : coreResponse.getEntryList())
{
Location loc = getLocationFromCoreEntry(e);
Entry ce = new Entry(loc, e.getIndexKey(), converter);
convertedList.add(ce);
}
return convertedList;
}
public class Entry extends SecondaryIndexQuery.Response.Entry
{
protected Entry(Location riakObjectLocation, BinaryValue indexKey, IndexConverter converter)
{
super(riakObjectLocation, indexKey, converter);
}
}
}
protected final class BinQueryFuture
extends CoreFutureAdapter
{
public BinQueryFuture(RiakFuture
coreFuture)
{
super(coreFuture);
}
@Override
protected Response convertResponse(SecondaryIndexQueryOperation.Response coreResponse)
{
return new Response(namespace, coreResponse, converter);
}
@Override
protected BinIndexQuery convertQueryInfo(SecondaryIndexQueryOperation.Query coreQueryInfo)
{
return BinIndexQuery.this;
}
}
private class StringIndexConverter implements IndexConverter
{
@Override
public String convert(BinaryValue input)
{
return input.toString(charset);
}
@Override
public BinaryValue convert(String input)
{
if (input == null )
{
return null;
}
return BinaryValue.create(input, charset);
}
@Override
public boolean equals(Object o)
{
if (this == o)
{
return true;
}
if (o == null || getClass() != o.getClass())
{
return false;
}
return true;
}
@Override
public int hashCode()
{
return 0;
}
}
}