org.helenus.driver.impl

Class BatchImpl

java.lang.Object

org.helenus.driver.impl.StatementImpl<Void,VoidFuture,Void>

org.helenus.driver.impl.BatchImpl

All Implemented Interfaces:

Batch, BatchableStatement<Void,VoidFuture>, GenericStatement<Void,VoidFuture>, GroupableStatement<Void,VoidFuture>, ParentStatementImpl, ParentStatement, SequenceableStatement<Void,VoidFuture>

public class BatchImpl
extends StatementImpl<Void,VoidFuture,Void>
implements Batch, ParentStatementImpl

The BatchImpl class extends the functionality of Cassandra's Batch class to provide support for POJOs.

Since:

1.0

Version:

1 - Jan 19, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2016 The Helenus Driver Project Authors

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchImpl.OptionsImpl The OptionsImpl class defines the options of a BATCH statement.

Nested classes/interfaces inherited from interface org.helenus.driver.Batch

Batch.Options

Field Summary

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

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

Fields inherited from interface org.helenus.driver.Batch

RECOMMENDED_MAX

Constructor Summary

Constructors

Constructor and Description
BatchImpl(Optional<Recorder> recorder, BatchableStatement<?,?>[] statements, boolean logged, StatementManagerImpl mgr, StatementBridge bridge) Instantiates a new BatchImpl object.
BatchImpl(Optional<Recorder> recorder, Iterable<BatchableStatement<?,?>> statements, boolean logged, StatementManagerImpl mgr, StatementBridge bridge) Instantiates a new BatchImpl object.

Method Summary

Modifier and Type	Method and Description
<R,F extends com.google.common.util.concurrent.ListenableFuture<R>> Batch	add(BatchableStatement<R,F> statement)
Batch	add(com.datastax.driver.core.RegularStatement statement)
Batch	addErrorHandler(ERunnable<?> run)
protected void	appendGroupSubType(StringBuilder builder) Appends the sub-type of group this is; used when building a query string.
protected void	appendGroupType(StringBuilder builder) Appends the type of group this is; used when building a query string.
protected void	appendOptions(StringBuilder builder) Called to append options to the query string when building a batch.
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.
void	clear()
Batch	duplicate()
Batch	duplicate(Recorder recorder)
String	getKeyspace()
Optional<Recorder>	getRecorder()
<U> Optional<Using<U>>	getUsing(String name)
boolean	hasReachedRecommendedSize()
boolean	hasReachedRecommendedSizeFor(Class<?> clazz)
boolean	hasReachedRecommendedSizeFor(ClassInfo<?> cinfo)
boolean	isEmpty()
java.util.stream.Stream<ObjectStatement<?>>	objectStatements() Gets all object statements contained recursively in this parent statement.
void	recorded(ObjectStatement<?> statement, ParentStatement pstatement) Notifies the registered recorder and parent of the specified object statement.
void	runErrorHandlers()
protected void	setDirty() Sets the dirty bit for the cached query string and clear the number of statements.
protected void	setDirty(boolean recurse) Sets the dirty bit for the cached query string and clear the number of statements potentially recursively for all contained statement.
void	setParent(ParentStatementImpl parent) Sets the parent for this statement.
protected int	simpleSize() Gets the number of simple statements in this statement.
int	size()
java.util.stream.Stream<GenericStatement<?,?>>	statements() Gets all statements contained recursively in this parent statement including parent statements (and this one).
Batch.Options	using(Using<?> using) Adds a new options for this BATCH statement.
java.util.stream.Stream<Using<?>>	usings()

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.helenus.driver.GenericStatement

disable, disableErrorTracing, disableTracing, enable, enableErrorTracing, enableErrorTracing, enableTracing, enableTracing, execute, executeAsync, executeAsyncRaw, executeRaw, getConsistencyLevel, getDefaultTimestamp, getFetchSize, getQueryString, getReadTimeoutMillis, getRetryPolicy, getSerialConsistencyLevel, getUserData, isEnabled, isErrorTracing, isIdempotent, isTracing, setConsistencyLevel, setDefaultTimestamp, setFetchSize, setIdempotent, setReadTimeoutMillis, setRetryPolicy, setSerialConsistencyLevel, setUserData

