com.datastax.driver.dse.geometry.codecs.GeometryCodec Maven / Gradle / Ivy

Go to download
/*
 *      Copyright (C) 2012-2016 DataStax Inc.
 *
 *      This software can be used solely with DataStax Enterprise. Please consult the license at
 *      http://www.datastax.com/terms/datastax-dse-driver-license-terms
 */
package com.datastax.driver.dse.geometry.codecs;

import com.datastax.driver.core.DataType;
import com.datastax.driver.core.ProtocolVersion;
import com.datastax.driver.core.TypeCodec;
import com.datastax.driver.core.exceptions.InvalidTypeException;
import com.datastax.driver.dse.geometry.Geometry;

import java.nio.ByteBuffer;

import static com.datastax.driver.core.ParseUtils.*;

/**
 * Base class for geospatial type codecs.
 */
abstract class GeometryCodec extends TypeCodec {

    protected GeometryCodec(DataType.CustomType cqlType, Class javaType) {
        super(cqlType, javaType);
    }

    @Override
    public T deserialize(ByteBuffer bb, ProtocolVersion protocolVersion) throws InvalidTypeException {
        return bb == null || bb.remaining() == 0 ? null : fromWellKnownBinary(bb.slice());
    }

    @Override
    public ByteBuffer serialize(T geometry, ProtocolVersion protocolVersion) throws InvalidTypeException {
        return geometry == null ? null : toWellKnownBinary(geometry);
    }

    @Override
    public T parse(String s) throws InvalidTypeException {
        if (s == null)
            return null;
        s = s.trim();
        if (s.isEmpty() || s.equalsIgnoreCase("NULL"))
            return null;
        if (!isQuoted(s))
            throw new InvalidTypeException("Geometry values must be enclosed by single quotes");
        return fromWellKnownText(unquote(s));
    }

    @Override
    public String format(T geometry) throws InvalidTypeException {
        return geometry == null ? "NULL" : quote(toWellKnownText(geometry));
    }

    /**
     * Creates an instance of this codec's geospatial type from
     * its Well-known Text (WKT)
     * representation.
     *
     * @param source the Well-known Text representation to parse. Cannot be null.
     * @return A new instance of this codec's geospatial type.
     * @throws InvalidTypeException if the string does not contain a valid Well-known Text representation.
     */
    protected abstract T fromWellKnownText(String source);

    /**
     * Creates an instance of a geospatial type from
     * its Well-known Binary (WKB)
     * representation.
     *
     * @param bb the Well-known Binary representation to parse. Cannot be null.
     * @return A new instance of this codec's geospatial type.
     * @throws InvalidTypeException if the given {@link ByteBuffer} does not contain a valid Well-known Binary representation.
     */
    protected abstract T fromWellKnownBinary(ByteBuffer bb);

    /**
     * Returns a Well-known Text (WKT)
     * representation of the given geospatial object.
     *
     * @param geometry the geospatial object to convert. Cannot be null.
     * @return A Well-known Text representation of the given object.
     */
    protected abstract String toWellKnownText(T geometry);

    /**
     * Returns a Well-known Binary (WKB)
     * representation of the given geospatial object.
     *
     * @param geometry the geospatial object to convert. Cannot be null.
     * @return A Well-known Binary representation of the given object.
     */
    protected abstract ByteBuffer toWellKnownBinary(T geometry);

}