de.kiezatlas

Class KiezatlasPlugin

Show UML class diagram

java.lang.Object

de.deepamehta.core.osgi.PluginActivator

de.kiezatlas.KiezatlasPlugin

All Implemented Interfaces:

PluginContext, PostUpdateTopicListener, PreSendTopicListener, EventListener, KiezatlasService, org.osgi.framework.BundleActivator

public class KiezatlasPlugin
extends PluginActivator
implements KiezatlasService, PostUpdateTopicListener, PreSendTopicListener

Kiezatlas 2 Plugin Service Implementation.

Author:

jri & mukil

Field Summary

Fields

Modifier and Type	Field and Description
private AccessControlService	accessControlService
private FacetsService	facetsService
private static String	GEO_OBJECT_KEYWORD_PROPERTY
private static String	GEO_OBJECT_OWNER_PROPERTY
private GeomapsService	geomapsService
private static String	KA2_GEO_OBJECT_URI_PREFIX
private Logger	logger
private static String	ROLE_TYPE_FACET_TYPE
private static String	ROLE_TYPE_GEOMAP
private static String	ROLE_TYPE_WEBSITE
private TimeService	timeService
private static String	WEBSITE_FACET_TYPES
private static String	WEBSITE_GEOMAP
private WorkspacesService	workspaceService

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

bundle, dms

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

Constructor Summary

Constructors

Constructor and Description
KiezatlasPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
Association	addGeoObjectToWebsite(long geoObjectId, long siteId)
javax.ws.rs.core.Response	createGeoObjectAttribution(long id, String owner, String key)
Topic	createWebsite(String siteName, String siteUri)
private void	enrichWithFacets(Topic geoObject, ResultList<RelatedTopic> facetTypes)
private void	enrichWithMultiFacet(Topic geoObject, String facetTypeUri)
private void	enrichWithSingleFacet(Topic geoObject, String facetTypeUri)
private List<Topic>	fetchGeoObjects(long geomapId)
List<Topic>	getAllCriteria() Returns all Kiezatlas criteria existing in the DB.
private AssociationDefinition	getAssocDef(String facetTypeUri)
private String	getChildTypeUri(String facetTypeUri)
private Topic	getFacettedBezirkChildTopic(Topic facettedTopic)
Topic	getFacettedBezirksregionChildTopic(Topic facettedTopic) This facet depends/just exists after installation of the dm4-kiezatlas-etl plugin.
private Topic	getFacettedContactChildTopic(Topic facettedTopic)
private ResultList<RelatedTopic>	getFacetTypes() Returns the facet types for the current topicmap, or null if the facet types can't be determined.
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.
private Topic	getGeoObject(Topic geoObjectName)
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 geoObject) This facet depends/just exists after installation of the dm4-kiezatlas-etl plugin.
List<SocialInstitutionObject>	getInstitutionsMissingBacklink()
List<SocialInstitutionObject>	getInstitutionsMissingBezirk()
InputStream	getKiezatlasAdministrationPage() Fetches a simple page rendering objects for kiez-administrators.
ResultList<RelatedTopic>	getParentRelatedAggregatedGeoObjects(Topic bezirksFacet)
List<SocialInstitutionObject>	getSiteInstitutions(long topicId)
Topic	getWebsite(long geomapId) Returns the "Kiezatlas Website" topic the given geomap is assigned to.
private boolean	hasSiteAssociation(Topic geoObject, long siteId)
private boolean	isGeomap(long topicmapId)
private boolean	isMultiFacet(String facetTypeUri)
void	postUpdateTopic(Topic topic, TopicModel newModel, TopicModel oldModel)
void	preSendTopic(Topic topic)
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.
private void	updateFacets(Topic geoObject, ResultList<RelatedTopic> facetTypes, TopicModel newModel)
void	updateImageFileFacet(Topic geoObject, String imageFilePath)

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

private static final String KA2_GEO_OBJECT_URI_PREFIX

See Also:

Constant Field Values

GEO_OBJECT_OWNER_PROPERTY

private static final String GEO_OBJECT_OWNER_PROPERTY

See Also:

Constant Field Values

GEO_OBJECT_KEYWORD_PROPERTY

private static final String GEO_OBJECT_KEYWORD_PROPERTY

See Also:

Constant Field Values

WEBSITE_GEOMAP

private static final String WEBSITE_GEOMAP

See Also:

Constant Field Values

ROLE_TYPE_WEBSITE

private static final String ROLE_TYPE_WEBSITE

See Also:

Constant Field Values

ROLE_TYPE_GEOMAP

private static final String ROLE_TYPE_GEOMAP

See Also:

Constant Field Values

WEBSITE_FACET_TYPES

private static final String WEBSITE_FACET_TYPES

See Also:

