de.kiezatlas

Class KiezatlasPlugin

java.lang.Object

de.deepamehta.core.osgi.PluginActivator

de.kiezatlas.KiezatlasPlugin

All Implemented Interfaces:

de.deepamehta.core.osgi.PluginContext, de.deepamehta.core.service.event.PostUpdateTopicListener, de.deepamehta.core.service.event.PreSendTopicListener, de.deepamehta.core.service.EventListener, KiezatlasService, org.osgi.framework.BundleActivator

public class KiezatlasPlugin
extends de.deepamehta.core.osgi.PluginActivator
implements KiezatlasService, de.deepamehta.core.service.event.PostUpdateTopicListener, de.deepamehta.core.service.event.PreSendTopicListener

Kiezatlas 2 Plugin Service Implementation.

Author:

jri & mukil

Field Summary

Fields

Modifier and Type	Field and Description
static String	GEO_OBJECT_KEYWORD_PROPERTY
static String	GEO_OBJECT_OWNER_PROPERTY
static String	KA2_GEO_OBJECT_URI_PREFIX

Fields inherited from class de.deepamehta.core.osgi.PluginActivator

bundle, dm4, mf

Fields inherited from interface de.kiezatlas.KiezatlasService

GEO_OBJECT, GEO_OBJECT_ADDRESS, GEO_OBJECT_NAME, KIEZATLAS_WORKSPACE_NAME, KIEZATLAS_WORKSPACE_SHARING_MODE, KIEZATLAS_WORKSPACE_URI, WEBSITE, WEBSITE_TITLE

Constructor Summary

Constructors

Constructor and Description
KiezatlasPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
de.deepamehta.core.Association	addGeoObjectToWebsite(long geoObjectId, long siteId) Useful to create a standard association between a "Geo object" topic and a "Site" topic.
de.deepamehta.core.Topic	createWebsite(String siteName, String siteUri) Useful to create a new or load an existing "Site" topic (by its uri).
List<de.deepamehta.core.Topic>	getAllCriteria() Returns all Kiezatlas criteria existing in the DB.
de.deepamehta.core.Topic	getFacettedBezirksregionChildTopic(de.deepamehta.core.Topic facettedTopic) This facet depends/just exists after installation of the dm4-kiezatlas-etl plugin.
List<de.deepamehta.core.RelatedTopic>	getFacetTypes(long websiteId) Returns the facet types assigned to the given Kiezatlas Website.
de.deepamehta.geomaps.model.GeoCoordinate	getGeoCoordinateByGeoObject(de.deepamehta.core.Topic geoObject) -------------------------------------- Kiezatlas Geo Object Helper Methods -----------------------------
de.deepamehta.core.Topic	getGeoCoordinateFacet(de.deepamehta.core.Topic addressTopic) Fetches the Geo Coordinate topic related to a Geo Objects Address (!) topic.
de.deepamehta.core.Topic	getGeoObjectByGeoCoordinateTopic(de.deepamehta.core.Topic geoCoords) Fetches a Geo Object by a Geo Coordinate topic.
List<de.deepamehta.core.Topic>	getGeoObjects(long geomapId) Returns all Geo Objects assigned to the given geomap.
List<de.deepamehta.core.RelatedTopic>	getGeoObjectsByCategory(long categoryId) Returns all Geo Objects assigned to the given category.
de.deepamehta.core.Topic	getImageFileFacetByGeoObject(de.deepamehta.core.Topic geoObject) Note: This facet depends on the installation of the dm4-kiezatlas-etl plugin.
List<de.deepamehta.core.RelatedTopic>	getParentRelatedAggregatedGeoObjects(de.deepamehta.core.Topic bezirksFacet)
de.deepamehta.core.Topic	getWebsite(long geomapId) Returns the "Kiezatlas Website" topic the given geomap is assigned to.
void	postUpdateTopic(de.deepamehta.core.Topic topic, de.deepamehta.core.model.TopicModel newModel, de.deepamehta.core.model.TopicModel oldModel)
void	preSendTopic(de.deepamehta.core.Topic topic) ------------------------------------------ Listener Implementations ------------------------------------
GroupedGeoObjects	searchCategories(String searchTerm, long clock) Searches for categories that match the search term (case-insensitive substring search) and returns all Geo Objects of those categories, grouped by category.
GeoObjects	searchGeoObjectNames(String searchTerm, long clock) Used by famportal editorial tool.
void	updateImageFileFacet(de.deepamehta.core.Topic geoObject, String imageFilePath) Note: This facet depends on the installation of the dm4-kiezatlas-etl plugin.

Methods inherited from class de.deepamehta.core.osgi.PluginActivator

getBundleContext, getPluginName, getStaticResource, getUri, init, 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

KA2_GEO_OBJECT_URI_PREFIX

public static final String KA2_GEO_OBJECT_URI_PREFIX

See Also:

Constant Field Values

GEO_OBJECT_OWNER_PROPERTY

public static final String GEO_OBJECT_OWNER_PROPERTY

See Also:

Constant Field Values

GEO_OBJECT_KEYWORD_PROPERTY

public static final String GEO_OBJECT_KEYWORD_PROPERTY

See Also:

Constant Field Values

Constructor Detail

KiezatlasPlugin

public KiezatlasPlugin()

Method Detail

createWebsite

public de.deepamehta.core.Topic createWebsite(String siteName,
                                     String siteUri)

Useful to create a new or load an existing "Site" topic (by its uri).

Specified by:

createWebsite in interface KiezatlasService

