Index (jeospatial API Specification)

A B C D E G H I L M N P R S T V

A

add(E) - Method in class com.eatthepath.jeospatial.util.SearchResults: Offers a point to this result set.
add(E) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
add(E) - Method in class com.eatthepath.jeospatial.vptree.VPTree: Adds a single point to this vp-tree.
addAll(Collection<? extends E>) - Method in class com.eatthepath.jeospatial.util.SearchResults: Offers all of the points in the given collection to this result set.
addAll(Collection<? extends E>) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
addAll(Collection<? extends E>) - Method in class com.eatthepath.jeospatial.vptree.VPTree: Adds all of the points in the given collection to this vp-tree.

B

BoundingBoxSearchCriteria<T extends GeospatialPoint> - Class in com.eatthepath.jeospatial.util: A SearchCriteria implementation that matches all points within a bounding "box." The BoundingBoxSearchCriteria class is designed to assist in implementing bounding box search methods specified by the GeospatialPointDatabase interface.
BoundingBoxSearchCriteria(double, double, double, double) - Constructor for class com.eatthepath.jeospatial.util.BoundingBoxSearchCriteria: Constructs a new set of bounding box search criteria with the given box limits.
BoundingBoxSearchCriteria(double, double, double, double, SearchCriteria<T>) - Constructor for class com.eatthepath.jeospatial.util.BoundingBoxSearchCriteria: Constructs a new set of bounding box search criteria with the given box limits and additional search criteria.

C

clear() - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
clear() - Method in class com.eatthepath.jeospatial.vptree.VPTree: Removes all points from this vp-tree.
com.eatthepath.jeospatial - package com.eatthepath.jeospatial: Provides core interfaces for the jeospatial library.
com.eatthepath.jeospatial.util - package com.eatthepath.jeospatial.util: Provides simple implementations of the GeospatialPoint interface and Comparators and utility classes for conducting nearest-neighbor searches in GeospatialPointDatabases.
com.eatthepath.jeospatial.vptree - package com.eatthepath.jeospatial.vptree: Provides GeospatialPointDatabase implementations based on vantage point trees.
compare(T, T) - Method in class com.eatthepath.jeospatial.util.GeospatialDistanceComparator: Compares two geospatial points for order based on their distance from the origin point given when this comparator was constructed.
contains(Object) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
contains(Object) - Method in class com.eatthepath.jeospatial.vptree.VPTree: Tests whether this vp-tree contains the given point.
containsAll(Collection<?>) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
containsAll(Collection<?>) - Method in class com.eatthepath.jeospatial.vptree.VPTree: Tests whether this vp-tree contains all of the points in the given collection.

D

DEFAULT_BIN_SIZE - Static variable in class com.eatthepath.jeospatial.vptree.VPTree: The default node capacity (32 points) for nodes in this tree.

E

EARTH_RADIUS - Static variable in interface com.eatthepath.jeospatial.GeospatialPoint: The radius of the earth in meters; all implementing whose distance calculations rely upon the radius of the earth should reference this value.
equals(Object) - Method in class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Compares this point to another object.

G

