Geometry (Microsoft JDBC Driver for SQL Server 6.5.1.jre8-preview API)

java.lang.Object
- com.microsoft.sqlserver.jdbc.Geometry

```
public class Geometry
extends Object
```

Field Summary

Fields
Modifier and Type	Field	Description
`protected ByteBuffer`	`buffer`	As a general rule, the ~IndexEnd variables are non-inclusive (i.e.
`protected int`	`currentFigureIndex`
`protected int`	`currentPointIndex`
`protected int`	`currentSegmentIndex`
`protected int`	`currentShapeIndex`
`protected int`	`currentWktPos`
`protected byte`	`FA_ARC`
`protected byte`	`FA_COMPOSITE_CURVE`
`protected byte`	`FA_EXTERIOR_RING`
`protected byte`	`FA_INTERIOR_RING`
`protected byte`	`FA_LINE`
`protected byte`	`FA_POINT`
`protected byte`	`FA_STROKE`
`protected List<com.microsoft.sqlserver.jdbc.Figure>`	`figureList`
`protected com.microsoft.sqlserver.jdbc.Figure[]`	`figures`
`protected boolean`	`hasMvalues`
`protected boolean`	`hasZvalues`
`protected InternalSpatialDatatype`	`internalType`
`protected boolean`	`isLargerThanHemisphere`
`protected boolean`	`isNull`
`protected boolean`	`isSingleLineSegment`
`protected boolean`	`isSinglePoint`
`protected boolean`	`isValid`
`protected double[]`	`mValues`
`protected int`	`numberOfFigures`
`protected int`	`numberOfPoints`
`protected int`	`numberOfSegments`
`protected int`	`numberOfShapes`
`protected List<com.microsoft.sqlserver.jdbc.Point>`	`pointList`
`protected double[]`	`points`
`protected List<com.microsoft.sqlserver.jdbc.Segment>`	`segmentList`
`protected com.microsoft.sqlserver.jdbc.Segment[]`	`segments`
`protected byte`	`serializationProperties`
`protected List<com.microsoft.sqlserver.jdbc.Shape>`	`shapeList`
`protected com.microsoft.sqlserver.jdbc.Shape[]`	`shapes`
`protected int`	`srid`
`protected byte`	`version`
`protected byte[]`	`wkb`
`protected byte[]`	`wkbNoZM`
`protected String`	`wkt`
`protected String`	`wktNoZM`
`protected StringBuffer`	`WKTsb`
`protected StringBuffer`	`WKTsbNoZM`
`protected double[]`	`zValues`

Constructor Summary

Constructors
Constructor Description

Geometry()

Constructors
Constructor	Description
`Geometry()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`appendToWKTBuffers(Object o)`	Append the data to both stringbuffers.
`String`	`asTextZM()`
`protected boolean`	`checkEmptyKeyword(int parentShapeIndex, InternalSpatialDatatype isd, boolean isInsideAnotherShape)`
`protected void`	`constructCompoundcurveWKT(int segmentStartIndex, int segmentEndIndex, int pointEndIndex)`	Constructs a CompoundCurve in WKT form.
`protected void`	`constructCurvepolygonWKT(int figureStartIndex, int figureEndIndex, int segmentStartIndex, int segmentEndIndex)`	Constructs a CurvePolygon in WKT form.
`protected void`	`constructGeometryCollectionWKT(int shapeEndIndex)`	The starting point for constructing a GeometryCollection type in WKT form.
`protected void`	`constructLineWKT(int pointStartIndex, int pointEndIndex)`	Constructs a line in WKT form.
`protected void`	`constructMultipolygonWKT(int shapeStartIndex, int shapeEndIndex)`	Constructs a MultiPolygon in WKT form.
`protected void`	`constructMultiShapeWKT(int shapeStartIndex, int shapeEndIndex)`	Constructs a mutli-shape (MultiPoint / MultiLineString) in WKT form.
`protected void`	`constructPointWKT(int pointIndex)`	Constructs and appends a Point type in WKT form to the stringbuffer.
`protected void`	`constructSegmentWKT(int currentSegment, byte segment, int pointEndIndex)`	Constructs a Segment in WKT form.
`protected void`	`constructShapeWKT(int figureStartIndex, int figureEndIndex)`	Constructs a shape (simple Geometry/Geography entities that are contained within a single bracket) in WKT form.
`protected void`	`constructWKT(com.microsoft.sqlserver.jdbc.SQLServerSpatialDatatype sd, InternalSpatialDatatype isd, int pointIndexEnd, int figureIndexEnd, int segmentIndexEnd, int shapeIndexEnd)`	Create the WKT representation of Geometry/Geography from the deserialized data.
`protected void`	`createSerializationProperties()`
`static Geometry`	`deserialize(byte[] wkb)`	Returns a constructed Geometry from an internal SQL Server format for spatial data.
`protected void`	`determineInternalType()`
`protected int`	`determineWkbCapacity()`
`Double`	`getM()`
`protected String`	`getNextStringToken()`	Reads the next string token (usually POINT, LINESTRING, etc.).
`int`	`getSrid()`
`Double`	`getX()`
`Double`	`getY()`
`Double`	`getZ()`
`boolean`	`hasM()`
`protected boolean`	`hasMoreToken()`
`boolean`	`hasZ()`
`protected void`	`interpretSerializationPropBytes()`
`boolean`	`isNull()`
`static Geometry`	`parse(String wkt)`	Returns a Geometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation.
`protected void`	`parseWkb()`	Deserialize the buffer (that contains WKB representation of Geometry/Geography data), and stores it into multiple corresponding data structures.
`protected void`	`parseWKTForSerialization(com.microsoft.sqlserver.jdbc.SQLServerSpatialDatatype sd, int startPos, int parentShapeIndex, boolean isGeoCollection)`	Parses WKT and populates the data structures of the Geometry/Geography instance.
`static Geometry`	`point(double x, double y, int srid)`	Constructs a Geometry instance that represents a Point instance from its X and Y values and an SRID.
`protected void`	`populateStructures()`	Populates the various data structures contained within the Geometry/Geography instace.
`protected void`	`readCloseBracket()`
`protected void`	`readCompoundCurveWkt(boolean isFirstIteration)`	Reads a CompoundCurve WKT
`protected void`	`readCurvePolygon()`	Reads a CurvePolygon WKT
`protected void`	`readFigures()`
`protected void`	`readLineWkt()`	Reads a series of Point types.
`protected void`	`readMultiPolygonWkt(int thisShapeIndex, String nextToken)`	Reads a MultiPolygon WKT
`protected void`	`readMvalues()`
`protected void`	`readNumberOfFigures()`
`protected void`	`readNumberOfPoints()`
`protected void`	`readNumberOfSegments()`
`protected void`	`readNumberOfShapes()`
`protected void`	`readOpenBracket()`
`protected void`	`readPointWkt()`	Reads Point WKT and adds it to the list of points.
`protected void`	`readSegments()`
`protected void`	`readSegmentWkt(int segmentType, boolean isFirstIteration)`	Reads a Segment WKT
`protected void`	`readShapes()`
`protected void`	`readShapeWkt(int parentShapeIndex, String nextToken)`	Reads a shape (simple Geometry/Geography entities that are contained within a single bracket) WKT.
`protected void`	`readZvalues()`
`byte[]`	`serialize()`	Returns the bytes that represent an internal SQL Server format of Geometry type.
`protected void`	`serializeToWkb(boolean noZM)`	Serializes the Geogemetry/Geography instance to WKB.
`byte[]`	`STAsBinary()`	Returns the Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation of a Geometry instance.
`String`	`STAsText()`	Returns the Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation of a Geometry instance.
`String`	`STGeometryType()`	Returns the Open Geospatial Consortium (OGC) type name represented by a geometry instance.
`static Geometry`	`STGeomFromText(String wkt, int srid)`	Returns 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.
`static Geometry`	`STGeomFromWKB(byte[] wkb)`	Returns a Geometry instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.
`int`	`STNumPoints()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - buffer
```
protected ByteBuffer buffer
```
    As a general rule, the ~IndexEnd variables are non-inclusive (i.e. pointIndexEnd = 8 means the shape using it will only go up to the 7th index of the array)
  - internalType
```
protected InternalSpatialDatatype internalType
```
  - wkt
```
protected String wkt
```
  - wktNoZM
```
protected String wktNoZM
```
  - wkb
```
protected byte[] wkb
```
  - wkbNoZM
```
protected byte[] wkbNoZM
```
  - srid
```
protected int srid
```
  - version
```
protected byte version
```
  - numberOfPoints
```
protected int numberOfPoints
```
  - numberOfFigures
```
protected int numberOfFigures
```
  - numberOfShapes
```
protected int numberOfShapes
```
  - numberOfSegments
```
protected int numberOfSegments
```
  - WKTsb
```
protected StringBuffer WKTsb
```
  - WKTsbNoZM
```
protected StringBuffer WKTsbNoZM
```
  - currentPointIndex
```
protected int currentPointIndex
```
  - currentFigureIndex
```
protected int currentFigureIndex
```
  - currentSegmentIndex
```
protected int currentSegmentIndex
```
  - currentShapeIndex
```
protected int currentShapeIndex
```
  - points
```
protected double[] points
```
  - zValues
```
protected double[] zValues
```
  - mValues
```
protected double[] mValues
```
  - figures
```
protected com.microsoft.sqlserver.jdbc.Figure[] figures
```
  - shapes
```
protected com.microsoft.sqlserver.jdbc.Shape[] shapes
```
  - segments
```
protected com.microsoft.sqlserver.jdbc.Segment[] segments
```
  - hasZvalues
```
protected boolean hasZvalues
```
  - hasMvalues
```
protected boolean hasMvalues
```
  - isValid
```
protected boolean isValid
```
  - isSinglePoint
```
protected boolean isSinglePoint
```
  - isSingleLineSegment
```
protected boolean isSingleLineSegment
```
  - isLargerThanHemisphere
```
protected boolean isLargerThanHemisphere
```
  - isNull
```
protected boolean isNull
```
  - FA_INTERIOR_RING
```
protected final byte FA_INTERIOR_RING
```
    See Also:
    
    Constant Field Values
  - FA_STROKE
```
protected final byte FA_STROKE
```
    See Also:
    
    Constant Field Values
  - FA_EXTERIOR_RING
```
protected final byte FA_EXTERIOR_RING
```
    See Also:
    
    Constant Field Values
  - FA_POINT
```
protected final byte FA_POINT
```
    See Also:
    
    Constant Field Values
  - FA_LINE
```
protected final byte FA_LINE
```
    See Also:
    
    Constant Field Values
  - FA_ARC
```
protected final byte FA_ARC
```
    See Also:
    
    Constant Field Values
  - FA_COMPOSITE_CURVE
```
protected final byte FA_COMPOSITE_CURVE
```
    See Also:
    
    Constant Field Values
  - currentWktPos
```
protected int currentWktPos
```
  - pointList
```
protected List<com.microsoft.sqlserver.jdbc.Point> pointList
```
  - figureList
```
protected List<com.microsoft.sqlserver.jdbc.Figure> figureList
```
  - shapeList
```
protected List<com.microsoft.sqlserver.jdbc.Shape> shapeList
```
  - segmentList
```
protected List<com.microsoft.sqlserver.jdbc.Segment> segmentList
```
  - serializationProperties
```
protected byte serializationProperties
```
- Constructor Detail
  - Geometry
```
public Geometry()
```
- Method Detail
  - STGeomFromText
```
public static Geometry STGeomFromText(String wkt,
                                      int srid)
```
    Returns 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.
    
    Parameters:
    
    wkt - WKT
    
    srid - SRID
    
    Returns:
    
    Geometry instance
  - STGeomFromWKB
```
public static Geometry STGeomFromWKB(byte[] wkb)
```
    Returns a Geometry instance from an Open Geospatial Consortium (OGC) Well-Known Binary (WKB) representation.
    
    Parameters:
    
    wkb - WKB
    
    Returns:
    
    Geometry instance
  - deserialize
```
public static Geometry deserialize(byte[] wkb)
```
    Returns a constructed Geometry from an internal SQL Server format for spatial data.
    
    Parameters:
    
    wkb - WKB
    
    Returns:
    
    Geometry instance
  - parse
```
public static Geometry parse(String wkt)
```
    Returns a Geometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT) representation. SRID is defaulted to 0.
    
    Parameters:
    
    wkt - WKT
    
    Returns:
    
    Geometry instance
  - point
