org.apache.lucene.spatial.spatial4j.geo3d

Class GeoDegeneratePoint

java.lang.Object

org.apache.lucene.spatial.spatial4j.geo3d.Vector

org.apache.lucene.spatial.spatial4j.geo3d.GeoPoint

org.apache.lucene.spatial.spatial4j.geo3d.GeoDegeneratePoint

All Implemented Interfaces:

GeoArea, GeoBBox, GeoMembershipShape, GeoShape, GeoSizeable, Membership

public class GeoDegeneratePoint
extends GeoPoint
implements GeoBBox

This class represents a degenerate point bounding box. It is not a simple GeoPoint because we must have the latitude and longitude.

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
GeoPoint[]	edgePoints
double	latitude
double	longitude

Fields inherited from class org.apache.lucene.spatial.spatial4j.geo3d.Vector

MINIMUM_RESOLUTION, MINIMUM_RESOLUTION_CUBED, MINIMUM_RESOLUTION_SQUARED, x, y, z

Fields inherited from interface org.apache.lucene.spatial.spatial4j.geo3d.GeoArea

CONTAINS, DISJOINT, OVERLAPS, WITHIN

Constructor Summary

Constructors

Constructor and Description
GeoDegeneratePoint(double lat, double lon)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Equals
GeoBBox	expand(double angle) Expand box by specified angle.
Bounds	getBounds(Bounds bounds) Compute longitude/latitude bounds for the shape.
GeoPoint	getCenter() Returns the center of a circle into which the area will be inscribed.
GeoPoint[]	getEdgePoints() Return a sample point that is on the edge of the shape.
double	getRadius() Returns the radius of a circle into which the GeoSizeable area can be inscribed.
int	getRelationship(GeoShape shape) Find the spatial relationship between a shape and the current geo area.
int	hashCode()
boolean	intersects(Plane plane, GeoPoint[] notablePoints, Membership... bounds) Assess whether a plane, within the provided bounds, intersects with the shape.
boolean	isWithin(double x, double y, double z) Check if a point is within this shape.
boolean	isWithin(Vector point) Check if a point is within this shape.
String	toString()

Methods inherited from class org.apache.lucene.spatial.spatial4j.geo3d.GeoPoint

arcDistance

Methods inherited from class org.apache.lucene.spatial.spatial4j.geo3d.Vector

dotProduct, dotProduct, isWithin, linearDistance, linearDistance, linearDistanceSquared, linearDistanceSquared, magnitude, normalDistance, normalDistance, normalDistanceSquared, normalDistanceSquared, normalize, rotateXY, rotateXY, rotateXZ, rotateXZ, rotateZY, rotateZY, translate

Methods inherited from class java.lang.Object

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

Field Detail

latitude

public final double latitude

longitude

public final double longitude

edgePoints

public final GeoPoint[] edgePoints

Constructor Detail

GeoDegeneratePoint

public GeoDegeneratePoint(double lat,
                  double lon)

Method Detail

expand

public GeoBBox expand(double angle)

Expand box by specified angle.

Specified by:

expand in interface GeoBBox

Parameters:

angle - is the angle amount to expand the GeoBBox by.

Returns:

a new GeoBBox.

getEdgePoints

public GeoPoint[] getEdgePoints()

Return a sample point that is on the edge of the shape.

Specified by:

getEdgePoints in interface GeoShape

Returns:

an interior point.

intersects

public boolean intersects(Plane plane,
                 GeoPoint[] notablePoints,
                 Membership... bounds)

Assess whether a plane, within the provided bounds, intersects with the shape.

Specified by:

intersects in interface GeoShape

Parameters:

plane - is the plane to assess for intersection with the shape's edges or bounding curves.

bounds - are a set of bounds that define an area that an intersection must be within in order to qualify (provided by a GeoArea).

notablePoints - represents the intersections of the plane with the supplied bounds. These are used to disambiguate when two planes are identical and it needs to be determined whether any points exist that fulfill all the bounds.

Returns:

true if there's such an intersection, false if not.

getBounds

public Bounds getBounds(Bounds bounds)

Compute longitude/latitude bounds for the shape.

Specified by:

getBounds in interface GeoShape

Parameters:

bounds - is the optional input bounds object. If this is null, a bounds object will be created. Otherwise, the input object will be modified.

Returns:

a Bounds object describing the shape's bounds. If the bounds cannot be computed, then return a Bounds object with noLongitudeBound, noTopLatitudeBound, and noBottomLatitudeBound.

equals

public boolean equals(Object o)

Equals

Specified by:

equals in interface GeoShape

Overrides:

equals in class Vector

hashCode

public int hashCode()

Overrides:

hashCode in class Vector

toString

public String toString()

Overrides:

toString in class Vector

isWithin

public boolean isWithin(Vector point)

Check if a point is within this shape.

Specified by:

isWithin in interface Membership

Parameters:

point - is the point to check.

Returns:

true if the point is within this shape

isWithin

public boolean isWithin(double x,
               double y,
               double z)

Check if a point is within this shape.

Specified by:

isWithin in interface Membership

Parameters:

x - is x coordinate of point to check.

y - is y coordinate of point to check.

z - is z coordinate of point to check.

Returns:

true if the point is within this shape

getRadius

public double getRadius()

Returns the radius of a circle into which the GeoSizeable area can be inscribed.

Specified by:

getRadius in interface GeoSizeable

Returns:

the radius.

getCenter

public GeoPoint getCenter()

Returns the center of a circle into which the area will be inscribed.

Specified by:

getCenter in interface GeoSizeable

Returns:

the center.

getRelationship

public 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.

Specified by:

getRelationship in interface GeoArea

Parameters:

shape - is the shape to consider.

Returns:

the relationship, from the perspective of the shape.