systems.dmx.geomaps

Class GeomapsPlugin

Show UML class diagram

java.lang.Object

systems.dmx.core.osgi.PluginActivator

systems.dmx.geomaps.GeomapsPlugin

All Implemented Interfaces:

org.osgi.framework.BundleActivator, PluginContext, PostCreateTopicListener, PostUpdateTopicListener, PreSendTopicListener, EventListener, GeomapsService

public class GeomapsPlugin
extends PluginActivator
implements GeomapsService, PostCreateTopicListener, PostUpdateTopicListener, PreSendTopicListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	GeomapsPlugin.Address

Field Summary

Fields

Modifier and Type	Field and Description
private ContextTracker	contextTracker
private static String	COOKIE_NO_GEOCODING
private static double	EARTH_RADIUS_KM
private FacetsService	facetsService
private static String	GEOCODER_URL
private Logger	logger
private TopicmapsService	topicmapsService

Fields inherited from class systems.dmx.core.osgi.PluginActivator

bundle, dmx, mf

Constructor Summary

Constructors

Constructor and Description
GeomapsPlugin()

Method Summary

Modifier and Type	Method and Description
private boolean	abortGeocoding(Topic address)
private boolean	abortGeocodingByCookie(Topic address)
private boolean	abortGeocodingByExcecutionContext(Topic address)
void	addCoordinateToGeomap(long geomapId, long geoCoordId) Adds a Geo Coordinate topic to a geomap.
private void	geocodeAndStoreFacet(GeomapsPlugin.Address address, Topic topic) Geocodes the given address and stores the resulting coordinate as a facet value of the given Address topic.
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.
private Topic	getGeoCoordinateTopic(Topic geoTopic) Returns the Geo Coordinate topic (including its child topics) of a geo-facetted topic (e.g.
Geomap	getGeomap(long geomapId)
void	init()
void	postCreateTopic(Topic topic)
void	postUpdateTopic(Topic topic, TopicModel updateModel, TopicModel oldTopic)
void	preSendTopic(Topic topic) Enriches an Address topic with its geo coordinate.
<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)
private void	storeGeoCoordinate(Topic address, GeoCoordinate geoCoord) Stores a geo coordinate for an address topic in the DB.

Methods inherited from class systems.dmx.core.osgi.PluginActivator

getBundleContext, getPluginName, getStaticResource, getUri, preInstall, publishFileSystem, serviceArrived, serviceGone, setCoreService, shutdown, start, stop, toString

Methods inherited from class java.lang.Object

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

Field Detail

GEOCODER_URL

private static final String GEOCODER_URL

See Also:

Constant Field Values

COOKIE_NO_GEOCODING

private static final String COOKIE_NO_GEOCODING

See Also:

Constant Field Values

EARTH_RADIUS_KM

private static final double EARTH_RADIUS_KM

See Also:

Constant Field Values

topicmapsService

private TopicmapsService topicmapsService

facetsService

private FacetsService facetsService

contextTracker

private ContextTracker contextTracker

logger

private Logger logger

Constructor Detail

GeomapsPlugin

public GeomapsPlugin()

Method Detail

getGeomap

public Geomap getGeomap(long geomapId)

Specified by:

getGeomap in interface GeomapsService

getDomainTopic

public Topic getDomainTopic(long geoCoordId)

Description copied from interface: GeomapsService

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

Specified by:

getDomainTopic in interface GeomapsService

getGeoCoordinate

public GeoCoordinate getGeoCoordinate(Topic geoTopic)

Description copied from interface: GeomapsService

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

Specified by:

getGeoCoordinate in interface GeomapsService

Returns:

the geo coordinate, or null.

geoCoordinate

public GeoCoordinate geoCoordinate(Topic geoCoordTopic)

Description copied from interface: GeomapsService

Returns the geo coordinate encoded in a Geo Coordinate topic.

Specified by:

geoCoordinate in interface GeomapsService

addCoordinateToGeomap

public void addCoordinateToGeomap(long geomapId,
                                  long geoCoordId)

Description copied from interface: GeomapsService

Adds a Geo Coordinate topic to a geomap.

Specified by:

addCoordinateToGeomap in interface GeomapsService

setGeomapState

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

Specified by:

setGeomapState in interface GeomapsService

getDistance

public double getDistance(GeoCoordinate coord1,
                          GeoCoordinate coord2)

Description copied from interface: GeomapsService

Calculates the distance between 2 geo coordinates in kilometer.

Specified by:

getDistance in interface GeomapsService

runWithoutGeocoding

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

Description copied from interface: GeomapsService

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

Specified by:

runWithoutGeocoding in interface GeomapsService

Returns:

the value returned by the codeblock.

Throws:

Exception

init

public void init()

Specified by:

init in interface PluginContext

Overrides:

init in class PluginActivator

postCreateTopic

public void postCreateTopic(Topic topic)

Specified by:

postCreateTopic in interface PostCreateTopicListener

postUpdateTopic

public void postUpdateTopic(Topic topic,
                            TopicModel updateModel,
                            TopicModel oldTopic)

Specified by:

postUpdateTopic in interface PostUpdateTopicListener

preSendTopic

public void preSendTopic(Topic topic)

Enriches an Address topic with its geo coordinate.

Specified by:

preSendTopic in interface PreSendTopicListener

getGeoCoordinateTopic

private Topic getGeoCoordinateTopic(Topic geoTopic)

Returns the Geo Coordinate topic (including its child topics) of a geo-facetted topic (e.g. an Address), or null if no geo coordinate is stored.

geocodeAndStoreFacet

private void geocodeAndStoreFacet(GeomapsPlugin.Address address,
                                  Topic topic)

Geocodes the given address and stores the resulting coordinate as a facet value of the given Address topic. If geocoding (or storing the coordinate) fails a warning is logged; no exception is thrown.

Parameters:

topic - the Address topic to be facetted.

storeGeoCoordinate

private void storeGeoCoordinate(Topic address,
                                GeoCoordinate geoCoord)

Stores a geo coordinate for an address topic in the DB.

abortGeocoding

private boolean abortGeocoding(Topic address)

abortGeocodingByCookie

private boolean abortGeocodingByCookie(Topic address)

abortGeocodingByExcecutionContext

private boolean abortGeocodingByExcecutionContext(Topic address)