KiezatlasService (DeepaMehta 4 Kiezatlas 2.1.8-SNAPSHOT API)

All Known Implementing Classes:

KiezatlasPlugin
```
public interface KiezatlasService
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`GEO_OBJECT`
`static String`	`GEO_OBJECT_ADDRESS`
`static String`	`GEO_OBJECT_NAME`
`static String`	`KIEZATLAS_WORKSPACE_NAME`
`static SharingMode`	`KIEZATLAS_WORKSPACE_SHARING_MODE`
`static String`	`KIEZATLAS_WORKSPACE_URI`
`static String`	`WEBSITE`

Method Summary

Methods
Modifier and Type	Method and Description
`Association`	`addGeoObjectToWebsite(long geoObjectId, long siteId)`
`Topic`	`createWebsite(String siteName, String siteUri)`
`List<Topic>`	`getAllCriteria()` Returns all Kiezatlas criteria existing in the DB.
`Topic`	`getFacettedBezirksregionChildTopic(Topic facettedTopic)`
`ResultList<RelatedTopic>`	`getFacetTypes(long websiteId)` Returns the facet types assigned to the given Kiezatlas Website.
`GeoCoordinate`	`getGeoCoordinateByGeoObject(Topic geoObject)` Fetches Geo Coordinate facet related to a Geo Objects Address (!) topic.
`String`	`getGeoObjectAttribution(Topic geoObject)`
`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`	`getImageFileFacetByGeoObject(Topic facettedTopic)`
`ResultList<RelatedTopic>`	`getParentRelatedAggregatedGeoObjects(Topic bezirksFacet)`
`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`	`searchGeoObjectNames(String searchTerm, long clock)` Searches for Geo Objects whose name match the search term (case-insensitive substring search).
`void`	`updateImageFileFacet(Topic geoObject, String imageFilePath)`

- Field Detail
  - KIEZATLAS_WORKSPACE_NAME
```
static final String KIEZATLAS_WORKSPACE_NAME
```
    See Also:
    Constant Field Values
  - KIEZATLAS_WORKSPACE_URI
```
static final String KIEZATLAS_WORKSPACE_URI
```
    See Also:
    Constant Field Values
  - KIEZATLAS_WORKSPACE_SHARING_MODE
```
static final SharingMode KIEZATLAS_WORKSPACE_SHARING_MODE
```
  - WEBSITE
```
static final String WEBSITE
```
    See Also:
    Constant Field Values
  - GEO_OBJECT
```
static final String GEO_OBJECT
```
    See Also:
    Constant Field Values
  - GEO_OBJECT_NAME
```
static final String GEO_OBJECT_NAME
```
    See Also:
    Constant Field Values
  - GEO_OBJECT_ADDRESS
```
static final String GEO_OBJECT_ADDRESS
```
    See Also:
    Constant Field Values
- 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.
  - searchGeoObjectNames
```
GeoObjects searchGeoObjectNames(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.
  - createWebsite
```
Topic createWebsite(String siteName,
                  String siteUri)
```
  - addGeoObjectToWebsite
```
Association addGeoObjectToWebsite(long geoObjectId,
                                long siteId)
```
  - getGeoCoordinateByGeoObject
```
GeoCoordinate getGeoCoordinateByGeoObject(Topic geoObject)
```
    Fetches Geo Coordinate facet related to a Geo Objects Address (!) topic.
  - getParentRelatedAggregatedGeoObjects
```
ResultList<RelatedTopic> getParentRelatedAggregatedGeoObjects(Topic bezirksFacet)
```
  - getImageFileFacetByGeoObject
```
Topic getImageFileFacetByGeoObject(Topic facettedTopic)
```
  - updateImageFileFacet
```
void updateImageFileFacet(Topic geoObject,
                        String imageFilePath)
```
  - getFacettedBezirksregionChildTopic
```
Topic getFacettedBezirksregionChildTopic(Topic facettedTopic)
```
  - getGeoObjectAttribution
```
String getGeoObjectAttribution(Topic geoObject)
```

Interface KiezatlasService

Field Summary

Method Summary

Field Detail

KIEZATLAS_WORKSPACE_NAME

KIEZATLAS_WORKSPACE_URI

KIEZATLAS_WORKSPACE_SHARING_MODE

WEBSITE

GEO_OBJECT

GEO_OBJECT_NAME

GEO_OBJECT_ADDRESS

Method Detail

getWebsite

getFacetTypes

getAllCriteria

getGeoObjects

getGeoObjectsByCategory

searchGeoObjectNames

searchCategories

createWebsite

addGeoObjectToWebsite

getGeoCoordinateByGeoObject

getParentRelatedAggregatedGeoObjects

getImageFileFacetByGeoObject

updateImageFileFacet

getFacettedBezirksregionChildTopic

getGeoObjectAttribution