```
public static Geometry point(double x,
                             double y,
                             int srid)
```
    Constructs a Geometry instance that represents a Point instance from its X and Y values and an SRID.
    
    Parameters:
    
    x - x coordinate
    
    y - y coordinate
    
    srid - SRID
    
    Returns:
    
    Geometry instance
  - STAsText
```
public String STAsText()
```
    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.
    
    Returns:
    
    the WKT representation without the Z and M values.
  - STAsBinary
```
public byte[] STAsBinary()
```
    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:
    
    WKB
  - serialize
```
public byte[] serialize()
```
    Returns the bytes that represent an internal SQL Server format of Geometry type.
    
    Returns:
    
    WKB
  - hasM
```
public boolean hasM()
```
  - hasZ
```
public boolean hasZ()
```
  - getX
```
public Double getX()
```
  - getY
```
public Double getY()
```
  - getM
```
public Double getM()
```
  - getZ
```
public Double getZ()
```
  - getSrid
```
public int getSrid()
```
  - isNull
```
public boolean isNull()
```
  - STNumPoints
```
public int STNumPoints()
```
  - STGeometryType
```
public String STGeometryType()
```
    Returns the Open Geospatial Consortium (OGC) type name represented by a geometry instance.
    
    Returns:
    
    type name
  - asTextZM
