systems.dmx.topicmaps

Interface TopicmapsService

Show UML class diagram

All Known Implementing Classes:

TopicmapsPlugin

public interface TopicmapsService

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TOPICMAP_NAME
static String	DEFAULT_TOPICMAP_RENDERER

Method Summary

Modifier and Type	Method and Description
void	addAssociationToTopicmap(long topicmapId, long assocId, ViewProperties viewProps) Adds an association to a topicmap.
void	addRelatedTopicToTopicmap(long topicmapId, long topicId, long assocId, ViewProperties viewProps)
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, boolean isPrivate)
TopicmapViewmodel	getTopicmap(long topicmapId, boolean includeChilds)
void	hideAssocs(long topicmapId, IdList assocIds)
void	hideMulti(long topicmapId, IdList topicIds, IdList assocIds)
void	hideTopics(long topicmapId, IdList topicIds)
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) Removes an association from a topicmap.
void	setAssociationViewProperties(long topicmapId, long assocId, ViewProperties viewProps)
void	setClusterPosition(long topicmapId, ClusterCoords coords)
void	setTopicmapTranslation(long topicmapId, int transX, int transY)
void	setTopicPosition(long topicmapId, long topicId, int x, int y) Convenience method to update the "dmx.topicmaps.x" and "dmx.topicmaps.y" standard view properties.
void	setTopicViewProperties(long topicmapId, long topicId, ViewProperties viewProps)
void	setTopicVisibility(long topicmapId, long topicId, boolean visibility) Convenience method to update the "dmx.topicmaps.visibility" standard view property.
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,
                     boolean isPrivate)

Returns:

the created Topicmap topic. ### TODO: rename 2nd param into "topicmapTypeUri"

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,
                              ViewProperties viewProps)

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

addRelatedTopicToTopicmap

void addRelatedTopicToTopicmap(long topicmapId,
                               long topicId,
                               long assocId,
                               ViewProperties viewProps)

setTopicViewProperties

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

setAssociationViewProperties

void setAssociationViewProperties(long topicmapId,
                                  long assocId,
                                  ViewProperties viewProps)

setTopicPosition

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

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

setTopicVisibility

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

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

removeAssociationFromTopicmap

void removeAssociationFromTopicmap(long topicmapId,
                                   long assocId)

Removes an association from a topicmap. If the associationn is not contained in the topicmap nothing is performed.

hideTopics

void hideTopics(long topicmapId,
                IdList topicIds)

hideAssocs

void hideAssocs(long topicmapId,
                IdList assocIds)

hideMulti

void hideMulti(long topicmapId,
               IdList topicIds,
               IdList assocIds)

setClusterPosition

void setClusterPosition(long topicmapId,
                        ClusterCoords coords)

setTopicmapTranslation

void setTopicmapTranslation(long topicmapId,
                            int transX,
                            int transY)

registerTopicmapRenderer

void registerTopicmapRenderer(TopicmapRenderer renderer)

registerViewmodelCustomizer

void registerViewmodelCustomizer(ViewmodelCustomizer customizer)

unregisterViewmodelCustomizer

void unregisterViewmodelCustomizer(ViewmodelCustomizer customizer)