systems.dmx.geomaps

Interface GeomapsService

Show UML class diagram

All Known Implementing Classes:

GeomapsPlugin

public interface GeomapsService

Method Summary

Modifier and Type	Method and Description
void	addCoordinateToGeomap(long geomapId, long geoCoordId) Adds a Geo Coordinate topic to a geomap.
GeoCoordinate	geoCoordinate(Topic geoCoordTopic) Returns the geo coordinate encoded in a Geo Coordinate topic.
double	getDistance(GeoCoordinate coord1, GeoCoordinate coord2) Calculates the distance between 2 geo coordinates in kilometer.
Topic	getDomainTopic(long geoCoordId) Finds the domain topic that corresponds to a Geo Coordinate topic.
GeoCoordinate	getGeoCoordinate(Topic geoTopic) Returns the geo coordinate of a geo-facetted topic (e.g.
Geomap	getGeomap(long geomapId)
<V> V	runWithoutGeocoding(Callable<V> callable) Executes the passed codeblock and suppresses geocoding for Address topics created/updated while execution.
void	setGeomapState(long geomapId, double lon, double lat, int zoom)

Method Detail

getGeomap

Geomap getGeomap(long geomapId)

getDomainTopic

Topic getDomainTopic(long geoCoordId)

Finds the domain topic that corresponds to a Geo Coordinate topic.

getGeoCoordinate

GeoCoordinate getGeoCoordinate(Topic geoTopic)

Returns the geo coordinate of a geo-facetted topic (e.g. an Address), or null if no geo coordinate is stored.

Returns:

the geo coordinate, or null.

geoCoordinate

GeoCoordinate geoCoordinate(Topic geoCoordTopic)

Returns the geo coordinate encoded in a Geo Coordinate topic.

addCoordinateToGeomap

void addCoordinateToGeomap(long geomapId,
                           long geoCoordId)

Adds a Geo Coordinate topic to a geomap.

setGeomapState

void setGeomapState(long geomapId,
                    double lon,
                    double lat,
                    int zoom)

getDistance

double getDistance(GeoCoordinate coord1,
                   GeoCoordinate coord2)

Calculates the distance between 2 geo coordinates in kilometer.

runWithoutGeocoding

<V> V runWithoutGeocoding(Callable<V> callable)
                   throws Exception

Executes the passed codeblock and suppresses geocoding for Address topics created/updated while execution.

Returns:

the value returned by the codeblock.

Throws:

Exception