```
public String asTextZM()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - serializeToWkb
```
protected void serializeToWkb(boolean noZM)
```
    Serializes the Geogemetry/Geography instance to WKB.
    
    Parameters:
    
    noZM - flag to indicate if Z and M coordinates should be included
  - parseWkb
```
protected void parseWkb()
```
    Deserialize the buffer (that contains WKB representation of Geometry/Geography data), and stores it into multiple corresponding data structures.
  - constructWKT
```
protected void constructWKT(com.microsoft.sqlserver.jdbc.SQLServerSpatialDatatype sd,
                            InternalSpatialDatatype isd,
                            int pointIndexEnd,
                            int figureIndexEnd,
                            int segmentIndexEnd,
                            int shapeIndexEnd)
```
    Create the WKT representation of Geometry/Geography from the deserialized data.
    
    Parameters:
    
    sd - the Geometry/Geography instance.
    
    isd - internal spatial datatype object
    
    pointIndexEnd - upper bound for reading points
    
    figureIndexEnd - upper bound for reading figures
    
    segmentIndexEnd - upper bound for reading segments
    
    shapeIndexEnd - upper bound for reading shapes
  - parseWKTForSerialization
```
protected void parseWKTForSerialization(com.microsoft.sqlserver.jdbc.SQLServerSpatialDatatype sd,
                                        int startPos,
                                        int parentShapeIndex,
                                        boolean isGeoCollection)
