org.transitime.db.structs

Class Extent

java.lang.Object

org.transitime.db.structs.Extent

All Implemented Interfaces:

java.io.Serializable

@Immutable
 @Embeddable
public class Extent
extends java.lang.Object
implements java.io.Serializable

A rectangle specified by min and max latitudes and longitudes.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Extent() Hibernate requires a no-arg constructor so might as well be explicit about it.

Method Summary

Modifier and Type	Method and Description
void	add(Extent e) Once an Extent has been constructed need to simply add associated Extents (or Locations).
void	add(Location l) Once an Extent has been constructed need to simply add associated Locations (or Extents).
boolean	equals(java.lang.Object obj) If don't have hashCode() and equals() then the objects that include this object will generate a warning when these methods are implemented.
double	getMaxLat()
double	getMaxLon()
double	getMinLat()
double	getMinLon()
int	hashCode() If don't have hashCode() and equals() then the objects that include this object will generate a warning when these methods are implemented.
boolean	isWithinDistance(Location loc, double distance) Returns true if the location is with the specified distance of this extent.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Extent

public Extent()

Hibernate requires a no-arg constructor so might as well be explicit about it.

Method Detail

add

public void add(Location l)

Once an Extent has been constructed need to simply add associated Locations (or Extents). Once all locations have been added the Extent will be the rectangle spanning all of those Locations and Extents.

Parameters:

l -

add

public void add(Extent e)

Once an Extent has been constructed need to simply add associated Extents (or Locations). Once all have been added the Extent will be the rectangle spanning all of those Locations and Extents.

Parameters:

l -

hashCode

public int hashCode()

If don't have hashCode() and equals() then the objects that include this object will generate a warning when these methods are implemented.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

If don't have hashCode() and equals() then the objects that include this object will generate a warning when these methods are implemented.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isWithinDistance

public boolean isWithinDistance(Location loc,
                                double distance)

Returns true if the location is with the specified distance of this extent. This is not a perfectly accurate calculation due to METERS_PER_DEGREE being a constant and not taking into account changes in diameter of the earth depending on latitude. Also, looks at latitude and longitude separately. So there is a corner case where latitude and longitude might be OK individually, so the method returns true, but together the distance would be actually be further away then the specified distance.

Parameters:

loc -

distance -

Returns:

getMinLat

public double getMinLat()

getMaxLat

public double getMaxLat()

getMinLon

public double getMinLon()

getMaxLon

public double getMaxLon()