Parameters:

siteName -

siteUri -

Returns:

A topic of type "ka2.website".

addGeoObjectToWebsite

public de.deepamehta.core.Association addGeoObjectToWebsite(long geoObjectId,
                                                   long siteId)

Useful to create a standard association between a "Geo object" topic and a "Site" topic.

Specified by:

addGeoObjectToWebsite in interface KiezatlasService

Parameters:

geoObjectId -

siteId -

Returns:

Association representing the relation between a Geo Object and a Site.

getWebsite

public de.deepamehta.core.Topic getWebsite(long geomapId)

Description copied from interface: KiezatlasService

Returns the "Kiezatlas Website" topic the given geomap is assigned to.

Specified by:

getWebsite in interface KiezatlasService

getFacetTypes

public List<de.deepamehta.core.RelatedTopic> getFacetTypes(long websiteId)

Description copied from interface: KiezatlasService

Returns the facet types assigned to the given Kiezatlas Website.

Specified by:

getFacetTypes in interface KiezatlasService

getAllCriteria

public List<de.deepamehta.core.Topic> getAllCriteria()

Description copied from interface: KiezatlasService

Returns all Kiezatlas criteria existing in the DB. ### Experimental A Kiezatlas criteria is a topic type whose URI starts with ka2.criteria. but does not end with .facet.

Specified by:

getAllCriteria in interface KiezatlasService

getGeoObjects

public List<de.deepamehta.core.Topic> getGeoObjects(long geomapId)

Description copied from interface: KiezatlasService

Returns all Geo Objects assigned to the given geomap.

Specified by:

getGeoObjects in interface KiezatlasService

getGeoObjectsByCategory

public List<de.deepamehta.core.RelatedTopic> getGeoObjectsByCategory(long categoryId)

Description copied from interface: KiezatlasService

Returns all Geo Objects assigned to the given category.

Specified by:

getGeoObjectsByCategory in interface KiezatlasService

searchGeoObjectNames

public GeoObjects searchGeoObjectNames(String searchTerm,
                              long clock)

Used by famportal editorial tool.

Specified by:

searchGeoObjectNames in interface KiezatlasService

clock - The logical clock value send back to the client (contained in GeoObjects). Allows the client to order asynchronous responses.

searchCategories

public GroupedGeoObjects searchCategories(String searchTerm,
                                 long clock)

Description copied from interface: KiezatlasService

Searches for categories that match the search term (case-insensitive substring search) and returns all Geo Objects of those categories, grouped by category.

Specified by:

searchCategories in interface KiezatlasService

clock - The logical clock value send back to the client (contained in GroupedGeoObjects). Allows the client to order asynchronous responses.

getImageFileFacetByGeoObject

public de.deepamehta.core.Topic getImageFileFacetByGeoObject(de.deepamehta.core.Topic geoObject)

Note: This facet depends on the installation of the dm4-kiezatlas-etl plugin.

Specified by:

getImageFileFacetByGeoObject in interface KiezatlasService

updateImageFileFacet

public void updateImageFileFacet(de.deepamehta.core.Topic geoObject,
                        String imageFilePath)

Note: This facet depends on the installation of the dm4-kiezatlas-etl plugin.

Specified by:

updateImageFileFacet in interface KiezatlasService

getFacettedBezirksregionChildTopic

public de.deepamehta.core.Topic getFacettedBezirksregionChildTopic(de.deepamehta.core.Topic facettedTopic)

This facet depends/just exists after installation of the dm4-kiezatlas-etl plugin.

Specified by:

getFacettedBezirksregionChildTopic in interface KiezatlasService

getGeoCoordinateByGeoObject

public de.deepamehta.geomaps.model.GeoCoordinate getGeoCoordinateByGeoObject(de.deepamehta.core.Topic geoObject)

-------------------------------------- Kiezatlas Geo Object Helper Methods -----------------------------

Specified by:

getGeoCoordinateByGeoObject in interface KiezatlasService

getGeoObjectByGeoCoordinateTopic

public de.deepamehta.core.Topic getGeoObjectByGeoCoordinateTopic(de.deepamehta.core.Topic geoCoords)

Description copied from interface: KiezatlasService

Fetches a Geo Object by a Geo Coordinate topic.

Specified by:

getGeoObjectByGeoCoordinateTopic in interface KiezatlasService

getGeoCoordinateFacet

public de.deepamehta.core.Topic getGeoCoordinateFacet(de.deepamehta.core.Topic addressTopic)

Description copied from interface: KiezatlasService

Fetches the Geo Coordinate topic related to a Geo Objects Address (!) topic.

Specified by:

getGeoCoordinateFacet in interface KiezatlasService

getParentRelatedAggregatedGeoObjects

public List<de.deepamehta.core.RelatedTopic> getParentRelatedAggregatedGeoObjects(de.deepamehta.core.Topic bezirksFacet)

Specified by:

getParentRelatedAggregatedGeoObjects in interface KiezatlasService

preSendTopic

public void preSendTopic(de.deepamehta.core.Topic topic)

------------------------------------------ Listener Implementations ------------------------------------

Specified by:

preSendTopic in interface de.deepamehta.core.service.event.PreSendTopicListener

postUpdateTopic

public void postUpdateTopic(de.deepamehta.core.Topic topic,
                   de.deepamehta.core.model.TopicModel newModel,
                   de.deepamehta.core.model.TopicModel oldModel)

Specified by:

postUpdateTopic in interface de.deepamehta.core.service.event.PostUpdateTopicListener