Constant Field Values

ROLE_TYPE_FACET_TYPE

private static final String ROLE_TYPE_FACET_TYPE

See Also:

Constant Field Values

geomapsService

private GeomapsService geomapsService

facetsService

private FacetsService facetsService

timeService

private TimeService timeService

accessControlService

private AccessControlService accessControlService

workspaceService

private WorkspacesService workspaceService

logger

private Logger logger

Constructor Detail

KiezatlasPlugin

public KiezatlasPlugin()

Method Detail

getKiezatlasAdministrationPage

public InputStream getKiezatlasAdministrationPage()

Fetches a simple page rendering objects for kiez-administrators.

Returns:

createWebsite

public Topic createWebsite(String siteName,
                  String siteUri)

Specified by:

createWebsite in interface KiezatlasService

addGeoObjectToWebsite

public Association addGeoObjectToWebsite(long geoObjectId,
                                long siteId)

Specified by:

addGeoObjectToWebsite in interface KiezatlasService

getWebsite

public 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 ResultList<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<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<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<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.

getInstitutionsMissingBezirk

public List<SocialInstitutionObject> getInstitutionsMissingBezirk()

getInstitutionsMissingBacklink

public List<SocialInstitutionObject> getInstitutionsMissingBacklink()

getSiteInstitutions

public List<SocialInstitutionObject> getSiteInstitutions(long topicId)

createGeoObjectAttribution

public javax.ws.rs.core.Response createGeoObjectAttribution(long id,
                                                   String owner,
                                                   String key)

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.

getGeoCoordinateByGeoObject

public GeoCoordinate getGeoCoordinateByGeoObject(Topic geoObject)

Description copied from interface: KiezatlasService

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

Specified by:

getGeoCoordinateByGeoObject in interface KiezatlasService

getGeoObjectAttribution

public String getGeoObjectAttribution(Topic geoObject)

Specified by:

getGeoObjectAttribution in interface KiezatlasService

getFacettedBezirksregionChildTopic

public Topic getFacettedBezirksregionChildTopic(Topic facettedTopic)

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

Specified by:

getFacettedBezirksregionChildTopic in interface KiezatlasService

getImageFileFacetByGeoObject

public Topic getImageFileFacetByGeoObject(Topic geoObject)

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

Specified by:

getImageFileFacetByGeoObject in interface KiezatlasService

getParentRelatedAggregatedGeoObjects

public ResultList<RelatedTopic> getParentRelatedAggregatedGeoObjects(Topic bezirksFacet)

Specified by:

getParentRelatedAggregatedGeoObjects in interface KiezatlasService

updateImageFileFacet

public void updateImageFileFacet(Topic geoObject,
                        String imageFilePath)

Specified by:

updateImageFileFacet in interface KiezatlasService

preSendTopic

public void preSendTopic(Topic topic)

Specified by:

preSendTopic in interface PreSendTopicListener

postUpdateTopic

public void postUpdateTopic(Topic topic,
                   TopicModel newModel,
                   TopicModel oldModel)

Specified by:

postUpdateTopic in interface PostUpdateTopicListener

getFacettedContactChildTopic

private Topic getFacettedContactChildTopic(Topic facettedTopic)

getFacettedBezirkChildTopic

private Topic getFacettedBezirkChildTopic(Topic facettedTopic)

hasSiteAssociation

private boolean hasSiteAssociation(Topic geoObject,
                         long siteId)

enrichWithFacets

private void enrichWithFacets(Topic geoObject,
                    ResultList<RelatedTopic> facetTypes)

enrichWithSingleFacet

private void enrichWithSingleFacet(Topic geoObject,
                         String facetTypeUri)

enrichWithMultiFacet

private void enrichWithMultiFacet(Topic geoObject,
                        String facetTypeUri)

updateFacets

private void updateFacets(Topic geoObject,
                ResultList<RelatedTopic> facetTypes,
                TopicModel newModel)

getFacetTypes

private ResultList<RelatedTopic> getFacetTypes()

Returns the facet types for the current topicmap, or null if the facet types can't be determined. There can be several reasons for the latter: a) there is no "current topicmap". This can be the case with 3rd-party clients. b) the current topicmap is not a geomap. c) the geomap is not part of a Kiezatlas Website.

Returns:

The facet types (as a result set, may be empty), or null.

fetchGeoObjects

private List<Topic> fetchGeoObjects(long geomapId)

getGeoObject

private Topic getGeoObject(Topic geoObjectName)

isGeomap

private boolean isGeomap(long topicmapId)

isMultiFacet

private boolean isMultiFacet(String facetTypeUri)

getChildTypeUri

private String getChildTypeUri(String facetTypeUri)

getAssocDef

private AssociationDefinition getAssocDef(String facetTypeUri)