com.languagecomputer.api.text
Interface SpatialSpan

All Superinterfaces:

Text

All Known Implementing Classes:

DefaultSpatialSpan

public interface SpatialSpan
extends Text

Representation of a gazetteer object found in text. SpatialSpans are often associated with location Entity objects, but systems should not depend on that.

Since:

1.0

Author:

Kirk Roberts

Field Summary

static AnnotationType<SpatialSpan>

TYPE

Method Summary

Double	getLatitude() Returns the latitude of the geographic object (optional).
Double	getLongitude() Returns the longitude of the geographic object (optional).
List<String>	getParents() Returns the list of geographic objects that contain this one in increasing order (optional).
Integer	getPopulation() Returns the human population of the geographic object (optional).

Methods inherited from interface com.languagecomputer.api.text.Text

getAnnotationType, getCongruentAnnotations, getDocument, getDocumentID, getEndCharOffset, getIntersectingAnnotations, getRawString, getStartCharOffset, getSubAnnotations, getSuperAnnotations

Field Detail

TYPE

static final AnnotationType<SpatialSpan> TYPE

Method Detail

getLatitude

Double getLatitude()

Returns the latitude of the geographic object (optional). Implementors that choose not to provide the latitude should return null.

Returns:

The latitude, or null if this functionality isn't implemented.

getLongitude

Double getLongitude()

Returns the longitude of the geographic object (optional). Implementors that choose not to provide the longitude should return null.

Returns:

The longitude, or null if this functionality isn't implemented.

getParents

List<String> getParents()

Returns the list of geographic objects that contain this one in increasing order (optional). For example, if a SpatialSpan covers the text Dallas, then the parents could be Texas, United States, North America, and Earth. Implementors that choose not to provide the geographic parents should return null.

Returns:

A List of the geographic parents of this SpatialSpan, or null if this functionality isn't implemented.

getPopulation

Integer getPopulation()

Returns the human population of the geographic object (optional). Implementors that choose not to provide the population should return null.

Returns:

The population, or null if this functionality isn't implemented.