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 inherited from class de.deepamehta.core.osgi.PluginActivator

bundle, dm4, mf

Fields inherited from interface de.kiezatlas.KiezatlasService

BEZIRKSREGION_FACET, GEO_COORDINATE_FACET, GEO_OBJECT, GEO_OBJECT_ADDRESS, GEO_OBJECT_NAME, IMAGE_FACET, IMAGE_PATH, KIEZATLAS_WORKSPACE_NAME, KIEZATLAS_WORKSPACE_SHARING_MODE, KIEZATLAS_WORKSPACE_URI, WEBSITE, WEBSITE_TITLE

Constructor Summary

Constructors

Constructor and Description
KiezatlasPlugin()

Method Summary

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.Association	addGeoObjectToWebsite(de.deepamehta.core.Topic geoObject, de.deepamehta.core.Topic website) Creates an assignment between a Kiezatlas Geo Object and the given Kiezatlas Website.
de.deepamehta.core.Topic	createKiezatlasWebsite(String siteName, String siteUri) Service method to create unique "Kiezatlas Website" topics.
de.deepamehta.core.Topic	createWebsite(String siteName, String siteUri) Useful to create a new or load an existing "Site" topic (by its uri).
de.deepamehta.core.Topic	enrichWithFacets(de.deepamehta.core.Topic geoObject, long websiteId) Utility to enrich the given Geo Object with the facets configured for the given Kiezatlas Website.
List<de.deepamehta.core.RelatedTopic>	getAggregatingGeoObjects(de.deepamehta.core.Topic bezirksFacet) Fetches the Geo Object for any of its aggregated childs.
List<de.deepamehta.core.Topic>	getAllCriteria() Returns all Kiezatlas criteria existing in the DB.
de.deepamehta.core.Topic	getDomainTopicByGeoCoordinate(de.deepamehta.core.Topic geoCoords) Fetches the domain topic a Geo Coordinate topic.
List<de.deepamehta.core.TopicType>	getFacetTopicTypes(long websiteId) Returns the facet type definitions assigned to the given Kiezatlas Website.
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) Fetches the "Geo Coordinate" facet related to the given Geo Object.
de.deepamehta.core.Topic	getGeoCoordinateFacet(de.deepamehta.core.Topic addressTopic) Fetches the geo coordinate topic for the given topic.
de.deepamehta.core.Topic	getGeoObjectByGeoCoordinate(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" (a special kind of "Topicmap").
List<de.deepamehta.core.RelatedTopic>	getGeoObjectsByCategory(long categoryId) Returns all "Geo Objects" associated (aggregated, parent) with the given category.
List<de.deepamehta.core.RelatedTopic>	getGeoObjectsBySite(long siteId) Returns all "Geo Objects" associated (parent) with the given Kiezatlas Website.
String	getKiezatlasWorkspaceMember()
long	getStandardWorkspaceId()
de.deepamehta.core.Topic	getWebsite(long geomapId) Returns the "Kiezatlas Website" topic the given geomap is assigned to.
boolean	isAssignedToKiezatlasWebsite(de.deepamehta.core.Topic geoObject, de.deepamehta.core.Topic website) Utility to check if the given Geo Object is assigned to the given Kiezatlas Website.
boolean	isKiezatlasWorkspaceMember() Utility method to check if the requesting user is a member of the "Kiezatlas" workspace.
boolean	isKiezatlasWorkspaceMember(de.deepamehta.core.Topic username) Utility method to check if the requesting user is a member of the "Kiezatlas" workspace.
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 ------------------------------------
void	removeGeoObjectFromWebsite(long geoObjectId, long siteId) Useful to create a standard association between a "Geo object" topic and a "Site" topic.
void	removeGeoObjectFromWebsite(de.deepamehta.core.Topic geoObject, de.deepamehta.core.Topic website) Removes an assignment between a Kiezatlas Geo Object and the given Kiezatlas Website.
GroupedGeoObjects	searchCategories(String searchTerm, long clock) Searches for categories (topics with typeUri="ka2.criteria.*" introduced via dm4-kiezatlas-etl) 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) Searches for Geo Objects whose name match the search term (case-insensitive substring search).
void	updateFacets(long geoObjectId, List<de.deepamehta.core.RelatedTopic> facetTypes, de.deepamehta.core.model.TopicModel newModel) Method to update the facet values configured for the given Kiezatlas Website on the Geo Object.

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

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).

Parameters:

siteName -

siteUri -

Returns:

A topic of type "ka2.website".

removeGeoObjectFromWebsite

public void removeGeoObjectFromWebsite(long geoObjectId,
                                       long siteId)

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

Parameters:

geoObjectId -

siteId -

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.

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

getFacetTopicTypes

public List<de.deepamehta.core.TopicType> getFacetTopicTypes(long websiteId)

Description copied from interface: KiezatlasService

Returns the facet type definitions assigned to the given Kiezatlas Website.

Specified by:

getFacetTopicTypes in interface KiezatlasService