```
    Parses WKT and populates the data structures of the Geometry/Geography instance.
    
    Parameters:
    
    sd - the Geometry/Geography instance.
    
    startPos - The index to start from from the WKT.
    
    parentShapeIndex - The index of the parent's Shape in the shapes array. Used to determine this shape's parent.
    
    isGeoCollection - flag to indicate if this is part of a GeometryCollection.
  - constructPointWKT
```
protected void constructPointWKT(int pointIndex)
```
    Constructs and appends a Point type in WKT form to the stringbuffer. There are two stringbuffers - WKTsb and WKTsbNoZM. WKTsb contains the X, Y, Z and M coordinates, whereas WKTsbNoZM contains only X and Y coordinates.
    
    Parameters:
    
    pointIndex - indicates which point to append to the stringbuffer.
  - constructLineWKT
```
protected void constructLineWKT(int pointStartIndex,
                                int pointEndIndex)
```
    Constructs a line in WKT form.
    
    Parameters:
    
    pointStartIndex - .
    
    pointEndIndex - .
  - constructShapeWKT
```
protected void constructShapeWKT(int figureStartIndex,
                                 int figureEndIndex)
```
    Constructs a shape (simple Geometry/Geography entities that are contained within a single bracket) in WKT form.
    
    Parameters:
    
    figureStartIndex - .
    
    figureEndIndex - .
  - constructMultiShapeWKT
```
protected void constructMultiShapeWKT(int shapeStartIndex,
                                      int shapeEndIndex)
