org.helenus.driver.impl

Class GroupStatementImpl<R,F extends com.google.common.util.concurrent.ListenableFuture<R>,T>

java.lang.Object

org.helenus.driver.impl.StatementImpl<R,F,T>

org.helenus.driver.impl.GroupStatementImpl<R,F,T>

Type Parameters:

R - The type of result returned when executing this statement

F - The type of future result returned when executing this statement

T - The type of POJO associated with this statement

All Implemented Interfaces:

GenericStatement<R,F>

Direct Known Subclasses:

CreateIndexImpl, CreateTableImpl, CreateTypeImpl, GroupImpl, TruncateImpl

public abstract class GroupStatementImpl<R,F extends com.google.common.util.concurrent.ListenableFuture<R>,T>
extends StatementImpl<R,F,T>

The GroupStatementImpl abstract class extends the StatementImpl class to provide support for a statement that represents a group (not a batch) of statements that can be executed in parallel.

Since:

1.0

Version:

1 - Jan 28, 2016 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2016 The Helenus Driver Project Authors

Field Summary

Fields inherited from class org.helenus.driver.impl.StatementImpl

bridge, CI_PREFIX, idempotent, isCounterOp, mgr, MK_PREFIX, resultClass, simpleSize, UDT_C_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GroupStatementImpl(Class<R> resultClass, ClassInfoImpl.Context context, StatementManagerImpl mgr, StatementBridge bridge) Instantiates a new GroupStatementImpl object.
protected	GroupStatementImpl(Class<R> resultClass, String keyspace, StatementManagerImpl mgr, StatementBridge bridge) Instantiates a new GroupStatementImpl object.
protected	GroupStatementImpl(GroupStatementImpl<R,F,T> group) Instantiates a new GroupStatementImpl object.

Method Summary

Modifier and Type	Method and Description
protected void	appendGroupType(StringBuilder builder) Appends the type of group this is; used when building a query string.
protected abstract List<StatementImpl<?,?,?>>	buildGroupedStatements() Gets all underlying grouped statements recursively in the proper order for this statement.
protected StringBuilder[]	buildQueryStrings() Builds the query strings (one per underlying statement) to be collected if the statement represents some a batch, sequence, or a group statement.
protected List<StatementImpl<?,?,?>>	buildStatements() Gets all underlying statements or this statement if none contained within.
protected com.datastax.driver.core.ResultSetFuture	executeAsyncRaw0() Executes the provided statement asynchronously and returned a raw result set.
int	getParallelFactor() Gets the number of simultaneous statements to send to the Cassandra cluster at the same time before starting to wait for all responses before proceeding to the next set (assuming a sequence is not reached before that).
Boolean	isIdempotent()
protected void	setDirty() Sets the dirty bit for the cached query string and clear the number of statements.
<H> H	setParallelFactor(int factor) Sets the number of simultaneous statements to send to the Cassandra cluster at the same time before starting to wait for all responses before proceeding to the next set (assuming a sequence is not reached before that).
protected int	simpleSize() Gets the number of simple statements in this statement.

Methods inherited from class org.helenus.driver.impl.StatementImpl

appendGroupSubType, appendOptions, buildQueryString, clearKeyspace, disable, disableErrorTracing, disableTracing, enable, enableErrorTracing, enableErrorTracing, enableTracing, enableTracing, execute, executeAsync, executeAsync0, executeAsyncRaw, executeRaw, getClassInfo, getClassInfoImpl, getConsistencyLevel, getContext, getDefaultTimestamp, getFetchSize, getKeyspace, getObject, getObjectClass, getPOJOContext, getQueryString, getReadTimeoutMillis, getRetryPolicy, getSerialConsistencyLevel, getUserData, init, init, isCounterOp, isDirty, isEnabled, isErrorTracing, isTracing, setConsistencyLevel, setCounterOp, setDefaultTimestamp, setDirty, setFetchSize, setIdempotent, setReadTimeoutMillis, setRetryPolicy, setSerialConsistencyLevel, setUserData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupStatementImpl

protected GroupStatementImpl(Class<R> resultClass,
                             ClassInfoImpl.Context context,
                             StatementManagerImpl mgr,
                             StatementBridge bridge)

Instantiates a new GroupStatementImpl object.

Parameters:

resultClass - the result class from the execution of this statement

context - the class info context for the POJO associated with this statement or null if this statement is not associated with a POJO

mgr - the non-null statement manager

bridge - the non-null statement bridge

Throws:

NullPointerException - if resultClass is null

IllegalArgumentException - if the result class is not a supported one

GroupStatementImpl

protected GroupStatementImpl(Class<R> resultClass,
                             String keyspace,
                             StatementManagerImpl mgr,
                             StatementBridge bridge)

Instantiates a new GroupStatementImpl object.

Parameters:

resultClass - the result class from the execution of this statement

keyspace - the keyspace for this statement if known

mgr - the non-null statement manager

bridge - the non-null statement bridge

Throws:

NullPointerException - if resultClass is null

IllegalArgumentException - if the result class is not a supported one

GroupStatementImpl

