Geoshape (Titan 1.1.1 API)

java.lang.Object
- com.thinkaurelius.titan.core.attribute.Geoshape

```
public class Geoshape
extends Object
```
A generic representation of a geographic shape, which can either be a single point, circle, box, line or polygon. Use getType() to determine the type of shape of a particular Geoshape object. Use the static constructor methods to create the desired geoshape.

Author:

Matthias Broecheler (me@matthiasb.com)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Geoshape.GeoshapeBinarySerializer` Geoshape binary serializer using spatial4j's `JtsBinaryCodec`.
`static class`	`Geoshape.GeoShapeGryoSerializer` Geoshape serializer for TinkerPop's Gryo.
`static class`	`Geoshape.GeoshapeGsonDeserializer` Geoshape JSON deserializer supporting reading from GeoJSON (http://geojson.org/).
`static class`	`Geoshape.GeoshapeGsonSerializer` Geoshape serializer supports writing GeoJSON (http://geojson.org/).
`static class`	`Geoshape.GeoshapeSerializer` Geoshape attribute serializer for Titan.
`static class`	`Geoshape.Point` A single point representation.
`static class`	`Geoshape.Type` The Type of a shape: a point, box, circle, line or polygon.

Field Summary

Fields
Modifier and Type Field and Description

static com.spatial4j.core.context.jts.JtsSpatialContext CTX

Fields
Modifier and Type	Field and Description
`static com.spatial4j.core.context.jts.JtsSpatialContext`	`CTX`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Geoshape`	`box(double southWestLatitude, double southWestLongitude, double northEastLatitude, double northEastLongitude)` Constructs a new box shape which is identified by its south-west and north-east corner points
`static Geoshape`	`circle(double latitude, double longitude, double radiusInKM)` Constructs a circle from a given center point and a radius in kilometer
`boolean`	`contains(Geoshape outer)` Whether this geometry contains the given geometry.
`boolean`	`disjoint(Geoshape other)` Whether this geometry has no points in common with the given geometry.
`boolean`	`equals(Object other)`
`static Geoshape`	`fromWkt(String wkt)` Create Geoshape from WKT representation.
`static Geoshape`	`geoshape(com.vividsolutions.jts.geom.Geometry geometry)` Constructs a Geoshape from a JTS `Geometry`.
`static Geoshape`	`geoshape(com.spatial4j.core.shape.Shape shape)` Constructs a Geoshape from a spatial4j `Shape`.
`Geoshape.Point`	`getPoint()` Returns the singleton point of this shape.
`Geoshape.Point`	`getPoint(int position)` Returns the point at the given position.
`double`	`getRadius()` Returns the radius in kilometers of this circle.
`com.spatial4j.core.shape.Shape`	`getShape()` Returns the underlying `Shape`.
`Geoshape.Type`	`getType()` Returns the `Geoshape.Type` of this geoshape.
`int`	`hashCode()`
`boolean`	`intersect(Geoshape other)` Whether this geometry has any points in common with the given geometry.
`static boolean`	`isValidCoordinate(double latitude, double longitude)` Whether the given coordinates mark a point on earth.
`static Geoshape`	`line(double... coordinates)` Constructs a new line shape which is identified by its coordinates
`static Geoshape`	`line(List<double[]> coordinates)` Constructs a line from list of coordinates
`static Geoshape`	`point(double latitude, double longitude)` Constructs a point from its latitude and longitude information
`static Geoshape`	`polygon(double... coordinates)` Constructs a new polygon shape which is identified by its coordinates
`static Geoshape`	`polygon(List<double[]> coordinates)` Constructs a polygon from list of coordinates
`int`	`size()` Returns the number of points comprising this geoshape.
`String`	`toGeoJson()` Returns the GeoJSON representation of the shape.
`String`	`toString()` Returns the WKT representation of the shape.
`boolean`	`within(Geoshape outer)` Whether this geometry is within the given geometry.

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

- Field Detail
  - CTX
```
public static final com.spatial4j.core.context.jts.JtsSpatialContext CTX
```
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Returns the WKT representation of the shape.
    
    Overrides:
    
    toString in class Object
    
    Returns:
  - toGeoJson
```
public String toGeoJson()
```
    Returns the GeoJSON representation of the shape.
    
    Returns:
  - getShape
```
public com.spatial4j.core.shape.Shape getShape()
```
    Returns the underlying Shape.
    
    Returns:
  - getType
```
public Geoshape.Type getType()
```
    Returns the Geoshape.Type of this geoshape.
    
    Returns:
  - size