Methods inherited from interface org.helenus.driver.ParentStatement

resetIfErrors, setAndResetIfErrors

Constructor Detail

BatchImpl

public BatchImpl(Optional<Recorder> recorder,
                 BatchableStatement<?,?>[] statements,
                 boolean logged,
                 StatementManagerImpl mgr,
                 StatementBridge bridge)

Instantiates a new BatchImpl object.

Parameters:

recorder - the optional recorder to register with this batch

statements - the statements to batch

logged - true if the batch should be logged; false if it should be unlogged

mgr - the non-null statement manager

bridge - the non-null statement bridge

Throws:

NullPointerException - if statement or any of the statements are null

IllegalArgumentException - if counter and non-counter operations are mixed

BatchImpl

public BatchImpl(Optional<Recorder> recorder,
                 Iterable<BatchableStatement<?,?>> statements,
                 boolean logged,
                 StatementManagerImpl mgr,
                 StatementBridge bridge)

Instantiates a new BatchImpl object.

Parameters:

recorder - the optional recorder to register with this batch

statements - the statements to batch

logged - true if the batch should be logged; false if it should be unlogged

mgr - the non-null statement manager

bridge - the non-null statement bridge

Throws:

NullPointerException - if statement or any of the statements are null

IllegalArgumentException - if counter and non-counter operations are mixed

Method Detail

appendGroupType

protected void appendGroupType(StringBuilder builder)

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

Overrides:

appendGroupType in class StatementImpl<Void,VoidFuture,Void>

Parameters:

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

See Also:

StatementImpl.appendGroupType(java.lang.StringBuilder)

appendGroupSubType

protected void appendGroupSubType(StringBuilder builder)

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

Overrides:

appendGroupSubType in class StatementImpl<Void,VoidFuture,Void>

Parameters:

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

See Also:

