org.vertexium.type

Class GeoLine

java.lang.Object

org.vertexium.type.GeoShapeBase

org.vertexium.type.GeoLine

All Implemented Interfaces:

Serializable, GeoShape

public class GeoLine
extends GeoShapeBase

See Also:

Serialized Form

Field Summary

Fields inherited from class org.vertexium.type.GeoShapeBase

EARTH_CIRCUMFERENCE, EARTH_RADIUS, MAX_LAT, MAX_LON, MIN_LAT, MIN_LON

Constructor Summary

Constructors

Constructor and Description
GeoLine(GeoPoint start, GeoPoint end)
GeoLine(GeoPoint start, GeoPoint end, String description)
GeoLine(List<GeoPoint> geoPoints)
GeoLine(List<GeoPoint> geoPoints, String description)

Method Summary

Modifier and Type	Method and Description
GeoLine	addGeoPoint(GeoPoint geoPoint)
GeoLine	addGeoPoints(List<GeoPoint> geoPoints)
boolean	equals(Object obj)
List<GeoPoint>	getGeoPoints()
int	hashCode()
boolean	intersects(GeoShape geoShape) Calculate whether the given GeoShape intersects with the geometry of this object.
void	setGeoPoints(List<GeoPoint> geoPoints)
String	toString()
void	validate() Throw a VertexiumException if the requirements for this shape are not met.
boolean	within(GeoShape geoShape) Calculate whether the given GeoShape is completely within the geometry of this object.

Methods inherited from class org.vertexium.type.GeoShapeBase

distanceBetween, getDescription

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GeoLine

public GeoLine(List<GeoPoint> geoPoints)

GeoLine

public GeoLine(List<GeoPoint> geoPoints,
               String description)

GeoLine

public GeoLine(GeoPoint start,
               GeoPoint end)

GeoLine

public GeoLine(GeoPoint start,
               GeoPoint end,
               String description)

Method Detail

intersects

public boolean intersects(GeoShape geoShape)

Description copied from interface: GeoShape

Calculate whether the given GeoShape intersects with the geometry of this object.

Parameters:

geoShape - The other shape

Returns:

True if any points of the provided shape are within the geometry of this shape or vice-versa.

within

public boolean within(GeoShape geoShape)

Description copied from interface: GeoShape

Calculate whether the given GeoShape is completely within the geometry of this object.

Parameters:

geoShape - The other shape

Returns:

True if the provided shape is completely within the geometry of this shape.

validate

public void validate()

Description copied from interface: GeoShape

Throw a VertexiumException if the requirements for this shape are not met.

Specified by:

validate in interface GeoShape

Overrides:

validate in class GeoShapeBase

addGeoPoint

public GeoLine addGeoPoint(GeoPoint geoPoint)

addGeoPoints

public GeoLine addGeoPoints(List<GeoPoint> geoPoints)

setGeoPoints

public void setGeoPoints(List<GeoPoint> geoPoints)

getGeoPoints

public List<GeoPoint> getGeoPoints()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object