org.locationtech.jts.index.strtree

Class GeometryItemDistance

java.lang.Object

org.locationtech.jts.index.strtree.GeometryItemDistance

All Implemented Interfaces:

ItemDistance

public class GeometryItemDistance
extends Object
implements ItemDistance

An ItemDistance function for items which are Geometrys, using the Geometry.distance(Geometry) method.

To make this distance function suitable for using to query a single index tree, the distance metric is anti-reflexive. That is, if the two arguments are the same Geometry object, the distance returned is Double.MAX_VALUE.

Author:

Martin Davis

Constructor Summary

Constructors

Constructor and Description
GeometryItemDistance()

Method Summary

Modifier and Type	Method and Description
double	distance(ItemBoundable item1, ItemBoundable item2) Computes the distance between two Geometry items, using the Geometry.distance(Geometry) method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeometryItemDistance

public GeometryItemDistance()

Method Detail

distance

public double distance(ItemBoundable item1,
                       ItemBoundable item2)

Computes the distance between two Geometry items, using the Geometry.distance(Geometry) method.

Specified by:

distance in interface ItemDistance

Parameters:

item1 - an item which is a Geometry

item2 - an item which is a Geometry

Returns:

the distance between the geometries

Throws:

ClassCastException - if either item is not a Geometry