prajna.data

Class Location

java.lang.Object

prajna.data.Location

All Implemented Interfaces:

java.io.Serializable, Locatable

Direct Known Subclasses:

GeoObject

public class Location
extends java.lang.Object
implements Locatable

Class representing a geographic location. This class can represent a named geographic entity, a single coordinate, or a geographic region with center and radius.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Location(GeoCoord coord) Instantiates a new location as a simple coordinate.
Location(GeoCoord coord, double locRadius) Instantiates a new location with a coordinate and radius
Location(java.lang.String placeName) Instantiates a new location as a named entity.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Return whether this object is equal to another object
GeoCoord	getCenter() Get the geographic center
java.lang.String	getName() Gets the name.
double	getRadius() Get the radius of the geographic entity.
int	hashCode() Return the hash code of the location, which is based upon the String returned by toString()
void	setCenter(GeoCoord coord) Sets the center.
void	setName(java.lang.String locName) Sets the name.
void	setRadius(double locRadius) Set the radius of the geographic entity.
java.lang.String	toString() Return a string representation of this location

Methods inherited from class java.lang.Object

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

Constructor Detail

Location

public Location(GeoCoord coord)

Instantiates a new location as a simple coordinate.

Parameters:

coord - the coordinate

Location

public Location(GeoCoord coord,
        double locRadius)

Instantiates a new location with a coordinate and radius

Parameters:

coord - the center coordinate

locRadius - the radius of the location, in meters

Location

public Location(java.lang.String placeName)

Instantiates a new location as a named entity. The center and radius for this named location are not set implicitly, and therefore must be set explicitly.

Parameters:

placeName - the place name

Method Detail

equals

public boolean equals(java.lang.Object obj)

Return whether this object is equal to another object

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare

Returns:

true if this object is equal to the other object, false otherwise.

getCenter

public GeoCoord getCenter()

Get the geographic center

Specified by:

getCenter in interface Locatable

Returns:

the center coordinate

getName

public java.lang.String getName()

Gets the name.

Returns:

the name

getRadius

public double getRadius()

Get the radius of the geographic entity.

Specified by:

getRadius in interface Locatable

Returns:

the radius of the geographic entity, in meters.

hashCode

public int hashCode()

Return the hash code of the location, which is based upon the String returned by toString()

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code of the object

setCenter

public void setCenter(GeoCoord coord)

Sets the center.

Parameters:

coord - the new center coordinate

setName

public void setName(java.lang.String locName)

Sets the name.

Parameters:

locName - the name of the location

setRadius

public void setRadius(double locRadius)

Set the radius of the geographic entity. The default radius is 0.

Parameters:

locRadius - the radius of the geographic entity, in meters.

toString

public java.lang.String toString()

Return a string representation of this location

Overrides:

toString in class java.lang.Object

Returns:

the name, or the geographic coordinate's string representation if the name has not been set.