com.datastax.driver.core

Class RegularStatement

java.lang.Object

com.datastax.driver.core.Statement

com.datastax.driver.core.RegularStatement

Direct Known Subclasses:

BuiltStatement, SchemaStatement, SimpleStatement

public abstract class RegularStatement
extends Statement

A regular (non-prepared and non batched) CQL statement.

This class represents a query string along with query options (and optionally binary values, see getValues). It can be extended but SimpleStatement is provided as a simple implementation to build a RegularStatement directly from its query string.

Field Summary

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

idempotent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegularStatement() Creates a new RegularStatement.

Method Summary

Modifier and Type	Method and Description
abstract String	getQueryString() Returns the query string for this statement.
ByteBuffer[]	getValues() Deprecated. This method is provided for binary compatibility only. It is no longer supported, will be removed, and simply throws UnsupportedOperationException. Use getValues(ProtocolVersion) instead.
ByteBuffer[]	getValues(int protocolVersion) Deprecated. This method is provided for backward compatibility. Use getValues(ProtocolVersion) instead.
abstract ByteBuffer[]	getValues(ProtocolVersion protocolVersion) The values to use for this statement.
abstract boolean	hasValues() Whether or not this statement has values, that is if getValues will return null or not.
String	toString() Returns this statement as a CQL query string.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RegularStatement

protected RegularStatement()

Creates a new RegularStatement.

Method Detail

getQueryString

public abstract String getQueryString()

Returns the query string for this statement.

It is important to note that the query string is merely a CQL representation of this statement, but it does not convey all the information stored in Statement objects.

For example, Statement objects carry numerous protocol-level settings, such as the consistency level to use, or the idempotence flag, among others. None of these settings will be included in the resulting query string.

Similarly, if values have been set on this statement because it has bind markers, these values will not appear in the resulting query string.

Note: the consistency level was conveyed at CQL level in older versions of the CQL grammar, but since CASSANDRA-4734 it is now a protocol-level setting and consequently does not appear in the query string.

Returns:

a valid CQL query string.

getValues

public abstract ByteBuffer[] getValues(ProtocolVersion protocolVersion)

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).

Parameters:

protocolVersion - the protocol version in which the returned values must be serialized for.

Returns:

the values to use for this statement or null if there is no such values.

See Also:

SimpleStatement.SimpleStatement(String, Object...)

getValues

@Deprecated
public ByteBuffer[] getValues(int protocolVersion)

Deprecated. This method is provided for backward compatibility. Use getValues(ProtocolVersion) instead.

The values to use for this statement, for the given numeric protocol version.

Throws:

IllegalArgumentException - if protocolVersion does not correspond to any known version.

getValues

@Deprecated
public ByteBuffer[] getValues()

Deprecated. This method is provided for binary compatibility only. It is no longer supported, will be removed, and simply throws UnsupportedOperationException. Use getValues(ProtocolVersion) instead.

hasValues

public abstract boolean hasValues()

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

Returns:

false if getValues(com.datastax.driver.core.ProtocolVersion) returns null, true otherwise.

toString

public String toString()

Returns this statement as a CQL query string.

It is important to note that the query string is merely a CQL representation of this statement, but it does not convey all the information stored in Statement objects.

See the javadocs of getQueryString() for more information.

Overrides:

toString in class Object

Returns:

this statement as a CQL query string.

See Also:

getQueryString()