```
    Constructs a mutli-shape (MultiPoint / MultiLineString) in WKT form.
    
    Parameters:
    
    shapeStartIndex - .
    
    shapeEndIndex - .
  - constructCompoundcurveWKT
```
protected void constructCompoundcurveWKT(int segmentStartIndex,
                                         int segmentEndIndex,
                                         int pointEndIndex)
```
    Constructs a CompoundCurve in WKT form.
    
    Parameters:
    
    segmentStartIndex - .
    
    segmentEndIndex - .
    
    pointEndIndex - .
  - constructMultipolygonWKT
```
protected void constructMultipolygonWKT(int shapeStartIndex,
                                        int shapeEndIndex)
```
    Constructs a MultiPolygon in WKT form.
    
    Parameters:
    
    shapeStartIndex - .
    
    shapeEndIndex - .
  - constructCurvepolygonWKT
```
protected void constructCurvepolygonWKT(int figureStartIndex,
                                        int figureEndIndex,
                                        int segmentStartIndex,
                                        int segmentEndIndex)
```
    Constructs a CurvePolygon in WKT form.
    
    Parameters:
    
    figureStartIndex - .
    
    figureEndIndex - .
    
    segmentStartIndex - .
    
    segmentEndIndex - .
  - constructSegmentWKT
```
protected void constructSegmentWKT(int currentSegment,
                                   byte segment,
                                   int pointEndIndex)
```
    Constructs a Segment in WKT form. SQL Server re-uses the last point of a segment if the following segment is of type 3 (first arc) or type 2 (first line). This makes sense because the last point of a segment and the first point of the next segment have to match for a valid curve. This means that the code has to look ahead and decide to decrement the currentPointIndex depending on what segment comes next, since it may have been reused (and it's reflected in the array of points)
    
    Parameters:
    
    currentSegment - .
    
    segment - .
    
    pointEndIndex - .
  - constructGeometryCollectionWKT
```
protected void constructGeometryCollectionWKT(int shapeEndIndex)
```
    The starting point for constructing a GeometryCollection type in WKT form.
    
    Parameters:
    
    shapeEndIndex - .
  - readPointWkt
```
protected void readPointWkt()
```
    Reads Point WKT and adds it to the list of points. This method will read up until and including the comma that may come at the end of the Point WKT.
  - readLineWkt
```
protected void readLineWkt()
```
    Reads a series of Point types.
  - readShapeWkt
```
protected void readShapeWkt(int parentShapeIndex,
                            String nextToken)
