Merge pull request #642 from Microsoft/Spatial_Datatypes

Spatial datatypes

src/main/java/com/microsoft/sqlserver/jdbc/DDC.java

@@ -612,6 +612,10 @@ static final Object convertStreamToObject(BaseInputStream stream,
                             byte[] byteValue = stream.getBytes();
                             if (JDBCType.GUID == jdbcType) {
                                 return Util.readGUID(byteValue);
+                            } else if (JDBCType.GEOMETRY == jdbcType) {
+                                return Geometry.STGeomFromWKB(byteValue);
+                            } else if (JDBCType.GEOGRAPHY == jdbcType) {
+                                return Geography.STGeomFromWKB(byteValue);
                             }
                             else {
                                 String hexString = Util.bytesToHexString(byteValue, byteValue.length);

src/main/java/com/microsoft/sqlserver/jdbc/DataTypes.java

@@ -148,7 +148,9 @@ enum SSType
     SQL_VARIANT    (Category.SQL_VARIANT,     "sql_variant",      JDBCType.SQL_VARIANT),  
     UDT            (Category.UDT,             "udt",              JDBCType.VARBINARY),
     XML            (Category.XML,             "xml",              JDBCType.LONGNVARCHAR),
-    TIMESTAMP      (Category.TIMESTAMP,       "timestamp",        JDBCType.BINARY);
+    TIMESTAMP      (Category.TIMESTAMP,       "timestamp",        JDBCType.BINARY),
+    GEOMETRY       (Category.UDT,             "geometry",         JDBCType.GEOMETRY),
+    GEOGRAPHY      (Category.UDT,             "geography",        JDBCType.GEOGRAPHY);
 
     final Category category;
     private final String name;
@@ -352,7 +354,9 @@ enum GetterConversion
             EnumSet.of(
                 JDBCType.Category.BINARY,
                 JDBCType.Category.LONG_BINARY,
-                JDBCType.Category.CHARACTER)),
+                JDBCType.Category.CHARACTER,
+                JDBCType.Category.GEOMETRY,
+                JDBCType.Category.GEOGRAPHY)),
 
         GUID (
             SSType.Category.GUID,
@@ -856,7 +860,9 @@ enum JDBCType
     DATETIME      (Category.TIMESTAMP,       microsoft.sql.Types.DATETIME,			"java.sql.Timestamp"),
     SMALLDATETIME (Category.TIMESTAMP,       microsoft.sql.Types.SMALLDATETIME,     "java.sql.Timestamp"),
     GUID		  (Category.CHARACTER,		 microsoft.sql.Types.GUID,				"java.lang.String"),
-    SQL_VARIANT   (Category.SQL_VARIANT,     microsoft.sql.Types.SQL_VARIANT,       "java.lang.Object");
+    SQL_VARIANT   (Category.SQL_VARIANT,     microsoft.sql.Types.SQL_VARIANT,       "java.lang.Object"),
+    GEOMETRY      (Category.GEOMETRY,        microsoft.sql.Types.GEOMETRY,          "java.lang.Object"),
+    GEOGRAPHY     (Category.GEOGRAPHY,       microsoft.sql.Types.GEOGRAPHY,         "java.lang.Object");
 
 
     final Category category;
@@ -906,6 +912,8 @@ enum Category {
         TVP,
         GUID,
         SQL_VARIANT,
+        GEOMETRY,
+        GEOGRAPHY
     }
 
     // This SetterConversion enum is based on the Category enum

src/main/java/com/microsoft/sqlserver/jdbc/Geography.java

@@ -0,0 +1,332 @@
+/*
+ * Microsoft JDBC Driver for SQL Server
+ * 
+ * Copyright(c) Microsoft Corporation All rights reserved.
+ * 
+ * This program is made available under the terms of the MIT License. See the LICENSE file in the project root for more information.
+ */
+
+package com.microsoft.sqlserver.jdbc;
+
+import java.nio.ByteBuffer;
+import java.nio.ByteOrder;
+import java.util.Locale;
+
+public class Geography extends SQLServerSpatialDatatype {
+
+    /**
+     * Private constructor used for creating a Geography object from WKT and srid.
+     */
+    private Geography(String WellKnownText, int srid) {
+        this.wkt = WellKnownText;
+        this.srid = srid;
+
+        try {
+            parseWKTForSerialization(this, currentWktPos, -1, false);
+        }
+        catch (StringIndexOutOfBoundsException e) {
+            throw new IllegalArgumentException("Reached unexpected end of WKT. Please make sure WKT is valid.");
+        }
+
+        serializeToWkb(false);
+        isNull = false;
+    }
+
+    /**
+     * Private constructor used for creating a Geography object from WKB.
+     */
+    private Geography(byte[] wkb) {
+        this.wkb = wkb;
+        buffer = ByteBuffer.wrap(wkb);
+        buffer.order(ByteOrder.LITTLE_ENDIAN);
+
+        parseWkb();
+
+        WKTsb = new StringBuffer();
+        WKTsbNoZM = new StringBuffer();
+
+        constructWKT(this, internalType, numberOfPoints, numberOfFigures, numberOfSegments, numberOfShapes);
+
+        wkt = WKTsb.toString();
+        wktNoZM = WKTsbNoZM.toString();
+        isNull = false;
+    }
+
+    public Geography() {
+        // TODO Auto-generated constructor stub
+    }
+
+    /**
+     * Returns a Geography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT)
+     *  representation augmented with any Z (elevation) and M (measure) values carried by the instance.
+     *  
+     * @param wkt WKT
+     * @param srid SRID
+     * @return Geography instance
+     */
+    public static Geography STGeomFromText(String wkt, int srid) {
+        return new Geography(wkt, srid);
+    }
+
+    /**
+     * Returns a Geography instance from an Open Geospatial Consortium (OGC) 
+     * Well-Known Binary (WKB) representation.
+     * 
+     * @param wkb WKB
+     * @return Geography instance
+     */
+    public static Geography STGeomFromWKB(byte[] wkb) {
+        return new Geography(wkb);
+    }
+
+    /**
+     * Returns a constructed Geography from an internal SQL Server format for spatial data.
+     * 
+     * @param wkb WKB
+     * @return Geography instance
+     */
+    public static Geography deserialize(byte[] wkb) {
+        return new Geography(wkb);
+    }
+
+    /**
+     * Returns a Geography instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation.
+     * SRID is defaulted to 4326.
+     * 
+     * @param wkt WKt
+     * @return Geography instance
+     */
+    public static Geography parse(String wkt) {
+        return new Geography(wkt, 4326);
+    }
+
+    /**
+     * Constructs a Geography instance that represents a Point instance from its X and Y values and an SRID.
+     * 
+     * @param x x coordinate
+     * @param y y coordinate
+     * @param srid SRID
+     * @return Geography instance
+     */
+    public static Geography point(double x, double y, int srid) {
+        return new Geography("POINT (" + x + " " + y + ")", srid);
+    }
+
+    /**
+     * Returns the Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation of a 
+     * Geography instance. This text will not contain any Z (elevation) or M (measure) values carried by the instance.
+     * 
+     * @return the WKT representation without the Z and M values.
+     */
+    public String STAsText() {
+        if (null == wktNoZM) {
+            buffer = ByteBuffer.wrap(wkb);
+            buffer.order(ByteOrder.LITTLE_ENDIAN);
+
+            parseWkb();
+
+            WKTsb = new StringBuffer();
+            WKTsbNoZM = new StringBuffer();
+            constructWKT(this, internalType, numberOfPoints, numberOfFigures, numberOfSegments, numberOfShapes);
+            wktNoZM = WKTsbNoZM.toString();
+        }
+        return wktNoZM;
+    }
+
+    /**
+     *  Returns the Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation of a 
+     *  Geography instance. This value will not contain any Z or M values carried by the instance.
+     * @return WKB
+     */
+    public byte[] STAsBinary() {
+        if (null == wkbNoZM) {
+            serializeToWkb(true);
+        }
+        return wkbNoZM;
+    }
+
+    /**
+     *  Returns the bytes that represent an internal SQL Server format of Geography type.
+     * 
+     * @return WKB
+     */
+    public byte[] serialize() {
+        return wkb;
+    }
+
+    public boolean hasM() {
+        return hasMvalues;
+    }
+
+    public boolean hasZ() {
+        return hasZvalues;
+    }
+
+    public Double getX() {
+        if (null != internalType && internalType == InternalSpatialDatatype.POINT && points.length == 2) {
+            return points[0];
+        }
+        return null;
+    }
+
+    public Double getY() {
+        if (null != internalType && internalType == InternalSpatialDatatype.POINT && points.length == 2) {
+            return points[1];
+        }
+        return null;
+    }
+
+    public Double getM() {
+        if (null != internalType && internalType == InternalSpatialDatatype.POINT && hasM()) {
+            return mValues[0];
+        }
+        return null;
+    }
+
+    public Double getZ() {
+        if (null != internalType && internalType == InternalSpatialDatatype.POINT && hasZ()) {
+            return zValues[0];
+        }
+        return null;
+    }
+
+    public int getSrid() {
+        return srid;
+    }
+
+    public boolean isNull() {
+        return isNull;
+    }
+
+    public int STNumPoints() {
+        return numberOfPoints;
+    }
+
+    /**
+     * Returns the Open Geospatial Consortium (OGC) type name represented by a Geography instance.
+     * 
+     * @return type name
+     */
+    public String STGeographyType() {
+        if (null != internalType) {
+            return internalType.getTypeName();
+        }
+        return null;
+    }
+
+    public String asTextZM() {
+        return wkt;
+    }
+
+    public String toString() {
+        return wkt;
+    }
+
+    protected void serializeToWkb(boolean noZM) {
+        ByteBuffer buf = ByteBuffer.allocate(determineWkbCapacity());
+        createSerializationProperties();
+
+        buf.order(ByteOrder.LITTLE_ENDIAN);
+        buf.putInt(srid);
+        buf.put(version);
+        buf.put(serializationProperties);
+
+        if (!isSinglePoint && !isSingleLineSegment) {
+            buf.putInt(numberOfPoints);
+        }
+
+        for (int i = 0; i < numberOfPoints; i++) {
+            buf.putDouble(points[2 * i + 1]);
+            buf.putDouble(points[2 * i]);
+        }
+
+        if (!noZM) {
+            if (hasZvalues) {
+                for (int i = 0; i < numberOfPoints; i++) {
+                    buf.putDouble(zValues[i]);
+                }
+            }
+
+            if (hasMvalues) {
+                for (int i = 0; i < numberOfPoints; i++) {
+                    buf.putDouble(mValues[i]);
+                }
+            }
+        }
+
+        if (isSinglePoint || isSingleLineSegment) {
+            wkb = buf.array();
+            return;
+        }
+
+        buf.putInt(numberOfFigures);
+        for (int i = 0; i < numberOfFigures; i++) {
+            buf.put(figures[i].getFiguresAttribute());
+            buf.putInt(figures[i].getPointOffset());
+        }
+
+        buf.putInt(numberOfShapes);
+        for (int i = 0; i < numberOfShapes; i++) {
+            buf.putInt(shapes[i].getParentOffset());
+            buf.putInt(shapes[i].getFigureOffset());
+            buf.put(shapes[i].getOpenGISType());
+        }
+
+        if (version == 2 && null != segments) {
+            buf.putInt(numberOfSegments);
+            for (int i = 0; i < numberOfSegments; i++) {
+                buf.put(segments[i].getSegmentType());
+            }
+        }
+
+        if (noZM) { 
+            wkbNoZM = buf.array();
+        } else {
+            wkb = buf.array();
+
+        }
+        return;
+    }
+
+    protected void parseWkb() {
+        srid = buffer.getInt();
+        version = buffer.get();
+        serializationProperties = buffer.get();
+
+        interpretSerializationPropBytes();
+        readNumberOfPoints();
+        readPoints();
+
+        if (hasZvalues) {
+            readZvalues();
+        }
+
+        if (hasMvalues) {
+            readMvalues();
+        }
+
+        if (!(isSinglePoint || isSingleLineSegment)) {
+            readNumberOfFigures();
+            readFigures();
+            readNumberOfShapes();
+            readShapes();
+        }
+
+        determineInternalType();
+
+        if (buffer.hasRemaining()) {
+            if (version == 2 && internalType.getTypeCode() != 8 && internalType.getTypeCode() != 11) {
+                readNumberOfSegments();
+                readSegments();
+            }
+        }
+    }
+
+    private void readPoints() {
+        points = new double[2 * numberOfPoints];
+        for (int i = 0; i < numberOfPoints; i++) {
+            points[2 * i + 1] = buffer.getDouble();
+            points[2 * i] = buffer.getDouble();
+        }
+    }
+}