com.github.helenusdriver.driver.Sequence Maven / Gradle / Ivy
Show all versions of api Show documentation
/*
* Copyright (C) 2015-2015 The Helenus Driver Project Authors.
*
* 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.github.helenusdriver.driver;
import com.datastax.driver.core.ResultSet;
import com.datastax.driver.core.ResultSetFuture;
import com.google.common.util.concurrent.ListenableFuture;
/**
* The Sequence interface defines support for a statement that
* can execute a set of statements in sequence returning the result set from
* the last one only.
*
* @copyright 2015-2015 The Helenus Driver Project Authors
*
* @author The Helenus Driver Project Authors
* @version 1 - Jan 15, 2015 - paouelle - Creation
*
* @since 1.0
*/
public interface Sequence
extends GenericStatement, SequenceableStatement {
/**
* {@inheritDoc}
*
* Gets the keyspace of the first statement in this sequence.
*
* @author paouelle
*
* @return the keyspace from the first statement in this sequence or
* null if the sequence is empty
*
* @see com.github.helenusdriver.driver.GenericStatement#getKeyspace()
*/
@Override
public String getKeyspace();
/**
* Checks if the sequence has no statements added.
*
* @author paouelle
*
* @return true if no statements were added to the sequence;
* false otherwise
*/
public boolean isEmpty();
/**
* Gets the number of statements that are part of this sequence.
*
* @author paouelle
*
* @return the number of statements in this sequence
*/
public int size();
/**
* Removes all statements already added to this sequence.
*
* @author paouelle
*/
public void clear();
/**
* Adds a new statement to this sequence.
*
* @author paouelle
*
* @param The type of result returned when executing the statement to sequence
* @param The type of future result returned when executing the statement
* to sequence
*
* @param statement the new statement to add
* @return this sequence
* @throws NullPointerException if statement is null
*/
public > Sequence add(SequenceableStatement statement);
/**
* Adds a new raw Cassandra statement to this sequence.
*
* @author paouelle
*
* @param statement the new statement to add
* @return this sequence
* @throws NullPointerException if statement is null
*/
public Sequence add(com.datastax.driver.core.RegularStatement statement);
/**
* {@inheritDoc}
*
* Note: This might not actually be a valid query string if there are
* more than one statement being sequence. it will then be a representation
* of the query strings for each statement similar to a "BATCH" statement.
*
* @author paouelle
*
* @see com.github.helenusdriver.driver.GenericStatement#getQueryString()
*/
@Override
public String getQueryString();
/**
* {@inheritDoc}
*
* Note: This method will execute all statements in sequence one after
* the other until one generates an error or all of them have succeeded.
*
* @author paouelle
*
* @see com.github.helenusdriver.driver.GenericStatement#execute()
*/
@Override
public Void execute();
/**
* {@inheritDoc}
*
* Note: This method will execute all statements asynchronously and in
* sequence one after the other until one generates an error and return a
* future void result.
*
* @author paouelle
*
* @see com.github.helenusdriver.driver.GenericStatement#executeAsync()
*/
@Override
public VoidFuture executeAsync();
/**
* {@inheritDoc}
*
* Note: This method will execute all statements in sequence one after
* the other until one generates an error and return the result set from that
* last one.
*
* @author paouelle
*
* @see com.github.helenusdriver.driver.GenericStatement#executeRaw()
*/
@Override
public ResultSet executeRaw();
/**
* {@inheritDoc}
*
* Note: This method will execute all statements asynchronously and in
* sequence one after the other until one generates an error and return a
* future result set which will allow one to retrieve the result set from that
* last executed statement.
*
* @author paouelle
*
* @see com.github.helenusdriver.driver.GenericStatement#executeAsyncRaw()
*/
@Override
public ResultSetFuture executeAsyncRaw();
}