StatementImpl.appendGroupSubType(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<Void,VoidFuture,Void>

Returns:

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

See Also:

StatementImpl.buildStatements()

simpleSize

protected int simpleSize()

Gets the number of simple statements in this statement.

Specified by:

simpleSize in class StatementImpl<Void,VoidFuture,Void>

Returns:

the number of simple statements in this statement

See Also:

StatementImpl.simpleSize()

buildQueryStrings

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.

Specified by:

buildQueryStrings in class StatementImpl<Void,VoidFuture,Void>

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<Void,VoidFuture,Void>

See Also:

StatementImpl.setDirty()

setDirty

protected void setDirty(boolean recurse)

Sets the dirty bit for the cached query string and clear the number of statements potentially recursively for all contained statement.

Overrides:

setDirty in class StatementImpl<Void,VoidFuture,Void>

Parameters:

recurse - true to recursively set the dirty bit; false to simply set this statement dirty bit

See Also:

StatementImpl.setDirty(boolean)

appendOptions

protected void appendOptions(StringBuilder builder)

Called to append options to the query string when building a batch.

Overrides:

appendOptions in class StatementImpl<Void,VoidFuture,Void>

Parameters:

builder - the builder to which to append options

See Also:

StatementImpl.appendOptions(java.lang.StringBuilder)

setParent

public void setParent(ParentStatementImpl parent)

Sets the parent for this statement.

Specified by:

setParent in interface ParentStatementImpl

Parameters:

parent - the parent for this statement

See Also:

ParentStatementImpl.setParent(org.helenus.driver.impl.ParentStatementImpl)

recorded

public void recorded(ObjectStatement<?> statement,
                     ParentStatement pstatement)

Notifies the registered recorder and parent of the specified object statement.

Specified by:

recorded in interface ParentStatementImpl

Parameters:

statement - the non-null object statement that was recorded

pstatement - the non-null parent where the statement was defined

See Also:

ParentStatementImpl.recorded(org.helenus.driver.ObjectStatement, org.helenus.driver.ParentStatement)

objectStatements

public java.util.stream.Stream<ObjectStatement<?>> objectStatements()

Gets all object statements contained recursively in this parent statement.

Specified by:

objectStatements in interface ParentStatementImpl

Returns:

a stream of all object statements contained recursively in this parent

See Also:

ParentStatementImpl.objectStatements()

statements

public java.util.stream.Stream<GenericStatement<?,?>> statements()

Gets all statements contained recursively in this parent statement including parent statements (and this one).

Specified by:

statements in interface ParentStatementImpl

Returns:

a stream of all statements contained recursively in this parent

See Also:

ParentStatementImpl.statements()

getKeyspace

public String getKeyspace()

Gets the keyspace of the first statement in this batch.

Specified by:

getKeyspace in interface Batch

Specified by:

getKeyspace in interface GenericStatement<Void,VoidFuture>

Overrides:

getKeyspace in class StatementImpl<Void,VoidFuture,Void>

Returns:

the keyspace from the first statement in this batch or null if the batch is empty

See Also:

StatementImpl.getKeyspace()

getRecorder

public Optional<Recorder> getRecorder()

Specified by:

getRecorder in interface ParentStatementImpl

Specified by:

getRecorder in interface ParentStatement

See Also:

ParentStatement.getRecorder()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ParentStatement

See Also:

ParentStatement.isEmpty()

hasReachedRecommendedSize

public boolean hasReachedRecommendedSize()

Specified by:

hasReachedRecommendedSize in interface Batch

See Also:

Batch.hasReachedRecommendedSize()

hasReachedRecommendedSizeFor

public boolean hasReachedRecommendedSizeFor(Class<?> clazz)

Specified by:

hasReachedRecommendedSizeFor in interface Batch

See Also:

Batch.hasReachedRecommendedSizeFor(java.lang.Class)

hasReachedRecommendedSizeFor

public boolean hasReachedRecommendedSizeFor(ClassInfo<?> cinfo)

Specified by:

hasReachedRecommendedSizeFor in interface Batch

See Also:

Batch.hasReachedRecommendedSizeFor(org.helenus.driver.info.ClassInfo)

size

public int size()

Specified by:

size in interface ParentStatement

See Also:

ParentStatement.size()

clear

public void clear()

Specified by:

clear in interface ParentStatement

See Also:

ParentStatement.clear()

add

public <R,F extends com.google.common.util.concurrent.ListenableFuture<R>> Batch add(BatchableStatement<R,F> statement)

Specified by:

add in interface Batch

Specified by:

add in interface ParentStatement

See Also:

Batch.add(org.helenus.driver.BatchableStatement)

add

public Batch add(com.datastax.driver.core.RegularStatement statement)

Specified by:

add in interface Batch

Specified by:

add in interface ParentStatement

See Also:

Batch.add(com.datastax.driver.core.RegularStatement)

addErrorHandler

public Batch addErrorHandler(ERunnable<?> run)

Specified by:

addErrorHandler in interface Batch

Specified by:

addErrorHandler in interface ParentStatement

See Also:

Batch.addErrorHandler(org.helenus.util.function.ERunnable)

runErrorHandlers

public void runErrorHandlers()

Specified by:

runErrorHandlers in interface ParentStatement

See Also:

ParentStatement.runErrorHandlers()

using

public Batch.Options using(Using<?> using)

Adds a new options for this BATCH statement.

Specified by:

using in interface Batch

Parameters:

using - the option to add

Returns:

the options of this BATCH statement

usings

public java.util.stream.Stream<Using<?>> usings()

Specified by:

usings in interface Batch

See Also:

Insert.usings()

getUsing

public <U> Optional<Using<U>> getUsing(String name)

Specified by:

getUsing in interface Batch

See Also:

Insert.getUsing(java.lang.String)

duplicate

public Batch duplicate()

Specified by:

duplicate in interface Batch

See Also:

Batch.duplicate()

duplicate

public Batch duplicate(Recorder recorder)

Specified by:

duplicate in interface Batch

See Also:

Batch.duplicate(org.helenus.driver.Recorder)