```
public int size()
```
    Returns the number of points comprising this geoshape. A point and circle have only one point (center of cricle), a box has two points (the south-west and north-east corners). Lines and polygons have a variable number of points.
    
    Returns:
  - getPoint
```
public Geoshape.Point getPoint(int position)
```
    Returns the point at the given position. The position must be smaller than size().
    
    Parameters:
    
    position -
    
    Returns:
  - getPoint
```
public Geoshape.Point getPoint()
```
    Returns the singleton point of this shape. Only applicable for point and circle shapes.
    
    Returns:
  - getRadius
```
public double getRadius()
```
    Returns the radius in kilometers of this circle. Only applicable to circle shapes.
    
    Returns:
  - intersect
```
public boolean intersect(Geoshape other)
```
    Whether this geometry has any points in common with the given geometry.
    
    Parameters:
    
    other -
    
    Returns:
  - within
```
public boolean within(Geoshape outer)
```
    Whether this geometry is within the given geometry.
    
    Parameters:
    
    outer -
    
    Returns:
  - contains
```
public boolean contains(Geoshape outer)
```
    Whether this geometry contains the given geometry.
    
    Parameters:
    
    outer -
    
    Returns:
  - disjoint
```
public boolean disjoint(Geoshape other)
```
    Whether this geometry has no points in common with the given geometry.
    
    Parameters:
    
    other -
    
    Returns:
  - point
```
public static final Geoshape point(double latitude,
                                   double longitude)
```
    Constructs a point from its latitude and longitude information
    
    Parameters:
    
    latitude -
    
    longitude -
    
    Returns:
  - circle
```
public static final Geoshape circle(double latitude,
                                    double longitude,
                                    double radiusInKM)
```
    Constructs a circle from a given center point and a radius in kilometer
    
    Parameters:
    
    latitude -
    
    longitude -
    
    radiusInKM -
    
    Returns:
  - box
```
public static final Geoshape box(double southWestLatitude,
                                 double southWestLongitude,
                                 double northEastLatitude,
                                 double northEastLongitude)
```
    Constructs a new box shape which is identified by its south-west and north-east corner points
    
    Parameters:
    
    southWestLatitude -
    
    southWestLongitude -
    
    northEastLatitude -
    
    northEastLongitude -
    
    Returns:
  - line
```
public static final Geoshape line(double... coordinates)
```
    Constructs a new line shape which is identified by its coordinates
    
    Parameters:
    
    coordinates - Sequence of coordinates (lat1,lon1,...,latN,lonN)
    
    Returns:
  - line
```
public static final Geoshape line(List<double[]> coordinates)
```
    Constructs a line from list of coordinates
    
    Parameters:
    
    coordinates - Coordinate (lon,lat) pairs
    
    Returns:
  - polygon
```
public static final Geoshape polygon(double... coordinates)
```
    Constructs a new polygon shape which is identified by its coordinates
    
    Parameters:
    
    coordinates - Sequence of coordinates (lat1,lon1,...,latN,lonN)
    
    Returns:
  - polygon
```
public static final Geoshape polygon(List<double[]> coordinates)
```
    Constructs a polygon from list of coordinates
    
    Parameters:
    
    coordinates - Coordinate (lon,lat) pairs
    
    Returns:
  - geoshape
```
public static final Geoshape geoshape(com.vividsolutions.jts.geom.Geometry geometry)
```
    Constructs a Geoshape from a JTS Geometry.
    
    Parameters:
    
    geometry -
    
    Returns:
  - geoshape
```
public static final Geoshape geoshape(com.spatial4j.core.shape.Shape shape)
```
    Constructs a Geoshape from a spatial4j Shape.
    
    Parameters:
    
    shape -
    
    Returns:
  - fromWkt
```
public static final Geoshape fromWkt(String wkt)
                              throws ParseException
```
    Create Geoshape from WKT representation.
    
    Parameters:
    
    wkt -
    
    Returns:
    
    Throws:
    
    ParseException
  - isValidCoordinate
```
public static final boolean isValidCoordinate(double latitude,
                                              double longitude)
```
    Whether the given coordinates mark a point on earth.
    
    Parameters:
    
    latitude -
    
    longitude -
    
    Returns:

Class Geoshape

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CTX

Method Detail

hashCode

equals

toString

toGeoJson

getShape

getType

size

getPoint

getPoint

getRadius

intersect

within

contains

disjoint

point

circle

box

line

line

polygon

polygon

geoshape

geoshape

fromWkt

isValidCoordinate