de.deepamehta.plugins.topicmaps.service
Interface TopicmapsService

Show UML class diagram

All Superinterfaces:

PluginService

All Known Implementing Classes:

TopicmapsPlugin

public interface TopicmapsService
extends PluginService

Field Summary

static String	DEFAULT_TOPICMAP_NAME
static String	DEFAULT_TOPICMAP_RENDERER

Method Summary

void	addAssociationToTopicmap(long topicmapId, long assocId) Adds an association to a topicmap.
void	addTopicToTopicmap(long topicmapId, long topicId, int x, int y, boolean visibility) Convenience method to add a topic with the standard view properties.
void	addTopicToTopicmap(long topicmapId, long topicId, ViewProperties viewProps) Adds a topic to a topicmap.
Topic	createTopicmap(String name, String topicmapRendererUri)
TopicmapViewmodel	getTopicmap(long topicmapId, boolean includeChilds)
boolean	isAssociationInTopicmap(long topicmapId, long assocId)
boolean	isTopicInTopicmap(long topicmapId, long topicId)
void	registerTopicmapRenderer(TopicmapRenderer renderer)
void	registerViewmodelCustomizer(ViewmodelCustomizer customizer)
void	removeAssociationFromTopicmap(long topicmapId, long assocId)
void	setClusterPosition(long topicmapId, ClusterCoords coords)
void	setTopicmapTranslation(long topicmapId, int trans_x, int trans_y)
void	setTopicPosition(long topicmapId, long topicId, int x, int y) Convenience method to update the "dm4.topicmaps.x" and "dm4.topicmaps.y" standard view properties.
void	setTopicVisibility(long topicmapId, long topicId, boolean visibility) Convenience method to update the "dm4.topicmaps.visibility" standard view property.
void	setViewProperties(long topicmapId, long topicId, ViewProperties viewProps)
void	unregisterViewmodelCustomizer(ViewmodelCustomizer customizer)

Field Detail

DEFAULT_TOPICMAP_NAME

static final String DEFAULT_TOPICMAP_NAME

See Also:

Constant Field Values

DEFAULT_TOPICMAP_RENDERER

static final String DEFAULT_TOPICMAP_RENDERER

See Also:

Constant Field Values

Method Detail

createTopicmap

Topic createTopicmap(String name,
                     String topicmapRendererUri)

getTopicmap

TopicmapViewmodel getTopicmap(long topicmapId,
                              boolean includeChilds)

Parameters:

includeChilds - if true the topics contained in the topicmap will include their child topics.

isTopicInTopicmap

boolean isTopicInTopicmap(long topicmapId,
                          long topicId)

isAssociationInTopicmap

boolean isAssociationInTopicmap(long topicmapId,
                                long assocId)

addTopicToTopicmap

void addTopicToTopicmap(long topicmapId,
                        long topicId,
                        ViewProperties viewProps)

Adds a topic to a topicmap. If the topic is added already an exception is thrown.

addTopicToTopicmap

void addTopicToTopicmap(long topicmapId,
                        long topicId,
                        int x,
                        int y,
                        boolean visibility)

Convenience method to add a topic with the standard view properties.

addAssociationToTopicmap

void addAssociationToTopicmap(long topicmapId,
                              long assocId)

Adds an association to a topicmap. If the association is added already an exception is thrown.

setViewProperties

void setViewProperties(long topicmapId,
                       long topicId,
                       ViewProperties viewProps)

setTopicPosition

void setTopicPosition(long topicmapId,
                      long topicId,
                      int x,
                      int y)

Convenience method to update the "dm4.topicmaps.x" and "dm4.topicmaps.y" standard view properties.

setTopicVisibility

void setTopicVisibility(long topicmapId,
                        long topicId,
                        boolean visibility)

Convenience method to update the "dm4.topicmaps.visibility" standard view property.

removeAssociationFromTopicmap

void removeAssociationFromTopicmap(long topicmapId,
                                   long assocId)

setClusterPosition

void setClusterPosition(long topicmapId,
                        ClusterCoords coords)

setTopicmapTranslation

void setTopicmapTranslation(long topicmapId,
                            int trans_x,
                            int trans_y)

registerTopicmapRenderer

void registerTopicmapRenderer(TopicmapRenderer renderer)

registerViewmodelCustomizer

void registerViewmodelCustomizer(ViewmodelCustomizer customizer)

unregisterViewmodelCustomizer

void unregisterViewmodelCustomizer(ViewmodelCustomizer customizer)