Module org.apache.lucene.core

Package org.apache.lucene.geo

Class Circle2D

java.lang.Object

org.apache.lucene.geo.Circle2D

All Implemented Interfaces:

Component2D

class Circle2D
extends Object
implements Component2D

2D circle implementation containing spatial logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	Circle2D.CartesianDistance
private static interface	Circle2D.DistanceCalculator
private static class	Circle2D.HaversinDistance

Nested classes/interfaces inherited from interface org.apache.lucene.geo.Component2D

Component2D.WithinRelation

Field Summary

Fields

Modifier and Type	Field	Description
private final Circle2D.DistanceCalculator	calculator

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Circle2D(Circle2D.DistanceCalculator calculator)

Method Summary

Modifier and Type	Method	Description
boolean	contains(double x, double y)	relates this component2D with a point *
boolean	containsLine(double minX, double maxX, double minY, double maxY, double aX, double aY, double bX, double bY)	return true if this component2D contains the provided line *
boolean	containsTriangle(double minX, double maxX, double minY, double maxY, double aX, double aY, double bX, double bY, double cX, double cY)	return true if this component2D contains the provided triangle *
(package private) static Component2D	create(Circle circle)	Builds a Circle2D from Circle.
(package private) static Component2D	create(XYCircle circle)	Builds a XYCircle2D from XYCircle.
double	getMaxX()	max X value for the component *
double	getMaxY()	max Y value for the component *
double	getMinX()	min X value for the component *
double	getMinY()	min Y value for the component *
boolean	intersectsLine(double minX, double maxX, double minY, double maxY, double aX, double aY, double bX, double bY)	return true if this component2D intersects the provided line *
private static boolean	intersectsLine(double centerX, double centerY, double aX, double aY, double bX, double bY, Circle2D.DistanceCalculator calculator)
boolean	intersectsTriangle(double minX, double maxX, double minY, double maxY, double aX, double aY, double bX, double bY, double cX, double cY)	return true if this component2D intersects the provided triangle *
PointValues.Relation	relate(double minX, double maxX, double minY, double maxY)	relates this component2D with a bounding box *
Component2D.WithinRelation	withinLine(double minX, double maxX, double minY, double maxY, double aX, double aY, boolean ab, double bX, double bY)	Compute the within relation of this component2D with a line *
Component2D.WithinRelation	withinPoint(double x, double y)	Compute the within relation of this component2D with a point *
Component2D.WithinRelation	withinTriangle(double minX, double maxX, double minY, double maxY, double aX, double aY, boolean ab, double bX, double bY, boolean bc, double cX, double cY, boolean ca)	Compute the within relation of this component2D with a triangle *

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.geo.Component2D

containsLine, containsTriangle, intersectsLine, intersectsTriangle, withinLine, withinTriangle

Field Details

calculator

private final Circle2D.DistanceCalculator calculator

Constructor Details

Circle2D

private Circle2D(Circle2D.DistanceCalculator calculator)

Method Details

getMinX

public double getMinX()

Description copied from interface: Component2D

min X value for the component *

Specified by:

getMinX in interface Component2D

getMaxX

public double getMaxX()

Description copied from interface: Component2D

max X value for the component *

Specified by:

getMaxX in interface Component2D

getMinY

public double getMinY()

Description copied from interface: Component2D

min Y value for the component *

Specified by:

getMinY in interface Component2D

getMaxY

public double getMaxY()

Description copied from interface: Component2D

max Y value for the component *

Specified by:

getMaxY in interface Component2D

contains

public boolean contains(double x,
 double y)

Description copied from interface: Component2D

relates this component2D with a point *

Specified by:

contains in interface Component2D

relate

public PointValues.Relation relate(double minX,
 double maxX,
 double minY,
 double maxY)

Description copied from interface: Component2D

relates this component2D with a bounding box *

Specified by:

relate in interface Component2D

intersectsLine

public boolean intersectsLine(double minX,
 double maxX,
 double minY,
 double maxY,
 double aX,
 double aY,
 double bX,
 double bY)

Description copied from interface: Component2D

return true if this component2D intersects the provided line *

Specified by:

intersectsLine in interface Component2D

intersectsTriangle

public boolean intersectsTriangle(double minX,
 double maxX,
 double minY,
 double maxY,
 double aX,
 double aY,
 double bX,
 double bY,
 double cX,
 double cY)

Description copied from interface: Component2D

return true if this component2D intersects the provided triangle *

Specified by:

intersectsTriangle in interface Component2D

containsLine

public boolean containsLine(double minX,
 double maxX,
 double minY,
 double maxY,
 double aX,
 double aY,
 double bX,
 double bY)

Description copied from interface: Component2D

return true if this component2D contains the provided line *

Specified by:

containsLine in interface Component2D

containsTriangle

public boolean containsTriangle(double minX,
 double maxX,
 double minY,
 double maxY,
 double aX,
 double aY,
 double bX,
 double bY,
 double cX,
 double cY)

Description copied from interface: Component2D

return true if this component2D contains the provided triangle *

Specified by:

containsTriangle in interface Component2D

withinPoint

public Component2D.WithinRelation withinPoint(double x,
 double y)

Description copied from interface: Component2D

Compute the within relation of this component2D with a point *

Specified by:

withinPoint in interface Component2D

withinLine

public Component2D.WithinRelation withinLine(double minX,
 double maxX,
 double minY,
 double maxY,
 double aX,
 double aY,
 boolean ab,
 double bX,
 double bY)

Description copied from interface: Component2D

Compute the within relation of this component2D with a line *

Specified by:

withinLine in interface Component2D

withinTriangle

public Component2D.WithinRelation withinTriangle(double minX,
 double maxX,
 double minY,
 double maxY,
 double aX,
 double aY,
 boolean ab,
 double bX,
 double bY,
 boolean bc,
 double cX,
 double cY,
 boolean ca)

Description copied from interface: Component2D

Compute the within relation of this component2D with a triangle *

Specified by:

withinTriangle in interface Component2D

intersectsLine

private static boolean intersectsLine(double centerX,
 double centerY,
 double aX,
 double aY,
 double bX,
 double bY,
 Circle2D.DistanceCalculator calculator)

create

static Component2D create(XYCircle circle)

Builds a XYCircle2D from XYCircle. Distance calculations are performed using cartesian distance.

create

static Component2D create(Circle circle)

Builds a Circle2D from Circle. Distance calculations are performed using haversin distance.