com.datastax.driver.extras.codecs.json

Class Jsr353JsonCodec

java.lang.Object

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

com.datastax.driver.extras.codecs.json.Jsr353JsonCodec

public class Jsr353JsonCodec
extends TypeCodec<JsonStructure>

A JSON codec that uses the Java API for JSON processing to perform serialization and deserialization of JSON structures.

More specifically, this codec maps an arbitrary JsonStructure to a CQL varchar column.

This codec handles the Java type JsonStructure. It is therefore required that values are set and retrieved using that exact Java type; users should manually downcast to either JsonObject or JsonArray, as in the example below:

 // setting values
 JsonObject myObject = ...
 PreparedStatement ps = ...
 // set values using JsonStructure as target Java type
 BoundStatement bs = ps.bind().set(1, myObject, JsonStructure.class);

 // retrieving values
 Row row = session.execute(bs).one();
 // use JsonStructure as target Java type to retrieve values
 JsonStructure json = row.get(0, JsonStructure.class);
 if (json instanceof JsonObject) {
     myObject = (JsonObject) json;
     ...
 }
 

Note that at runtime, this codec requires the presence of both JSR-353 API and a JSR-353-compatible runtime library, such as JSR-353's reference implementation. If you use Maven, this can be done by declaring the following dependencies in your project:

 <dependency>
   <groupId>javax.json</groupId>
   <artifactId>javax.json-api</artifactId>
   <version>1.0</version>
 </dependency>

 <dependency>
   <groupId>org.glassfish</groupId>
   <artifactId>javax.json</artifactId>
   <version>1.0.4</version>
 </dependency>
 

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

cqlType, javaType

Constructor Summary

Constructors

Constructor and Description
Jsr353JsonCodec() Creates a new instance using a default configuration.
Jsr353JsonCodec(Map<String,?> config) Creates a new instance using the provided configuration.

Method Summary

Modifier and Type	Method and Description
JsonStructure	deserialize(ByteBuffer bytes, ProtocolVersion protocolVersion) Deserialize the given ByteBuffer instance according to the CQL type handled by this codec.
String	format(JsonStructure value) Format the given value as a valid CQL literal according to the CQL type handled by this codec.
JsonStructure	parse(String value) Parse the given CQL literal into an instance of the Java type handled by this codec.
ByteBuffer	serialize(JsonStructure value, ProtocolVersion protocolVersion) Serialize the given value according to the CQL type handled by this codec.

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

accepts, 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

Jsr353JsonCodec

public Jsr353JsonCodec()

Creates a new instance using a default configuration.

Jsr353JsonCodec

public Jsr353JsonCodec(Map<String,?> config)

Creates a new instance using the provided configuration.

Parameters:

config - A map of provider-specific configuration properties. May be empty or null.

Method Detail

serialize

public ByteBuffer serialize(JsonStructure value,
                            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<JsonStructure>

Parameters:

value - 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

deserialize

public JsonStructure deserialize(ByteBuffer bytes,
                                 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<JsonStructure>

Parameters:

bytes - 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

format

public String format(JsonStructure value)
              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 you choose not to implement this method, you should not throw an exception but instead return a constant string (for example "XxxCodec.format not implemented").

Specified by:

format in class TypeCodec<JsonStructure>

Parameters:

value - An instance of T; may be null.

Returns:

CQL string

Throws:

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

parse

public JsonStructure parse(String value)
                    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<JsonStructure>

Parameters:

value - 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