org.apache.lucene.spatial.spatial4j.geo3d

Interface GeoArea

All Superinterfaces:

Membership

All Known Subinterfaces:

GeoBBox

All Known Implementing Classes:

GeoBBoxBase, GeoDegenerateHorizontalLine, GeoDegenerateLatitudeZone, GeoDegenerateLongitudeSlice, GeoDegeneratePoint, GeoDegenerateVerticalLine, GeoLatitudeZone, GeoLongitudeSlice, GeoNorthLatitudeZone, GeoNorthRectangle, GeoRectangle, GeoSouthLatitudeZone, GeoSouthRectangle, GeoWideDegenerateHorizontalLine, GeoWideLongitudeSlice, GeoWideNorthRectangle, GeoWideRectangle, GeoWideSouthRectangle, GeoWorld

public interface GeoArea
extends Membership

A GeoArea represents a standard 2-D breakdown of a part of sphere. It can be bounded in latitude, or bounded in both latitude and longitude, or not bounded at all. The purpose of the interface is to describe bounding shapes used for computation of geo hashes.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTAINS
static int	DISJOINT
static int	OVERLAPS
static int	WITHIN

Method Summary

Methods

Modifier and Type	Method and Description
int	getRelationship(GeoShape shape) Find the spatial relationship between a shape and the current geo area.

Methods inherited from interface org.apache.lucene.spatial.spatial4j.geo3d.Membership

isWithin, isWithin

Field Detail

CONTAINS

static final int CONTAINS

See Also:

Constant Field Values

WITHIN

static final int WITHIN

See Also:

Constant Field Values

OVERLAPS

static final int OVERLAPS

See Also:

Constant Field Values

DISJOINT

static final int DISJOINT

See Also:

Constant Field Values

Method Detail

getRelationship

int getRelationship(GeoShape shape)

Find the spatial relationship between a shape and the current geo area. Note: return value is how the GeoShape relates to the GeoArea, not the other way around. For example, if this GeoArea is entirely within the shape, then CONTAINS should be returned. If the shape is entirely enclosed by this GeoArea, then WITHIN should be returned. Note well: When a shape consists of multiple independent overlapping subshapes, it is sometimes impossible to determine the distinction between OVERLAPS and CONTAINS. In that case, OVERLAPS may be returned even though the proper result would in fact be CONTAINS. Code accordingly.

Parameters:

shape - is the shape to consider.

Returns:

the relationship, from the perspective of the shape.