/*
 * 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;


Geometry datatype represents data in a Euclidean (flat) coordinate system.
This class will stay in this current package for backwards compatibility.
/**
 * Geometry datatype represents data in a Euclidean (flat) coordinate system.
 * This class will stay in this current package for backwards compatibility.
 */

public class Geometry extends SQLServerSpatialDatatype {

    protected Geometry() {}

    
Private constructor used for creating a Geometry object from WKT and Spatial Reference Identifier.
Params:
wkt – 
       Well-Known Text (WKT) provided by the user.
srid – 
       Spatial Reference Identifier (SRID) provided by the user.
Throws:
SQLServerException – 
        if an exception occurs/**
     * Private constructor used for creating a Geometry object from WKT and Spatial Reference Identifier.
     * 
     * @param wkt
     *        Well-Known Text (WKT) provided by the user.
     * @param srid
     *        Spatial Reference Identifier (SRID) provided by the user.
     * @throws SQLServerException
     *         if an exception occurs
     */
    protected Geometry(String wkt, int srid) throws SQLServerException {
        if (null == wkt || wkt.length() <= 0) {
            throwIllegalWKT();
        }

        this.wkt = wkt;
        this.srid = srid;

        parseWKTForSerialization(this, currentWktPos, -1, false);

        serializeToClr(false, this);
        isNull = false;
    }

    
Private constructor used for creating a Geometry object from internal SQL Server format.
Params:
clr – 
       Internal SQL Server format provided by the user.
Throws:
SQLServerException – 
        if an exception occurs/**
     * Private constructor used for creating a Geometry object from internal SQL Server format.
     * 
     * @param clr
     *        Internal SQL Server format provided by the user.
     * @throws SQLServerException
     *         if an exception occurs
     */
    protected Geometry(byte[] clr) throws SQLServerException {
        if (null == clr || clr.length <= 0) {
            throwIllegalByteArray();
        }

        this.clr = clr;
        buffer = ByteBuffer.wrap(clr);
        buffer.order(ByteOrder.LITTLE_ENDIAN);

        parseClr(this);

        WKTsb = new StringBuffer();
        WKTsbNoZM = new StringBuffer();

        constructWKT(this, internalType, numberOfPoints, numberOfFigures, numberOfSegments, numberOfShapes);

        wkt = WKTsb.toString();
        wktNoZM = WKTsbNoZM.toString();
        isNull = false;
    }

    
Constructor for a Geometry 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.
Params:
wkt – 
       Well-Known Text (WKT) provided by the user.
srid – 
       Spatial Reference Identifier (SRID) provided by the user.
Throws:
SQLServerException – 
        if an exception occurs
Returns:
Geometry Geometry instance created from WKT and SRID/**
     * Constructor for a Geometry 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
     *        Well-Known Text (WKT) provided by the user.
     * @param srid
     *        Spatial Reference Identifier (SRID) provided by the user.
     * @return Geometry Geometry instance created from WKT and SRID
     * @throws SQLServerException
     *         if an exception occurs
     */
    public static Geometry STGeomFromText(String wkt, int srid) throws SQLServerException {
        return new Geometry(wkt, srid);
    }

    
Constructor for a Geometry instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB)
representation.
Note: This method currently uses internal SQL Server format (CLR) to create a Geometry instance,
but in the future this will be changed to accept WKB data instead, as the SQL Server counterpart of this
method (STGeomFromWKB) uses WKB.
For existing users who are already using this method, consider switching to deserialize(byte) instead.
Params:
wkb – 
       Well-Known Binary (WKB) provided by the user.
Throws:
SQLServerException – 
        if an exception occurs