```
    Reads a shape (simple Geometry/Geography entities that are contained within a single bracket) WKT.
    
    Parameters:
    
    parentShapeIndex - shape index of the parent shape that called this method
    
    nextToken - next string token
  - readCurvePolygon
```
protected void readCurvePolygon()
```
    Reads a CurvePolygon WKT
  - readMultiPolygonWkt
```
protected void readMultiPolygonWkt(int thisShapeIndex,
                                   String nextToken)
```
    Reads a MultiPolygon WKT
    
    Parameters:
    
    thisShapeIndex - shape index of current shape
    
    nextToken - next string token
  - readSegmentWkt
```
protected void readSegmentWkt(int segmentType,
                              boolean isFirstIteration)
```
    Reads a Segment WKT
    
    Parameters:
    
    segmentType - segment type
    
    isFirstIteration - flag that indicates if this is the first iteration from the loop outside
  - readCompoundCurveWkt
```
protected void readCompoundCurveWkt(boolean isFirstIteration)
```
    Reads a CompoundCurve WKT
    
    Parameters:
    
    isFirstIteration - flag that indicates if this is the first iteration from the loop outside
  - getNextStringToken
```
protected String getNextStringToken()
```
    Reads the next string token (usually POINT, LINESTRING, etc.). Then increments currentWktPos to the end of the string token.
    
    Returns:
    
    the next string token
  - populateStructures
```
protected void populateStructures()
```
    Populates the various data structures contained within the Geometry/Geography instace.
  - readOpenBracket
```
protected void readOpenBracket()
```
  - readCloseBracket
```
protected void readCloseBracket()
```
  - hasMoreToken
```
protected boolean hasMoreToken()
```
  - createSerializationProperties
```
protected void createSerializationProperties()
```
  - determineWkbCapacity
```
protected int determineWkbCapacity()
```
  - appendToWKTBuffers
```
protected void appendToWKTBuffers(Object o)
```
    Append the data to both stringbuffers.
    
    Parameters:
    
    o - data to append to the stringbuffers.
  - interpretSerializationPropBytes
```
protected void interpretSerializationPropBytes()
```
  - readNumberOfPoints
```
protected void readNumberOfPoints()
```
  - readZvalues
```
protected void readZvalues()
```
  - readMvalues
```
protected void readMvalues()
```
  - readNumberOfFigures
```
protected void readNumberOfFigures()
```
  - readFigures
```
protected void readFigures()
```
  - readNumberOfShapes
```
protected void readNumberOfShapes()
```
  - readShapes
```
protected void readShapes()
```
  - readNumberOfSegments
```
protected void readNumberOfSegments()
```
  - readSegments
```
protected void readSegments()
```
  - determineInternalType
```
protected void determineInternalType()
```
  - checkEmptyKeyword
```
protected boolean checkEmptyKeyword(int parentShapeIndex,
                                    InternalSpatialDatatype isd,
                                    boolean isInsideAnotherShape)
```

Class Geometry

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

buffer

internalType

wkt

wktNoZM

wkb

wkbNoZM

srid

version

numberOfPoints

numberOfFigures

numberOfShapes

numberOfSegments

WKTsb

WKTsbNoZM

currentPointIndex

currentFigureIndex

currentSegmentIndex

currentShapeIndex

points

zValues

mValues

figures

shapes

segments

hasZvalues

hasMvalues

isValid

isSinglePoint

isSingleLineSegment

isLargerThanHemisphere

isNull

FA_INTERIOR_RING

FA_STROKE

FA_EXTERIOR_RING

FA_POINT

FA_LINE

FA_ARC

FA_COMPOSITE_CURVE

currentWktPos

pointList

figureList

shapeList

segmentList

serializationProperties

Constructor Detail

Geometry

Method Detail

STGeomFromText

STGeomFromWKB

deserialize

parse

point

STAsText

STAsBinary

serialize

hasM

hasZ

getX

getY

getM

getZ

getSrid

isNull

STNumPoints

STGeometryType

asTextZM

toString

serializeToWkb

parseWkb

constructWKT

parseWKTForSerialization

constructPointWKT

constructLineWKT

constructShapeWKT