prajna.geo

Class GeoObject

java.lang.Object

prajna.data.Location

prajna.geo.GeoObject

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GeoObject>, Locatable

public class GeoObject
extends Location
implements java.lang.Comparable<GeoObject>

Extends location to include additional information about a geographic entity. This class provides alternate names, population, country. It also implements a Comparable interface, which attempts to rank geographic objects in order of importance.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeoObject(java.lang.String name) Create a new GeoObject with the given name
GeoObject(java.lang.String name, GeoFeatureType geoType) Create a new GeoObject with the given name and type

Method Summary

Methods

Modifier and Type	Method and Description
void	addAltName(java.lang.String altName) Add an alternate name for this object
int	compareTo(GeoObject other) Compare this geographic object to another geographic object.
java.util.Set<java.lang.String>	getAltNames() Get the set of alternate names
java.lang.String	getCountry() Get the country this object is included in.
long	getPopulation() Get the population for this object
GeoFeatureType	getType() Get the geographic feature type for this object
void	setCountry(java.lang.String cntryName) Set the country name for this object.
void	setFeatureType(GeoFeatureType featureType) Set the geographic feature type
void	setPopulation(long pop) Set the population

Methods inherited from class prajna.data.Location

equals, getCenter, getName, getRadius, hashCode, setCenter, setName, setRadius, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoObject

public GeoObject(java.lang.String name)

Create a new GeoObject with the given name

Parameters:

name - the name of the GeoObject

GeoObject

public GeoObject(java.lang.String name,
         GeoFeatureType geoType)

Create a new GeoObject with the given name and type

Parameters:

name - the name of the GeoObject

geoType - the geographic type

Method Detail

addAltName

public void addAltName(java.lang.String altName)

Add an alternate name for this object

Parameters:

altName - the alternate name

compareTo

public int compareTo(GeoObject other)

Compare this geographic object to another geographic object. The comparator first compares types, selecting the larger type. If types are the same, this method then compares populations. If the populations are the same, this method then compares the names.

Specified by:

compareTo in interface java.lang.Comparable<GeoObject>

Parameters:

other - the other geographic object to compare

Returns:

an integer indicating whether the other object should be considered greater, less than, or equal to this object

getAltNames

public java.util.Set<java.lang.String> getAltNames()

Get the set of alternate names

Returns:

the set of alternate names

getCountry

public java.lang.String getCountry()

Get the country this object is included in. This method should return null if the object isn't included within a single country.

Returns:

the country this object is included in

getPopulation

public long getPopulation()

Get the population for this object

Returns:

the population

getType

public GeoFeatureType getType()

Get the geographic feature type for this object

Returns:

the feature type

setCountry

public void setCountry(java.lang.String cntryName)

Set the country name for this object. If the object is itself a country, this method should be called with the country name. If the object is not within a single country (e.g., the Pacific Ocean), then this should not be set, leaving the country name to be null.

Parameters:

cntryName - the country this object is contained in

setFeatureType

public void setFeatureType(GeoFeatureType featureType)

Set the geographic feature type

Parameters:

featureType - the feature type

setPopulation

public void setPopulation(long pop)

Set the population

Parameters:

pop - the population