Returns:
Geometry Geometry instance created from WKB/**
     * Constructor for a Geometry instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB)
     * representation.
     * 
     * Note: This method currently uses internal SQL Server format (CLR) to create a Geometry instance,
     * but in the future this will be changed to accept WKB data instead, as the SQL Server counterpart of this
     * method (STGeomFromWKB) uses WKB.
     * For existing users who are already using this method, consider switching to deserialize(byte) instead.
     * 
     * @param wkb
     *        Well-Known Binary (WKB) provided by the user.
     * @return Geometry Geometry instance created from WKB
     * @throws SQLServerException
     *         if an exception occurs
     */
    public static Geometry STGeomFromWKB(byte[] wkb) throws SQLServerException {
        return new Geometry(wkb);
    }

    
Constructor for a Geometry instance from an internal SQL Server format for spatial data.
Params:
clr – 
       Internal SQL Server format provided by the user.
Throws:
SQLServerException – 
        if an exception occurs
Returns:
Geometry Geometry instance created from clr/**
     * Constructor for a Geometry instance from an internal SQL Server format for spatial data.
     * 
     * @param clr
     *        Internal SQL Server format provided by the user.
     * @return Geometry Geometry instance created from clr
     * @throws SQLServerException
     *         if an exception occurs
     */
    public static Geometry deserialize(byte[] clr) throws SQLServerException {
        return new Geometry(clr);
    }

    
Constructor for a Geometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT)
representation. Spatial Reference Identifier is defaulted to 0.
Params:
wkt – 
       Well-Known Text (WKT) provided by the user.
Throws:
SQLServerException – 
        if an exception occurs
Returns:
Geometry Geometry instance created from WKT/**
     * Constructor for a Geometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT)
     * representation. Spatial Reference Identifier is defaulted to 0.
     * 
     * @param wkt
     *        Well-Known Text (WKT) provided by the user.
     * @return Geometry Geometry instance created from WKT
     * @throws SQLServerException
     *         if an exception occurs
     */
    public static Geometry parse(String wkt) throws SQLServerException {
        return new Geometry(wkt, 0);
    }

    
Constructor for a Geometry instance that represents a Point instance from its X and Y values and an Spatial
Reference Identifier.
Params:
x – 
       x coordinate
y – 
       y coordinate
srid – 
       Spatial Reference Identifier value
Throws:
SQLServerException – 
        if an exception occurs
Returns:
Geometry Geography instance/**
     * Constructor for a Geometry instance that represents a Point instance from its X and Y values and an Spatial
     * Reference Identifier.
     * 
     * @param x
     *        x coordinate
     * @param y
     *        y coordinate
     * @param srid
     *        Spatial Reference Identifier value
     * @return Geometry Geography instance
     * @throws SQLServerException
     *         if an exception occurs
     */
    public static Geometry point(double x, double y, int srid) throws SQLServerException {
        return new Geometry("POINT (" + x + " " + y + ")", srid);
    }

    
Returns the Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation of a Geometry instance. This
text will not contain any Z (elevation) or M (measure) values carried by the instance.
Throws:
SQLServerException – 
        if an exception occurs
