de.kiezatlas.service
Interface KiezatlasService

Show UML class diagram

All Superinterfaces:

PluginService

All Known Implementing Classes:

KiezatlasPlugin

public interface KiezatlasService
extends PluginService

Method Summary

List<Topic>	getAllCriteria() Returns all Kiezatlas criteria existing in the DB.
ResultList<RelatedTopic>	getFacetTypes(long websiteId) Returns the facet types assigned to the given Kiezatlas Website.
List<Topic>	getGeoObjects(long geomapId) Returns all Geo Objects assigned to the given geomap.
List<RelatedTopic>	getGeoObjectsByCategory(long categoryId) Returns all Geo Objects assigned to the given category.
Topic	getWebsite(long geomapId) Returns the "Kiezatlas Website" topic the given geomap is assigned to.
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	searchGeoObjects(String searchTerm, long clock) Searches for Geo Objects whose name match the search term (case-insensitive substring search).

Method Detail

getWebsite

Topic getWebsite(long geomapId)

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

getFacetTypes

ResultList<RelatedTopic> getFacetTypes(long websiteId)

Returns the facet types assigned to the given Kiezatlas Website.

getAllCriteria

List<Topic> getAllCriteria()

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.

getGeoObjects

List<Topic> getGeoObjects(long geomapId)

Returns all Geo Objects assigned to the given geomap.

getGeoObjectsByCategory

List<RelatedTopic> getGeoObjectsByCategory(long categoryId)

Returns all Geo Objects assigned to the given category.

searchGeoObjects

GeoObjects searchGeoObjects(String searchTerm,
                            long clock)

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

Parameters:

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

searchCategories

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.

Parameters:

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