votorola.a

Class Geocode

java.lang.Object

Geocode

public final class Geocode
extends Object

The cached geocoding of a residential address, backed by a row of the vote-server's geocode table. Caching is employed to lighten the load on the geocoding service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Geocode.GeocodingException Thrown when a geocoding-specific IO exception occurs.
static class	Geocode.Table The geocode table of a vote-server, caching geocode data in relational form.

Constructor Summary

Constructors

Constructor and Description
Geocode(String region, String address, Geocode.Table table) Constructs a Geocode, reading its initial state from the geocode table, or leaving it at default values if it does not exist in the table.

Method Summary

Methods

Modifier and Type	Method and Description
String	address() The street address that is geocoded.
boolean	exists() Returns true if this geocode has been stored in the table; false otherwise.
double	latitude() The latitude of the address in radians.
double	longitude() The longitude of the address in radians.
String	region() The country in which the address is specified.
void	setCoordinates(double newLatitude, double newLongitude) Sets the latitude and longitude.
long	timestamp() The time at which this geocode was last stored to the table, in milliseconds since the 'epoch'; or zero, if it was never stored.
String	toString() Returns a descripion of this geocode, including the address and its geographic coordinates.
void	write(Geocode.Table table) Stores this geocode in the table.

Methods inherited from class java.lang.Object

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

Constructor Detail

Geocode

public Geocode(String region,
       String address,
       Geocode.Table table)
        throws SQLException

Constructs a Geocode, reading its initial state from the geocode table, or leaving it at default values if it does not exist in the table.

Parameters:

table - the vote-server's geocode table.

Throws:

SQLException

See Also:

region(), address()

Method Detail

address

public String address()

The street address that is geocoded. It ought to be in minimal canonical form, such as a normalized postal code, otherwise the geocode table may grow unnecessarily large.

exists

public boolean exists()

Returns true if this geocode has been stored in the table; false otherwise.

latitude

public double latitude()

The latitude of the address in radians.

See Also:

setCoordinates(double,double)

longitude

public double longitude()

The longitude of the address in radians.

See Also:

setCoordinates(double,double)

region

public String region()

The country in which the address is specified. This is a two-character, country code top-level domain (ccTLD).

setCoordinates

public void setCoordinates(double newLatitude,
                  double newLongitude)

Sets the latitude and longitude.

See Also:

latitude(), longitude()

timestamp

public final long timestamp()

The time at which this geocode was last stored to the table, in milliseconds since the 'epoch'; or zero, if it was never stored. This is intended to implement a rolling turn-over of the cache, keeping it refeshed with relatively recent values (say no older than five years) from the geocoding service - but that has not been implemented yet.

See Also:

System.currentTimeMillis()

write

public void write(Geocode.Table table)
           throws SQLException

Stores this geocode in the table.

Parameters:

table - the vote-server's geocode table.

Throws:

SQLException

toString

public String toString()

Returns a descripion of this geocode, including the address and its geographic coordinates.

Overrides:

toString in class Object