com.datastax.driver.core

Class SimpleStatement

java.lang.Object

com.datastax.driver.core.Statement

com.datastax.driver.core.RegularStatement

com.datastax.driver.core.SimpleStatement

public class SimpleStatement
extends RegularStatement

A simple RegularStatement implementation built directly from a query string.

Use Session.newSimpleStatement(String) to create a new instance of this class.

Field Summary

Fields inherited from class com.datastax.driver.core.Statement

idempotent, NULL_PAYLOAD_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleStatement(String query, Cluster cluster)
protected	SimpleStatement(String query, Cluster cluster, Object... values)

Method Summary

Modifier and Type	Method and Description
static ByteBuffer[]	convert(Object[] values, ProtocolVersion protocolVersion, CodecRegistry codecRegistry) Utility method to serialize user-provided values.
String	getKeyspace() Returns the keyspace this query operates on.
Object	getObject(int i) Returns the ith value as the Java type matching its CQL type.
String	getQueryString() Returns the query string for this statement.
ByteBuffer	getRoutingKey() Returns the routing key for the query.
ByteBuffer[]	getValues() The values to use for this statement.
boolean	hasValues() Whether or not this statement has values, that is if getValues will return null or not.
SimpleStatement	setKeyspace(String keyspace) Sets the keyspace this query operates on.
SimpleStatement	setRoutingKey(ByteBuffer... routingKeyComponents) Sets the routing key for this query.
SimpleStatement	setRoutingKey(ByteBuffer routingKey) Sets the routing key for this query.
int	valuesCount() The number of values for this statement, that is the size of the array that will be returned by getValues.

Methods inherited from class com.datastax.driver.core.RegularStatement

toString

Methods inherited from class com.datastax.driver.core.Statement

disableTracing, enableTracing, getConsistencyLevel, getDefaultTimestamp, getFetchSize, getRetryPolicy, getSerialConsistencyLevel, isIdempotent, isTracing, setConsistencyLevel, setDefaultTimestamp, setFetchSize, setIdempotent, setOutgoingPayload, setPagingState, setPagingStateUnsafe, setRetryPolicy, setSerialConsistencyLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleStatement

protected SimpleStatement(String query,
                          Cluster cluster)

SimpleStatement

protected SimpleStatement(String query,
                          Cluster cluster,
                          Object... values)

Method Detail

getQueryString

public String getQueryString()

Description copied from class: RegularStatement

Returns the query string for this statement.

Specified by:

getQueryString in class RegularStatement

Returns:

a valid CQL query string.

getValues

public ByteBuffer[] getValues()

The values to use for this statement.

Note: Values for a RegularStatement (i.e. if this method does not return null) are not supported with the native protocol version 1: you will get an UnsupportedProtocolVersionException when submitting one if version 1 of the protocol is in use (i.e. if you've force version 1 through Cluster.Builder.withProtocolVersion(com.datastax.driver.core.ProtocolVersion) or you use Cassandra 1.2).

Note: Calling this method may trigger the underlying Cluster initialization.

Specified by:

getValues in class RegularStatement

See Also:

SimpleStatement(String, Cluster, Object...)

valuesCount

public int valuesCount()

The number of values for this statement, that is the size of the array that will be returned by getValues.

Returns:

the number of values.

hasValues

public boolean hasValues()

Description copied from class: RegularStatement

Whether or not this statement has values, that is if getValues will return null or not.

Specified by:

hasValues in class RegularStatement

Returns:

false if RegularStatement.getValues() returns null, true otherwise.

getObject

public Object getObject(int i)

Returns the ith value as the Java type matching its CQL type.

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value of this statement.

Throws:

IllegalStateException - if this statement does not have values.

IndexOutOfBoundsException - if i is not a valid index for this object.

getRoutingKey

public ByteBuffer getRoutingKey()

Returns the routing key for the query.

Unless the routing key has been explicitly set through setRoutingKey(java.nio.ByteBuffer), this method will return null to avoid having to parse the query string to retrieve the partition key.

Specified by:

getRoutingKey in class Statement

Returns:

the routing key set through setRoutingKey(java.nio.ByteBuffer) if such a key was set, null otherwise.

See Also:

Statement.getRoutingKey()

setRoutingKey

public SimpleStatement setRoutingKey(ByteBuffer routingKey)

Sets the routing key for this query.

This method allows you to manually provide a routing key for this query. It is thus optional since the routing key is only an hint for token aware load balancing policy but is never mandatory.

If the partition key for the query is composite, use the setRoutingKey(ByteBuffer...) method instead to build the routing key.

Parameters:

routingKey - the raw (binary) value to use as routing key.

Returns:

this SimpleStatement object.

See Also:

Statement.getRoutingKey()

getKeyspace

public String getKeyspace()

Returns the keyspace this query operates on.

Unless the keyspace has been explicitly set through setKeyspace(java.lang.String), this method will return null to avoid having to parse the query string.

Specified by:

getKeyspace in class Statement

Returns:

the keyspace set through setKeyspace(java.lang.String) if such keyspace was set, null otherwise.

See Also:

Statement.getKeyspace()

setKeyspace

public SimpleStatement setKeyspace(String keyspace)

Sets the keyspace this query operates on.

This method allows you to manually provide a keyspace for this query. It is thus optional since the value returned by this method is only an hint for token aware load balancing policy but is never mandatory.

Do note that if the query does not use a fully qualified keyspace, then you do not need to set the keyspace through that method as the currently logged in keyspace will be used.

Parameters:

keyspace - the name of the keyspace this query operates on.

Returns:

this SimpleStatement object.

See Also:

Statement.getKeyspace()

setRoutingKey

public SimpleStatement setRoutingKey(ByteBuffer... routingKeyComponents)

Sets the routing key for this query.

See setRoutingKey(ByteBuffer) for more information. This method is a variant for when the query partition key is composite and thus the routing key must be built from multiple values.

Parameters:

routingKeyComponents - the raw (binary) values to compose to obtain the routing key.

Returns:

this SimpleStatement object.

See Also:

Statement.getRoutingKey()

convert

public static ByteBuffer[] convert(Object[] values,
                                   ProtocolVersion protocolVersion,
                                   CodecRegistry codecRegistry)

Utility method to serialize user-provided values.

This method is useful in situations where there is no metadata available and the underlying CQL type for the values is not known.

This situation happens when a SimpleStatement or a BuiltStatement (Query Builder) contain values; in these places, the driver has no way to determine the right CQL type to use.

This method performs a best-effort heuristic to guess which codec to use. Note that this is not particularly efficient as the codec registry needs to iterate over the registered codecs until it finds a suitable one.

Parameters:

values - The values to convert.

protocolVersion - The protocol version to use.

codecRegistry - The CodecRegistry to use.

Returns:

The converted values.