GeospatialDistanceComparator<T extends GeospatialPoint> - Class in com.eatthepath.jeospatial.util: A comparator that sorts geospatial points in order of increasing distance from a given origin point.
GeospatialDistanceComparator(GeospatialPoint) - Constructor for class com.eatthepath.jeospatial.util.GeospatialDistanceComparator: Constructs a new comparator that sorts geospatial points according to their distance from the given origin point.
GeospatialPoint - Interface in com.eatthepath.jeospatial: A geospatial point is a single point on the earth's surface.
GeospatialPointDatabase<E extends GeospatialPoint> - Interface in com.eatthepath.jeospatial: A GeospatialPointDatabase is a collection of geospatial points that can be queried to locate points that are spatially close to a given query point.
getAllNeighborsWithinDistance(GeospatialPoint, double) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns a list of all points within a given distance to a query point.
getAllNeighborsWithinDistance(GeospatialPoint, double, SearchCriteria<E>) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns a list of all points within a given distance to a query point that meet a set of search criteria.
getAllNeighborsWithinDistance(GeospatialPoint, double) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
getAllNeighborsWithinDistance(GeospatialPoint, double, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
getAllNeighborsWithinDistance(GeospatialPoint, double) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getAllNeighborsWithinDistance(GeospatialPoint, double, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getAllPointsInBoundingBox(double, double, double, double) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns a list of all points in the database within the given bounding "box." A point is considered to be inside the box if its latitude falls between the given north and south limits (inclusive) and its longitude falls between the east and west limits (inclusive).
getAllPointsInBoundingBox(double, double, double, double, GeospatialPoint) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns a list of all points in the database within the given bounding "box." A point is considered to be inside the box if its latitude falls between the given north and south limits (inclusive) and its longitude falls between the east and west limits (inclusive).
getAllPointsInBoundingBox(double, double, double, double, SearchCriteria<E>) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns a list of all points in the database within the given bounding "box" that also satisfy the given search criteria.
getAllPointsInBoundingBox(double, double, double, double, SearchCriteria<E>, GeospatialPoint) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns a list of all points in the database within the given bounding "box" that also satisfy the given search criteria.
getAllPointsInBoundingBox(double, double, double, double) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getAllPointsInBoundingBox(double, double, double, double, GeospatialPoint) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getAllPointsInBoundingBox(double, double, double, double, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getAllPointsInBoundingBox(double, double, double, double, SearchCriteria<E>, GeospatialPoint) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getBinSize() - Method in class com.eatthepath.jeospatial.vptree.VPTree: Returns the maximum number of points any leaf node of this tree should contain.
getDistanceTo(GeospatialPoint) - Method in interface com.eatthepath.jeospatial.GeospatialPoint: Calculates the "great circle" or orthometric distance between this point and another point on the earth's surface.
getDistanceTo(double, double) - Method in interface com.eatthepath.jeospatial.GeospatialPoint: Calculates the "great circle" or orthometric distance between this point and another point on the earth's surface.
getDistanceTo(GeospatialPoint) - Method in class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Returns the "great circle" distance to another geospatial point.
getDistanceTo(double, double) - Method in class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Returns the "great circle" distance to another geospatial point.
getLatitude() - Method in interface com.eatthepath.jeospatial.GeospatialPoint: Returns the latitude of this point.
getLatitude() - Method in class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Returns the latitude of this point.
getLongestDistanceFromQueryPoint() - Method in class com.eatthepath.jeospatial.util.SearchResults: Returns the distance from the query point provided at construction time to the most distant point in this result set.
getLongitude() - Method in interface com.eatthepath.jeospatial.GeospatialPoint: Returns the longitude of this point.
getLongitude() - Method in class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Returns the longitude of this point.
getNearestNeighbor(GeospatialPoint) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns the nearest neighbor to the given query point.
getNearestNeighbor(GeospatialPoint, double) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns the nearest neighbor to the given query point so long as the nearest neighbor is within the given maximum distance.
getNearestNeighbor(GeospatialPoint, SearchCriteria<E>) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns the nearest neighbor to the given query point that satisfies the given search criteria.
getNearestNeighbor(GeospatialPoint, double, SearchCriteria<E>) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns the nearest neighbor to the query point that satisfies the given search criteria so long as that point falls within the given maximum distance from the query point.
getNearestNeighbor(GeospatialPoint) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
getNearestNeighbor(GeospatialPoint, double) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
getNearestNeighbor(GeospatialPoint, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
getNearestNeighbor(GeospatialPoint, double, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
getNearestNeighbor(GeospatialPoint) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getNearestNeighbor(GeospatialPoint, double) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getNearestNeighbor(GeospatialPoint, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getNearestNeighbor(GeospatialPoint, double, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getNearestNeighbors(GeospatialPoint, int) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns a list of the nearest neighbors to a given query point.
getNearestNeighbors(GeospatialPoint, int, SearchCriteria<E>) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns a list of the nearest neighbors to a given query point that satisfy the given search criteria.
getNearestNeighbors(GeospatialPoint, int, double) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns a list of the nearest neighbors to a given query point and within a given maximum distance.
getNearestNeighbors(GeospatialPoint, int, double, SearchCriteria<E>) - Method in interface com.eatthepath.jeospatial.GeospatialPointDatabase: Returns a list of the nearest neighbors to a given query point and within a given maximum distance.
getNearestNeighbors(GeospatialPoint, int) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
getNearestNeighbors(GeospatialPoint, int, double) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
getNearestNeighbors(GeospatialPoint, int, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
getNearestNeighbors(GeospatialPoint, int, double, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
getNearestNeighbors(GeospatialPoint, int) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getNearestNeighbors(GeospatialPoint, int, double) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getNearestNeighbors(GeospatialPoint, int, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.VPTree
getNearestNeighbors(GeospatialPoint, int, double, SearchCriteria<E>) - Method in class com.eatthepath.jeospatial.vptree.VPTree

H

hashCode() - Method in class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Generates a hash code value for this point.
hasNext() - Method in class com.eatthepath.jeospatial.vptree.TreeIterator

I

isEmpty() - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
isEmpty() - Method in class com.eatthepath.jeospatial.vptree.VPTree: Tests whether this tree is empty.
isFair() - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree: Tests whether this tree's internal lock uses a "fair" locking policy.
iterator() - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
iterator() - Method in class com.eatthepath.jeospatial.vptree.VPTree: Returns an Iterator over all of the points contained in this tree.

L

LockingVPTree<E extends GeospatialPoint> - Class in com.eatthepath.jeospatial.vptree: A LockingVPTree is a thread-safe subclass of a VPTree.
LockingVPTree() - Constructor for class com.eatthepath.jeospatial.vptree.LockingVPTree: Constructs a new, empty LockingVPTree with a default node capacity and locking fairness policy.
LockingVPTree(boolean) - Constructor for class com.eatthepath.jeospatial.vptree.LockingVPTree: Constructs a new, empty LockingVPTree with a default node capacity and the given fairness policy.
LockingVPTree(int) - Constructor for class com.eatthepath.jeospatial.vptree.LockingVPTree: Constructs a new, empty LockingVPTree with the given node capacity and a default locking fairness policy.
LockingVPTree(int, boolean) - Constructor for class com.eatthepath.jeospatial.vptree.LockingVPTree: Constructs a new, empty LockingVPTree with the given node capacity and locking fairness policy.
LockingVPTree(Collection<E>) - Constructor for class com.eatthepath.jeospatial.vptree.LockingVPTree: Constructs a new LockingVPTree that contains (and indexes) all of the points in the given collection with a default node capacity and locking fairness policy.
LockingVPTree(Collection<E>, boolean) - Constructor for class com.eatthepath.jeospatial.vptree.LockingVPTree: Constructs a new LockingVPTree that contains (and indexes) all of the points in the given collection with a default node capacity and the given locking fairness policy.
LockingVPTree(Collection<E>, int) - Constructor for class com.eatthepath.jeospatial.vptree.LockingVPTree: Constructs a new LockingVPTree that contains (and indexes) all of the points in the given collection with the given node capacity and a default locking fairness policy.
LockingVPTree(Collection<E>, int, boolean) - Constructor for class com.eatthepath.jeospatial.vptree.LockingVPTree: Constructs a new LockingVPTree that contains (and indexes) all of the points in the given collection with the given node capacity and locking fairness policy.

M

matches(T) - Method in interface com.eatthepath.jeospatial.SearchCriteria: Tests whether an individual point matches an arbitrary set of supplementary criteria.
matches(T) - Method in class com.eatthepath.jeospatial.util.BoundingBoxSearchCriteria: Tests whether the given point falls within the bounds of the box given at construction time and satisfies the given additional search criteria (if any).

N

next() - Method in class com.eatthepath.jeospatial.vptree.TreeIterator

P

PartitionException - Exception in com.eatthepath.jeospatial.vptree: A PartitionException is thrown when partitioning of a VPTree node fails.
PartitionException() - Constructor for exception com.eatthepath.jeospatial.vptree.PartitionException: Constructs a PartitionException with no detail message.
PartitionException(String) - Constructor for exception com.eatthepath.jeospatial.vptree.PartitionException: Constructs a PartitionException with the given detail message.

R

remove(Object) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
remove() - Method in class com.eatthepath.jeospatial.vptree.TreeIterator
remove(Object) - Method in class com.eatthepath.jeospatial.vptree.VPTree: Removes a point from this tree.
removeAll(Collection<?>) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
removeAll(Collection<?>) - Method in class com.eatthepath.jeospatial.vptree.VPTree: Removes all of the points in the given collection from this tree.
retainAll(Collection<?>) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
retainAll(Collection<?>) - Method in class com.eatthepath.jeospatial.vptree.VPTree: Retains only the points in this vp-tree that are contained in the specified collection.

S

SearchCriteria<T extends GeospatialPoint> - Interface in com.eatthepath.jeospatial: SearchCriteria can be applied to nearest-neighbor searches in a GeospatialPointDatabase to filter the returned list of nearest neighbors by arbitrary criteria beyond the built-in/implicit distance criteria.
SearchResults<E extends GeospatialPoint> - Class in com.eatthepath.jeospatial.util: The SearchResults class is a fixed-size PriorityQueue subclass that may or may not accept points that are offered to it based on several criteria.
SearchResults(GeospatialPoint, int) - Constructor for class com.eatthepath.jeospatial.util.SearchResults: Constructs a new search result collector that collects up to maxSize points.
SearchResults(GeospatialPoint, int, double) - Constructor for class com.eatthepath.jeospatial.util.SearchResults: Constructs a new search result collector that collects up to maxSize points that fall within the given distance to the query point.
SearchResults(GeospatialPoint, int, SearchCriteria<E>) - Constructor for class com.eatthepath.jeospatial.util.SearchResults: Constructs a new search result collector that collects up to maxSize points that meet the given search criteria.
SearchResults(GeospatialPoint, int, double, SearchCriteria<E>) - Constructor for class com.eatthepath.jeospatial.util.SearchResults: Constructs a new search result collector that collects up to maxSize points that fall within the given distance to the query point and meet the given search criteria.
setLatitude(double) - Method in class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Sets the latitude of this point.
setLongitude(double) - Method in class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Sets the longitude of this point.
SimpleGeospatialPoint - Class in com.eatthepath.jeospatial.util: A simple geospatial point implementation.
SimpleGeospatialPoint(double, double) - Constructor for class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Constructs a new geospatial point at the given latitude and longitude coordinates.
SimpleGeospatialPoint(GeospatialPoint) - Constructor for class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Constructs a new geospatial point at the same coordinates as the given point.
size() - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
size() - Method in class com.eatthepath.jeospatial.vptree.VPTree: Returns the total number of points stored in this vp-tree.

T

toArray() - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
toArray(T[]) - Method in class com.eatthepath.jeospatial.vptree.LockingVPTree
toArray() - Method in class com.eatthepath.jeospatial.vptree.VPTree: Returns an array containing all of the points in this vp-tree.
toArray(T[]) - Method in class com.eatthepath.jeospatial.vptree.VPTree: Returns an array containing all of the points in this vp-tree; the runtime type of the returned array is that of the specified array.
toSortedList() - Method in class com.eatthepath.jeospatial.util.SearchResults: Returns a list of the points in this result set sorted in order of increasing distance from the query point provided at construction time.
toString() - Method in class com.eatthepath.jeospatial.util.SimpleGeospatialPoint: Returns a human-readable String representation of this point.
TreeIterator<E extends GeospatialPoint> - Class in com.eatthepath.jeospatial.vptree
TreeIterator(VPTree<E>.VPNode<E>) - Constructor for class com.eatthepath.jeospatial.vptree.TreeIterator

V

VPTree<E extends GeospatialPoint> - Class in com.eatthepath.jeospatial.vptree: A geospatial database that uses a vantage point tree as its storage mechanism.
VPTree() - Constructor for class com.eatthepath.jeospatial.vptree.VPTree: Constructs a new, empty vp-tree with a default node capacity.
VPTree(int) - Constructor for class com.eatthepath.jeospatial.vptree.VPTree: Constructs a new, empty vp-tree with the specified node capacity.
VPTree(Collection<E>) - Constructor for class com.eatthepath.jeospatial.vptree.VPTree: Constructs a new vp-tree that contains (and indexes) all of the points in the given collection.
VPTree(Collection<E>, int) - Constructor for class com.eatthepath.jeospatial.vptree.VPTree: Constructs a new vp-tree that contains (and indexes) all of the points in the given collection and has leaf nodes with the given point capacity.

A B C D E G H I L M N P R S T V