com.basho.riak.client.raw.query.indexes.IndexQuery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of riak-client Show documentation

HttpClient-based client for Riak

There is a newer version: 2.1.1

/*
 * This file is provided to you 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.raw.query.indexes;

import java.io.IOException;

/**
 * Base marker interface for 2i queries
 * 
 * @author russell
 * 
 */
public interface IndexQuery {

    /**
     * @return the full name of the index to query (including type suffix)
     */
    String getIndex();

    /**
     * @return the name of the bucket to query
     */
    String getBucket();

    /**
     * Write the index query to the given writer
     * 
     * @param 
     * 
     * @param writer
     *            an {@link IndexWriter}
     * @throws IOException
     */
    void write(IndexWriter writer) throws IOException;
}