com.datastax.driver.dse.geometry.codecs

Class PointCodec

java.lang.Object

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

com.datastax.driver.dse.geometry.codecs.PointCodec

public class PointCodec
extends TypeCodec<T>

A custom type codec to use Point instances in the driver.

If you use DseCluster.Builder to build your cluster, it will automatically register this codec.

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

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the server-side type handled by this codec.
static DataType.CustomType	DATA_TYPE The datatype handled by this codec.
static PointCodec	INSTANCE The unique (stateless and thread-safe) instance of this codec.

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

cqlType, javaType

Method Summary

Modifier and Type	Method and Description
T	deserialize(ByteBuffer bb, ProtocolVersion protocolVersion) Deserialize the given ByteBuffer instance according to the CQL type handled by this codec.
String	format(T geometry) Format the given value as a valid CQL literal according to the CQL type handled by this codec.
protected Point	fromWellKnownBinary(ByteBuffer source) Creates an instance of a geospatial type from its Well-known Binary (WKB) representation.
protected Point	fromWellKnownText(String source) Creates an instance of this codec's geospatial type from its Well-known Text (WKT) representation.
T	parse(String s) Parse the given CQL literal into an instance of the Java type handled by this codec.
ByteBuffer	serialize(T geometry, ProtocolVersion protocolVersion) Serialize the given value according to the CQL type handled by this codec.
protected ByteBuffer	toWellKnownBinary(Point geometry) Returns a Well-known Binary (WKB) representation of the given geospatial object.
protected String	toWellKnownText(Point geometry) Returns a Well-known Text (WKT) representation of the given geospatial object.

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

accepts, accepts, accepts, accepts, ascii, bigint, blob, cboolean, cdouble, cfloat, cint, counter, custom, date, decimal, 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

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the server-side type handled by this codec.

See Also:

Constant Field Values

DATA_TYPE

public static final DataType.CustomType DATA_TYPE

The datatype handled by this codec.

INSTANCE

public static final PointCodec INSTANCE

The unique (stateless and thread-safe) instance of this codec.

Method Detail

toWellKnownText

protected String toWellKnownText(Point geometry)

Returns a Well-known Text (WKT) representation of the given geospatial object.

Parameters:

geometry - the geospatial object to convert. Cannot be null.

Returns:

A Well-known Text representation of the given object.

toWellKnownBinary

protected ByteBuffer toWellKnownBinary(Point geometry)

Returns a Well-known Binary (WKB) representation of the given geospatial object.

Parameters:

geometry - the geospatial object to convert. Cannot be null.

Returns:

A Well-known Binary representation of the given object.

fromWellKnownText

protected Point fromWellKnownText(String source)

Creates an instance of this codec's geospatial type from its Well-known Text (WKT) representation.

Parameters:

source - the Well-known Text representation to parse. Cannot be null.

Returns:

A new instance of this codec's geospatial type.

fromWellKnownBinary

protected Point fromWellKnownBinary(ByteBuffer source)

Creates an instance of a geospatial type from its Well-known Binary (WKB) representation.

Parameters:

source - the Well-known Binary representation to parse. Cannot be null.

Returns:

A new instance of this codec's geospatial type.

deserialize

public T deserialize(ByteBuffer bb,
                     ProtocolVersion protocolVersion)
              throws InvalidTypeException

Description copied from class: TypeCodec

Deserialize the given ByteBuffer instance according to the CQL type handled by this codec.

Implementation notes:

1. Null or empty buffers should be gracefully handled and no exception should be raised; these should be considered as the equivalent of a NULL CQL value and, in most cases, should map to null or a default value for the corresponding Java type, if applicable;
2. Codecs for CQL collection types should clearly document whether they return immutable collections or not (note that the driver's default collection codecs return mutable collections);
3. Codecs for CQL collection types should avoid returning null; they should return empty collections instead (the driver's default collection codecs all comply with this rule).
4. The provided ByteBuffer should never be consumed by read operations that modify its current position; if necessary, ByteBuffer.duplicate() duplicate} it before consuming.

Specified by:

deserialize in class TypeCodec<T extends Geometry>

Parameters:

bb - A ByteBuffer instance containing the serialized form of T; may be null or empty.

protocolVersion - the protocol version to use when serializing bytes. In most cases, the proper value to provide for this argument is the value returned by ProtocolOptions.getProtocolVersion() (which is the protocol version in use by the driver).

Returns:

An instance of T

Throws:

InvalidTypeException - if the given ByteBuffer instance cannot be deserialized

serialize

public ByteBuffer serialize(T geometry,
                            ProtocolVersion protocolVersion)
                     throws InvalidTypeException

Description copied from class: TypeCodec

Serialize the given value according to the CQL type handled by this codec.

Implementation notes:

1. Null values should be gracefully handled and no exception should be raised; these should be considered as the equivalent of a NULL CQL value;
2. Codecs for CQL collection types should not permit null elements;
3. Codecs for CQL collection types should treat a null input as the equivalent of an empty collection.

Specified by:

serialize in class TypeCodec<T extends Geometry>

Parameters:

geometry - An instance of T; may be null.

protocolVersion - the protocol version to use when serializing bytes. In most cases, the proper value to provide for this argument is the value returned by ProtocolOptions.getProtocolVersion() (which is the protocol version in use by the driver).

Returns:

A ByteBuffer instance containing the serialized form of T

Throws:

InvalidTypeException - if the given value does not have the expected type

parse

public T parse(String s)
        throws InvalidTypeException

Description copied from class: TypeCodec

Parse the given CQL literal into an instance of the Java type handled by this codec.

Implementors should take care of unquoting and unescaping the given CQL string where applicable. Null values and empty Strings should be accepted, as well as the string "NULL"; in most cases, implementations should interpret these inputs has equivalent to a null reference.

Implementing this method is not strictly mandatory: internally, the driver only uses it to parse the INITCOND when building the metadata of an aggregate function (and in most cases it will use a built-in codec, unless the INITCOND has a custom type).

Specified by:

parse in class TypeCodec<T extends Geometry>

Parameters:

s - The CQL string to parse, may be null or empty.

Returns:

An instance of T; may be null on a null input.

Throws:

InvalidTypeException - if the given value cannot be parsed into the expected type

format

public String format(T geometry)
              throws InvalidTypeException

Description copied from class: TypeCodec

Format the given value as a valid CQL literal according to the CQL type handled by this codec.

Implementors should take care of quoting and escaping the resulting CQL literal where applicable. Null values should be accepted; in most cases, implementations should return the CQL keyword "NULL" for null inputs.

Implementing this method is not strictly mandatory. It is used:

1. in the query builder, when values are inlined in the query string (see BuiltStatement for a detailed explanation of when this happens);
2. in the QueryLogger, if parameter logging is enabled;
3. to format the INITCOND in AggregateMetadata.asCQLQuery(boolean);
4. in the toString() implementation of some objects (UDTValue, TupleValue, and the internal representation of a ROWS response), which may appear in driver logs.

If choose not to implement this method, you can return a constant string (for example "XxxCodec.format not implemented").

Specified by:

format in class TypeCodec<T extends Geometry>

Parameters:

geometry - An instance of T; may be null.

Returns:

CQL string

Throws:

InvalidTypeException - if the given value does not have the expected type