com.datastax.driver.extras.codecs.jdk8

Class ZonedDateTimeCodec

java.lang.Object

com.datastax.driver.core.TypeCodec<T>

com.datastax.driver.core.TypeCodec.AbstractTupleCodec<ZonedDateTime>

com.datastax.driver.extras.codecs.jdk8.ZonedDateTimeCodec

public class ZonedDateTimeCodec
extends TypeCodec.AbstractTupleCodec<ZonedDateTime>

TypeCodec that maps ZonedDateTime to CQL tuple<timestamp,varchar>, providing a pattern for maintaining timezone information in Cassandra.

Since Cassandra's timestamp type preserves only milliseconds since epoch, any timezone information would normally be lost. By using a tuple<timestamp,varchar> a timezone can be persisted in the varchar field such that when the value is deserialized the timezone is preserved.

IMPORTANT

1) The default timestamp formatter used by this codec produces CQL literals that may include milliseconds. This literal format is incompatible with Cassandra < 2.0.9.

2) Even if the ISO-8601 standard accepts timestamps with nanosecond precision, Cassandra timestamps have millisecond precision; therefore, any sub-millisecond value set on a ZonedDateTime will be lost when persisted to Cassandra.

See Also:

'Working with timestamps' section of CQL specification

Nested Class Summary

Nested classes/interfaces inherited from class com.datastax.driver.core.TypeCodec

TypeCodec.AbstractCollectionCodec<E,C extends Collection<E>>, TypeCodec.AbstractMapCodec<K,V>, TypeCodec.AbstractTupleCodec<T>, TypeCodec.AbstractUDTCodec<T>, TypeCodec.PrimitiveBooleanCodec, TypeCodec.PrimitiveByteCodec, TypeCodec.PrimitiveDoubleCodec, TypeCodec.PrimitiveFloatCodec, TypeCodec.PrimitiveIntCodec, TypeCodec.PrimitiveLongCodec, TypeCodec.PrimitiveShortCodec

Field Summary

Fields inherited from class com.datastax.driver.core.TypeCodec.AbstractTupleCodec

definition

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

cqlType, javaType

Constructor Summary

Constructors

Constructor and Description
ZonedDateTimeCodec(TupleType tupleType) Creates a new ZonedDateTimeCodec for the given tuple and with default formatters for both the timestamp and the zone components.
ZonedDateTimeCodec(TupleType tupleType, DateTimeFormatter dateTimeFormatter, DateTimeFormatter zoneFormatter) Creates a new ZonedDateTimeCodec for the given tuple and with the provided formatters for the timestamp and the zone components of the tuple.

Method Summary

Modifier and Type	Method and Description
protected ZonedDateTime	deserializeAndSetField(ByteBuffer input, ZonedDateTime target, int index, ProtocolVersion protocolVersion) Deserialize an individual field and set it on an object, as part of deserializing the whole object from a CQL tuple (see TypeCodec.AbstractTupleCodec.deserialize(ByteBuffer, ProtocolVersion)).
protected String	formatField(ZonedDateTime value, int index) Format an individual field in an object as a CQL literal, as part of formatting the whole object (see TypeCodec.AbstractTupleCodec.format(Object)).
protected ZonedDateTime	newInstance() Return a new instance of T.
protected ZonedDateTime	parseAndSetField(String input, ZonedDateTime target, int index) Parse an individual field and set it on an object, as part of parsing the whole object (see TypeCodec.AbstractTupleCodec.parse(String)).
protected ByteBuffer	serializeField(ZonedDateTime source, int index, ProtocolVersion protocolVersion) Serialize an individual field in an object, as part of serializing the whole object to a CQL tuple (see TypeCodec.AbstractTupleCodec.serialize(Object, ProtocolVersion)).

Methods inherited from class com.datastax.driver.core.TypeCodec.AbstractTupleCodec

accepts, deserialize, format, parse, serialize

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

accepts, accepts, accepts, ascii, bigint, blob, cboolean, cdouble, cfloat, cint, counter, custom, date, decimal, duration, getCqlType, getJavaType, inet, list, map, set, smallInt, time, timestamp, timeUUID, tinyInt, toString, tuple, userType, uuid, varchar, varint

Methods inherited from class java.lang.Object

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

Constructor Detail

ZonedDateTimeCodec

public ZonedDateTimeCodec(TupleType tupleType)

Creates a new ZonedDateTimeCodec for the given tuple and with default formatters for both the timestamp and the zone components.

The default formatters produce and parse CQL timestamp literals of the following form:

