com.bericotech.clavin.gazetteer
Class GeoName

java.lang.Object
  com.bericotech.clavin.gazetteer.GeoName

public class GeoName
extends Object

Data-rich representation of a named location, based on entries in the GeoNames gazetteer. TODO: link administrative subdivision code fields to the GeoName records they reference

Field Summary

String	admin1Code
String	admin2Code
String	admin3Code
String	admin4Code
List<CountryCode>	alternateCountryCodes
List<String>	alternateNames
String	asciiName
int	digitalElevationModel
int	elevation
FeatureClass	featureClass
FeatureCode	featureCode
int	geonameID
double	latitude
double	longitude
Date	modificationDate
String	name
static int	OUT_OF_BOUNDS
long	population
CountryCode	primaryCountryCode
TimeZone	timezone

Constructor Summary

GeoName(int geonameID, String name, String asciiName, List<String> alternateNames, Double latitude, Double longitude, FeatureClass featureClass, FeatureCode featureCode, CountryCode primaryCountryCode, List<CountryCode> alternateCountryCodes, String admin1Code, String admin2Code, String admin3Code, String admin4Code, Long population, Integer elevation, Integer digitalElevationModel, TimeZone timezone, Date modificationDate)
Sole constructor for GeoName class.

Method Summary

String	getPrimaryCountryName()
static GeoName	parseFromGeoNamesRecord(String inputLine) Builds a GeoName object based on a single gazetteer record in the GeoNames geographical database.
String	toString() For pretty-printing.

Methods inherited from class java.lang.Object

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

Field Detail

geonameID

public final int geonameID

name

public final String name

asciiName

public final String asciiName

alternateNames

public final List<String> alternateNames

latitude

public final double latitude

longitude

public final double longitude

featureClass

public final FeatureClass featureClass

featureCode

public final FeatureCode featureCode

primaryCountryCode

public final CountryCode primaryCountryCode

alternateCountryCodes

public final List<CountryCode> alternateCountryCodes

admin1Code

public final String admin1Code

admin2Code

public final String admin2Code

admin3Code

public final String admin3Code

admin4Code

public final String admin4Code

population

public final long population

elevation

public final int elevation

digitalElevationModel

public final int digitalElevationModel

timezone

public final TimeZone timezone

modificationDate

public final Date modificationDate

OUT_OF_BOUNDS

public static final int OUT_OF_BOUNDS

See Also:

Constant Field Values

Constructor Detail

GeoName

public GeoName(int geonameID,
               String name,
               String asciiName,
               List<String> alternateNames,
               Double latitude,
               Double longitude,
               FeatureClass featureClass,
               FeatureCode featureCode,
               CountryCode primaryCountryCode,
               List<CountryCode> alternateCountryCodes,
               String admin1Code,
               String admin2Code,
               String admin3Code,
               String admin4Code,
               Long population,
               Integer elevation,
               Integer digitalElevationModel,
               TimeZone timezone,
               Date modificationDate)

Sole constructor for GeoName class. Encapsulates a gazetteer record from the GeoNames database.

Parameters:

geonameID - unique identifier

name - name of this location

asciiName - plain text version of name

alternateNames - list of alternate names, if any

latitude - lat coord

longitude - lon coord

featureClass - general type of feature (e.g., "Populated place")

featureCode - specific type of feature (e.g., "capital of a political entity")

primaryCountryCode - ISO country code

alternateCountryCodes - list of alternate country codes, if any (i.e., disputed territories)

admin1Code - FIPS code for first-level administrative subdivision (e.g., state or province)

admin2Code - second-level administrative subdivision (e.g., county)

admin3Code - third-level administrative subdivision

admin4Code - fourth-level administrative subdivision

population - number of inhabitants

elevation - elevation in meters

digitalElevationModel - another way to measure elevation

timezone - timezone for this location

modificationDate - date of last modification for the GeoNames record

Method Detail

getPrimaryCountryName

public String getPrimaryCountryName()

parseFromGeoNamesRecord

public static GeoName parseFromGeoNamesRecord(String inputLine)

Builds a GeoName object based on a single gazetteer record in the GeoNames geographical database.

Parameters:

inputLine - single line of tab-delimited text representing one record from the GeoNames gazetteer

Returns:

new GeoName object

toString

public String toString()

For pretty-printing.

Overrides:

toString in class Object