IGeographicLocation Interface Reference

Inheritance diagram for IGeographicLocation:
Collaboration diagram for IGeographicLocation:

List of all members.

Public Types

enum  Unit { KILOMETERS = (6367), METERS = (6367000), MILES = (3956) }

Public Methods

int getElevation ()
double getLongitude ()
double getLatitude ()
double getDistanceTo (IGeographicLocation other, Unit unit)
double getDistanceTo (IGeographicLocation other)
String getName ()
String getCategory ()
void setId (long id)
long calcTypeId ()
String getLabel ()

Package Functions

long getId ()

Member Enumeration Documentation

enum Unit
Enumerator:
KILOMETERS 
METERS 
MILES 

Method Details

String getCategory ( ) [inherited]

Returns the category-string of this category. Note that this value is not further restricted, and different implementations might return different strings.

Returns:
the category string

Implemented in SingleValueCategory, TemporalExpression, SimplePartOfSpeech, NamedEntity, OrganizationName, PersonName, UnspecifiedNamedEntity, GeographicLocation, Location, Mountain, PopulatedPlace, Waters, SequencerReplacement, and SimpleReplacement.

double getDistanceTo ( IGeographicLocation  other)

Calculates the Great-circle distance between this location and other in kilometers.

Parameters:
other
unit
Returns:

Implemented in GeographicLocation.

double getDistanceTo ( IGeographicLocation  other,
Unit  unit 
)

Calculates the Great-circle distance between this location and other, with the defined unit.

Parameters:
other
unit
Returns:

Implemented in GeographicLocation.

int getElevation ( )

Returns the elevation of the location in meters.

Returns:

Implemented in GeographicLocation.

long getId ( ) [package, inherited]
String getLabel ( ) [inherited]

Returns the label of this token, which can be any kind of string (except null), mainly used for display-reasons only. Note: Components MUST NOT assume that any kind of label (like 'word' or else) is returned by this method.

Implemented in LabeledAnnotation, TerminalNode< T >, TEIDramaSpeaker, TEIDramaSpeechAct, TEIDramaStage, JodaDateTime, JodaInterval, JodaPeriod, Timex, Tweet, and TwitterEntity.

double getLatitude ( )

Returns the latitude of the location in decimal degrees, as defined in Wikipedia:Latitude, and according to WGS 84

Returns:

Implemented in GeographicLocation.

double getLongitude ( )

Returns the longitude of the location in decimal degrees, as defined in Wikipedia:Longitude, and according to WGS 84.

Returns:

Implemented in GeographicLocation.

String getName ( ) [inherited]