1. Timestamp component: an ISO-8601 full date and time pattern, including at least: year, month, day, hour and minutes, and optionally, seconds and milliseconds, followed by the zone ID Z (UTC), e.g. 2010-06-30T02:01Z or 2010-06-30T01:20:47.999Z; note that timestamp components are always expressed in UTC time, hence the zone ID Z.
2. Zone component: a zone offset such as -07:00, or a zone ID such as UTC or Europe/Paris, depending on what information is available.

Parameters:

tupleType - The tuple type this codec should handle. It must be a tuple<timestamp,varchar>.

Throws:

IllegalArgumentException - if the provided tuple type is not a tuple<timestamp,varchar>.

ZonedDateTimeCodec

public ZonedDateTimeCodec(TupleType tupleType,
                          DateTimeFormatter dateTimeFormatter,
                          DateTimeFormatter zoneFormatter)

Creates a new ZonedDateTimeCodec for the given tuple and with the provided formatters for the timestamp and the zone components of the tuple.

Use this constructor if you intend to customize the way the codec parses and formats timestamps and zones. Beware that Cassandra only accepts timestamp literals in some of the most common ISO-8601 formats; attempting to use non-standard formats could result in invalid CQL literals.

Parameters:

tupleType - The tuple type this codec should handle. It must be a tuple<timestamp,varchar>.

dateTimeFormatter - The DateTimeFormatter to use to parse and format the timestamp component of the tuple. As a parser, it should be lenient enough to accept most of the ISO-8601 formats accepted by Cassandra as valid CQL literals. As a formatter, it should be configured to always format timestamps in UTC (see DateTimeFormatter.withZone(java.time.ZoneId).

zoneFormatter - The DateTimeFormatter to use to parse and format the zone component of the tuple.

Throws:

IllegalArgumentException - if the provided tuple type is not a tuple<timestamp,varchar>.

Method Detail

newInstance

protected ZonedDateTime newInstance()

Description copied from class: TypeCodec.AbstractTupleCodec

Return a new instance of T.

Specified by:

newInstance in class TypeCodec.AbstractTupleCodec<ZonedDateTime>

Returns:

A new instance of T.

serializeField

protected ByteBuffer serializeField(ZonedDateTime source,
                                    int index,
                                    ProtocolVersion protocolVersion)

Description copied from class: TypeCodec.AbstractTupleCodec

Serialize an individual field in an object, as part of serializing the whole object to a CQL tuple (see TypeCodec.AbstractTupleCodec.serialize(Object, ProtocolVersion)).

Specified by:

serializeField in class TypeCodec.AbstractTupleCodec<ZonedDateTime>

Parameters:

source - The object to read the field from.

index - The index of the field.

protocolVersion - The protocol version to use.

Returns:

The serialized field, or null if that field should be ignored.

deserializeAndSetField

protected ZonedDateTime deserializeAndSetField(ByteBuffer input,
                                               ZonedDateTime target,
                                               int index,
                                               ProtocolVersion protocolVersion)

Description copied from class: TypeCodec.AbstractTupleCodec

Deserialize an individual field and set it on an object, as part of deserializing the whole object from a CQL tuple (see TypeCodec.AbstractTupleCodec.deserialize(ByteBuffer, ProtocolVersion)).

Specified by:

deserializeAndSetField in class TypeCodec.AbstractTupleCodec<ZonedDateTime>

Parameters:

input - The serialized form of the field.

target - The object to set the field on.

index - The index of the field.

protocolVersion - The protocol version to use.

Returns:

The target object with the field set. In most cases this should be the same as target, but if you're dealing with immutable types you'll need to return a different instance.

formatField

protected String formatField(ZonedDateTime value,
                             int index)

Description copied from class: TypeCodec.AbstractTupleCodec

Format an individual field in an object as a CQL literal, as part of formatting the whole object (see TypeCodec.AbstractTupleCodec.format(Object)).

Specified by:

formatField in class TypeCodec.AbstractTupleCodec<ZonedDateTime>

Parameters:

value - The object to read the field from.

index - The index of the field.

Returns:

The formatted value.

parseAndSetField

protected ZonedDateTime parseAndSetField(String input,
                                         ZonedDateTime target,
                                         int index)

Description copied from class: TypeCodec.AbstractTupleCodec

Parse an individual field and set it on an object, as part of parsing the whole object (see TypeCodec.AbstractTupleCodec.parse(String)).

Specified by:

parseAndSetField in class TypeCodec.AbstractTupleCodec<ZonedDateTime>

Parameters:

input - The String to parse the field from.

target - The value to write to.

index - The index of the field.

Returns:

The target object with the field set. In most cases this should be the same as target, but if you're dealing with immutable types you'll need to return a different instance.