Returns:
the WKT representation without the Z and M values./**
     * Returns the Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation of a Geometry 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.
     * @throws SQLServerException
     *         if an exception occurs
     */
    public String STAsText() throws SQLServerException {
        if (null == wktNoZM) {
            buffer = ByteBuffer.wrap(clr);
            buffer.order(ByteOrder.LITTLE_ENDIAN);

            parseClr(this);

            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 Geometry instance. This
value will not contain any Z or M values carried by the instance.
Returns:
byte array representation of the Geometry object./**
     * Returns the Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation of a Geometry instance. This
     * value will not contain any Z or M values carried by the instance.
     * 
     * @return byte array representation of the Geometry object.
     */
    public byte[] STAsBinary() {
        if (null == wkb) {
            serializeToWkb(this);
        }
        return wkb;
    }

    
Returns the bytes that represent an internal SQL Server format of Geometry type.
Returns:
byte array representation of the Geometry object./**
     * Returns the bytes that represent an internal SQL Server format of Geometry type.
     * 
     * @return byte array representation of the Geometry object.
     */
    public byte[] serialize() {
        return clr;
    }

    
Returns if the object contains a M (measure) value.
Returns:
boolean that indicates if the object contains M value./**
     * Returns if the object contains a M (measure) value.
     * 
     * @return boolean that indicates if the object contains M value.
     */
    public boolean hasM() {
        return hasMvalues;
    }

    
Returns if the object contains a Z (elevation) value.
Returns:
boolean that indicates if the object contains Z value./**
     * Returns if the object contains a Z (elevation) value.
     * 
     * @return boolean that indicates if the object contains Z value.
     */
    public boolean hasZ() {
        return hasZvalues;
    }

    
Returns the X coordinate value.
Returns:
double value that represents the X coordinate./**
     * Returns the X coordinate value.
     * 
     * @return double value that represents the X coordinate.
     */
    public Double getX() {
        if (null != internalType && internalType == InternalSpatialDatatype.POINT && xValues.length == 1) {
            return xValues[0];
        }
        return null;
    }

    
Returns the Y coordinate value.
Returns:
double value that represents the Y coordinate./**
     * Returns the Y coordinate value.
     * 
     * @return double value that represents the Y coordinate.
     */
    public Double getY() {
        if (null != internalType && internalType == InternalSpatialDatatype.POINT && yValues.length == 1) {
            return yValues[0];
        }
        return null;
    }

    
Returns the M (measure) value of the object.
Returns:
double value that represents the M value./**
     * Returns the M (measure) value of the object.
     * 
     * @return double value that represents the M value.
     */
    public Double getM() {
        if (null != internalType && internalType == InternalSpatialDatatype.POINT && hasM()) {
            return mValues[0];
        }
        return null;
    }

    
Returns the Z (elevation) value of the object.
Returns:
double value that represents the Z value./**
     * Returns the Z (elevation) value of the object.
     * 
     * @return double value that represents the Z value.
     */
    public Double getZ() {
        if (null != internalType && internalType == InternalSpatialDatatype.POINT && hasZ()) {
            return zValues[0];
        }
        return null;
    }

    
Returns the Spatial Reference Identifier (SRID) value.
Returns:
int value of SRID./**
     * Returns the Spatial Reference Identifier (SRID) value.
     * 
     * @return int value of SRID.
     */
    public int getSrid() {
        return srid;
    }

    
Returns if the Geometry object is null.
Returns:
boolean that indicates if the object is null./**
     * Returns if the Geometry object is null.
     * 
     * @return boolean that indicates if the object is null.
     */
    public boolean isNull() {
        return isNull;
    }

    
Returns the number of points in the Geometry object.
Returns:
int that indicates the number of points in the Geometry object./**
     * Returns the number of points in the Geometry object.
     * 
     * @return int that indicates the number of points in the Geometry object.
     */
    public int STNumPoints() {
        return numberOfPoints;
    }

    
Returns the Open Geospatial Consortium (OGC) type name represented by a geometry instance.
Returns:
String that contains the Geometry object's type name/**
     * Returns the Open Geospatial Consortium (OGC) type name represented by a geometry instance.
     * 
     * @return String that contains the Geometry object's type name
     */
    public String STGeometryType() {
        if (null != internalType) {
            return internalType.getTypeName();
        }
        return null;
    }

    
Returns the Well-Known Text (WKT) representation of the Geometry object.
Returns:
String that contains the WKT representation of the Geometry object./**
     * Returns the Well-Known Text (WKT) representation of the Geometry object.
     * 
     * @return String that contains the WKT representation of the Geometry object.
     */
    public String asTextZM() {
        return wkt;
    }

    
Returns the String representation of the Geometry object.
Returns:
String that contains the WKT representation of the Geometry object./**
     * Returns the String representation of the Geometry object.
     * 
     * @return String that contains the WKT representation of the Geometry object.
     */
    @Override
    public String toString() {
        return wkt;
    }
}