protected GroupStatementImpl(GroupStatementImpl<R,F,T> group)

Instantiates a new GroupStatementImpl object.

Parameters:

group - the non-null statement being copied or wrapped

Method Detail

buildGroupedStatements

protected abstract List<StatementImpl<?,?,?>> buildGroupedStatements()

Gets all underlying grouped statements recursively in the proper order for this statement.

Returns:

a non-null list of all underlying statements from this statement

appendGroupType

protected void appendGroupType(StringBuilder builder)

Appends the type of group this is; used when building a query string.

Overrides:

appendGroupType in class StatementImpl<R,F extends com.google.common.util.concurrent.ListenableFuture<R>,T>

Parameters:

builder - the builder to which to append the type of group

See Also:

StatementImpl.appendGroupType(java.lang.StringBuilder)

buildStatements

protected final List<StatementImpl<?,?,?>> buildStatements()

Gets all underlying statements or this statement if none contained within.

Note: Any statements that contains other statements should be flattened out based on its type. For example, a batch will flattened out all included batches recursively. A sequence will do the same with contained sequences but not with contained groups or batches. A group will do the same with contained groups but not with contained sequences or batches.

Overrides:

buildStatements in class StatementImpl<R,F extends com.google.common.util.concurrent.ListenableFuture<R>,T>

Returns:

a non-null list of all underlying statements from this statement

See Also:

StatementImpl.buildStatements()

simpleSize

protected final int simpleSize()

Gets the number of simple statements in this statement.

Specified by:

simpleSize in class StatementImpl<R,F extends com.google.common.util.concurrent.ListenableFuture<R>,T>

Returns:

the number of simple statements in this statement

See Also:

StatementImpl.simpleSize()

buildQueryStrings

protected final StringBuilder[] buildQueryStrings()

Builds the query strings (one per underlying statement) to be collected if the statement represents some a batch, sequence, or a group statement.

Specified by:

buildQueryStrings in class StatementImpl<R,F extends com.google.common.util.concurrent.ListenableFuture<R>,T>

Returns:

the string builders used to build the query strings to be collected or null if nothing to batch

See Also:

StatementImpl.buildQueryStrings()

setDirty

protected void setDirty()

Sets the dirty bit for the cached query string and clear the number of statements.

Overrides:

setDirty in class StatementImpl<R,F extends com.google.common.util.concurrent.ListenableFuture<R>,T>

See Also:

StatementImpl.setDirty()

executeAsyncRaw0

protected com.datastax.driver.core.ResultSetFuture executeAsyncRaw0()

Executes the provided statement asynchronously and returned a raw result set. A raw result set is in the raw form as returned by Cassandra's driver. This can be useful when doing SELECT statement that queries for COUNT(). This method does not block. It returns as soon as the statement has been passed to the underlying network stack. In particular, returning from this method does not guarantee that the statement is valid or has even been submitted to a live node. Any exception pertaining to the failure of the statement will be thrown when accessing the ResultSetFuture. Note that for queries that doesn't return a result (INSERT, UPDATE and DELETE), you will need to access the ResultSetFuture (that is call one of its get method) to make sure the statement was successful.

Overrides:

executeAsyncRaw0 in class StatementImpl<R,F extends com.google.common.util.concurrent.ListenableFuture<R>,T>

Returns:

a future on the raw result of the statement.

See Also:

StatementImpl.executeAsyncRaw0()

getParallelFactor

public int getParallelFactor()

Gets the number of simultaneous statements to send to the Cassandra cluster at the same time before starting to wait for all responses before proceeding to the next set (assuming a sequence is not reached before that).

By default, the parallel factor will be based on the number of nodes in the Cassandra cluster multiplied by 32 (default number of threads in the write pool of a Cassandra node).

Note: This value will be adjusted based on the maximum replication factor used by any of the statements. It will also be automatically limited to 32 if any of the statements affects all nodes such as schema, table, type, or index creation or alteration statements.

Returns:

the parallel factor to use when sending simultaneous statements

setParallelFactor

public <H> H setParallelFactor(int factor)

Sets the number of simultaneous statements to send to the Cassandra cluster at the same time before starting to wait for all responses before proceeding to the next set (assuming a sequence is not reached before that).

By default, the parallel factor will be based on the number of nodes in the Cassandra cluster multiplied by 32 (default number of threads in the write pool of a Cassandra node).

Note: This value will be adjusted based on the maximum replication factor used by any of the statements. It will also be automatically limited to 32 if any of the statements affects all nodes such as schema, table, type, or index creation or alteration statements.

Type Parameters:

H - the type of "this" to be returned

Parameters:

factor - the new parallel factor to use when sending simultaneous statements

Returns:

this group statement

isIdempotent

public Boolean isIdempotent()

Specified by:

isIdempotent in interface GenericStatement<R,F extends com.google.common.util.concurrent.ListenableFuture<R>>

Overrides:

isIdempotent in class StatementImpl<R,F extends com.google.common.util.concurrent.ListenableFuture<R>,T>

See Also:

StatementImpl.isIdempotent()