getGeoObjectsBySite

public List<de.deepamehta.core.RelatedTopic> getGeoObjectsBySite(long siteId)

Description copied from interface: KiezatlasService

Returns all "Geo Objects" associated (parent) with the given Kiezatlas Website.

Specified by:

getGeoObjectsBySite 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" (a special kind of "Topicmap").

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" associated (aggregated, parent) with the given category.

Specified by:

getGeoObjectsByCategory in interface KiezatlasService

getKiezatlasWorkspaceMember

public String getKiezatlasWorkspaceMember()

getStandardWorkspaceId

public long getStandardWorkspaceId()

Specified by:

getStandardWorkspaceId in interface KiezatlasService

searchGeoObjectNames

public GeoObjects searchGeoObjectNames(String searchTerm,
                                       long clock)

Description copied from interface: KiezatlasService

Searches for Geo Objects whose name match the search term (case-insensitive substring search).

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 (topics with typeUri="ka2.criteria.*" introduced via dm4-kiezatlas-etl) 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.

createKiezatlasWebsite

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

Description copied from interface: KiezatlasService

Service method to create unique "Kiezatlas Website" topics.

Specified by:

createKiezatlasWebsite in interface KiezatlasService

Returns:

addGeoObjectToWebsite

public de.deepamehta.core.Association addGeoObjectToWebsite(de.deepamehta.core.Topic geoObject,
                                                            de.deepamehta.core.Topic website)

Description copied from interface: KiezatlasService

Creates an assignment between a Kiezatlas Geo Object and the given Kiezatlas Website.

Specified by:

addGeoObjectToWebsite in interface KiezatlasService

Returns:

removeGeoObjectFromWebsite

public void removeGeoObjectFromWebsite(de.deepamehta.core.Topic geoObject,
                                       de.deepamehta.core.Topic website)

Description copied from interface: KiezatlasService

Removes an assignment between a Kiezatlas Geo Object and the given Kiezatlas Website.

Specified by:

removeGeoObjectFromWebsite in interface KiezatlasService

getGeoCoordinateByGeoObject

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

Description copied from interface: KiezatlasService

Fetches the "Geo Coordinate" facet related to the given Geo Object.

Specified by:

getGeoCoordinateByGeoObject in interface KiezatlasService

getGeoObjectByGeoCoordinate

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

Description copied from interface: KiezatlasService

Fetches a Geo Object by a Geo Coordinate topic.

Specified by:

getGeoObjectByGeoCoordinate in interface KiezatlasService

getDomainTopicByGeoCoordinate

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

Description copied from interface: KiezatlasService

Fetches the domain topic a Geo Coordinate topic.

Specified by:

getDomainTopicByGeoCoordinate 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 for the given topic.

Specified by:

getGeoCoordinateFacet in interface KiezatlasService

Returns:

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

getAggregatingGeoObjects

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

Description copied from interface: KiezatlasService

Fetches the Geo Object for any of its aggregated childs.

Specified by:

getAggregatingGeoObjects in interface KiezatlasService

isAssignedToKiezatlasWebsite

public boolean isAssignedToKiezatlasWebsite(de.deepamehta.core.Topic geoObject,
                                            de.deepamehta.core.Topic website)

Description copied from interface: KiezatlasService

Utility to check if the given Geo Object is assigned to the given Kiezatlas Website.

Specified by:

isAssignedToKiezatlasWebsite in interface KiezatlasService

Returns:

isKiezatlasWorkspaceMember

public boolean isKiezatlasWorkspaceMember()

Description copied from interface: KiezatlasService

Utility method to check if the requesting user is a member of the "Kiezatlas" workspace.

Specified by:

isKiezatlasWorkspaceMember in interface KiezatlasService

Returns:

boolean True if username is a member of the Kiezatlas "Standard" Workspace.

isKiezatlasWorkspaceMember

public boolean isKiezatlasWorkspaceMember(de.deepamehta.core.Topic username)

Description copied from interface: KiezatlasService

Utility method to check if the requesting user is a member of the "Kiezatlas" workspace.

Specified by:

isKiezatlasWorkspaceMember in interface KiezatlasService

Returns:

boolean True if username is a member of the Kiezatlas "Standard" Workspace.

enrichWithFacets

public de.deepamehta.core.Topic enrichWithFacets(de.deepamehta.core.Topic geoObject,
                                                 long websiteId)

Description copied from interface: KiezatlasService

Utility to enrich the given Geo Object with the facets configured for the given Kiezatlas Website.

Specified by:

enrichWithFacets in interface KiezatlasService

Returns:

updateFacets

public void updateFacets(long geoObjectId,
                         List<de.deepamehta.core.RelatedTopic> facetTypes,
                         de.deepamehta.core.model.TopicModel newModel)

Description copied from interface: KiezatlasService

Method to update the facet values configured for the given Kiezatlas Website on the Geo Object. Note: Values for all facets **must* be provided.

Specified by:

updateFacets 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