com.basho.riak.client.api.commands.timeseries.Delete 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
The newest version!
package com.basho.riak.client.api.commands.timeseries;

import com.basho.riak.client.api.AsIsRiakCommand;
import com.basho.riak.client.core.FutureOperation;
import com.basho.riak.client.core.operations.ts.DeleteOperation;
import com.basho.riak.client.core.query.timeseries.Cell;

/**
 * Time Series Delete Command
 * Allows you to delete a single time series row by its key values.
 *
 * @author Alex Moore 
 * @author Sergey Galkin 
 * @since 2.0.3
 */
public class Delete extends AsIsRiakCommand
{
    private final Builder builder;

    private Delete(Builder builder)
    {
        this.builder = builder;
    }

    @Override
    protected FutureOperation buildCoreOperation() {
        final DeleteOperation.Builder opBuilder =
                new DeleteOperation.Builder(this.builder.tableName, builder.keyValues);

        if (builder.timeout > 0)
        {
            opBuilder.withTimeout(builder.timeout);
        }

        return opBuilder.build();
    }

    /**
     * Used to construct a Time Series Delete command.
     */
    public static class Builder
    {
        private final String tableName;
        private final Iterable keyValues;
        private int timeout;

        /**
         * Construct a Builder for a Time Series Delete command.
         * @param tableName Required. The name of the table to delete from.
         * @param keyValues Required. The cells that make up the key that identifies which row to delete.
         *                  Must be in the same order as the table definition.
         */
        public Builder(String tableName, Iterable keyValues)
        {
            if (tableName == null || tableName.length() == 0)
            {
                throw new IllegalArgumentException("Table Name cannot be null or an empty string.");
            }

            if (keyValues == null || !keyValues.iterator().hasNext())
            {
                throw new IllegalArgumentException("Key Values cannot be null or an empty.");
            }

            this.tableName = tableName;
            this.keyValues = keyValues;
        }

        /**
         * Set the Riak-side timeout value.
         * 
         * By default, Riak has a 60s timeout for operations. Setting
         * this value will override that default for this operation.
         * 
         * @param timeout the timeout in milliseconds to be sent to riak.
         * @return a reference to this object.
         */
        public Builder withTimeout(int timeout)
        {
            if (timeout < 1)
            {
                throw new IllegalArgumentException("Timeout must be a positive integer");
            }

            this.timeout = timeout;
            return this;
        }

        /**
         * Construct a Time Series Delete object.
         * @return a new Time Series Delete instance.
         */
        public Delete build()
        {
            return new Delete(this);
        }
    }
}