systems.dmx.webclient

Class WebclientPlugin

Show UML class diagram

java.lang.Object

systems.dmx.core.osgi.PluginActivator

systems.dmx.webclient.WebclientPlugin

All Implemented Interfaces:

org.osgi.framework.BundleActivator, PluginContext, AllPluginsActiveListener, IntroduceAssociationTypeListener, IntroduceTopicTypeListener, PostUpdateTopicListener, PreCreateAssociationTypeListener, PreCreateTopicTypeListener, EventListener

public class WebclientPlugin
extends PluginActivator
implements AllPluginsActiveListener, IntroduceTopicTypeListener, IntroduceAssociationTypeListener, PreCreateTopicTypeListener, PreCreateAssociationTypeListener, PostUpdateTopicListener

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	hasWebclientLaunched
private Logger	logger
private static String	VIEW_CONFIG_LABEL

Fields inherited from class systems.dmx.core.osgi.PluginActivator

bundle, dmx, mf

Constructor Summary

Constructors

Constructor and Description
WebclientPlugin()

Method Summary

Modifier and Type	Method and Description
private void	addDefaultViewConfig(TypeModel typeModel) Add a default view config topic to the given type model in case no one is set already.
void	allPluginsActive()
private Topic	createSearchTopic(String searchTerm, Collection<Topic> resultItems) Creates a "Search" topic.
private Set<Topic>	findSearchableUnits(List<? extends Topic> topics)
List<RelatedTopic>	getRelatedTopics(long objectId)
Topic	getTopics(String typeUri) Performs a by-type search and creates a search result topic.
private Object	getViewConfigValue(TopicType topicType, String setting) Convenience method to lookup a Webclient view config value.
private String	getWebclientUrl()
private boolean	hasAssocDef(DMXObject parentObject, RelatedTopic childTopic)
void	introduceAssociationType(AssociationType assocType)
void	introduceTopicType(TopicType topicType)
private boolean	isDirectModelledChildTopic(DMXObject parentObject, RelatedTopic childTopic)
void	postUpdateTopic(Topic topic, TopicModel updateModel, TopicModel oldTopic) Once a view configuration is updated in the DB we must update the cached view configuration model.
void	preCreateAssociationType(AssociationTypeModel model) Add a default view config to the type in case no one is set.
void	preCreateTopicType(TopicTypeModel model) Add a default view config to the type in case no one is set.
private boolean	searchableAsUnit(Topic topic)
Topic	searchTopics(String searchTerm, String fieldUri) Performs a fulltext search and creates a search result topic.
private void	setConfigTopicLabel(Topic viewConfig)
private void	setViewConfigLabel(ViewConfiguration viewConfig)
private void	updateAssociationType(Topic type, Topic viewConfig)
private void	updateTopicType(Topic type, Topic viewConfig)
private void	updateType(Topic viewConfig)
private void	updateViewConfig(DMXType type, Topic viewConfig)

Methods inherited from class systems.dmx.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

VIEW_CONFIG_LABEL

private static final String VIEW_CONFIG_LABEL

See Also:

Constant Field Values

hasWebclientLaunched

private boolean hasWebclientLaunched

logger

private Logger logger

Constructor Detail

WebclientPlugin

public WebclientPlugin()

Method Detail

searchTopics

public Topic searchTopics(String searchTerm,
                          String fieldUri)

Performs a fulltext search and creates a search result topic.

getTopics

public Topic getTopics(String typeUri)

Performs a by-type search and creates a search result topic.

Note: this resource method is actually part of the Type Search plugin. TODO: proper modularization. Either let the Type Search plugin provide its own REST service or make the Type Search plugin an integral part of the Webclient plugin.

getRelatedTopics

public List<RelatedTopic> getRelatedTopics(long objectId)

allPluginsActive

public void allPluginsActive()

Specified by:

allPluginsActive in interface AllPluginsActiveListener

preCreateTopicType

public void preCreateTopicType(TopicTypeModel model)

Add a default view config to the type in case no one is set.

Note: the default view config needs a workspace assignment. The default view config must be added *before* the assignment can take place. Workspace assignment for a type (including its components like the view config) is performed by the type-introduction hook of the Workspaces module. Here we use the pre-create-type hook (instead of type-introduction too) as the pre-create-type hook is guaranteed to be invoked *before* type-introduction. On the other hand the order of type-introduction invocations is not deterministic accross plugins.

Specified by:

preCreateTopicType in interface PreCreateTopicTypeListener

preCreateAssociationType

public void preCreateAssociationType(AssociationTypeModel model)

Add a default view config to the type in case no one is set.

Note: the default view config needs a workspace assignment. The default view config must be added *before* the assignment can take place. Workspace assignment for a type (including its components like the view config) is performed by the type-introduction hook of the Workspaces module. Here we use the pre-create-type hook (instead of type-introduction too) as the pre-create-type hook is guaranteed to be invoked *before* type-introduction. On the other hand the order of type-introduction invocations is not deterministic accross plugins.

Specified by:

preCreateAssociationType in interface PreCreateAssociationTypeListener

postUpdateTopic

public void postUpdateTopic(Topic topic,
                            TopicModel updateModel,
                            TopicModel oldTopic)

Once a view configuration is updated in the DB we must update the cached view configuration model.

Specified by:

postUpdateTopic in interface PostUpdateTopicListener

introduceTopicType

public void introduceTopicType(TopicType topicType)

Specified by:

introduceTopicType in interface IntroduceTopicTypeListener

introduceAssociationType

public void introduceAssociationType(AssociationType assocType)

Specified by:

introduceAssociationType in interface IntroduceAssociationTypeListener

findSearchableUnits

private Set<Topic> findSearchableUnits(List<? extends Topic> topics)

createSearchTopic

private Topic createSearchTopic(String searchTerm,
                                Collection<Topic> resultItems)

Creates a "Search" topic.

searchableAsUnit

private boolean searchableAsUnit(Topic topic)

getViewConfigValue

private Object getViewConfigValue(TopicType topicType,
                                  String setting)

Convenience method to lookup a Webclient view config value.

Compare to client-side counterpart: function get_view_config() in webclient.js

Parameters:

topicType - The topic type whose view configuration is used for lookup.

setting - Last component of the child type URI whose value to lookup, e.g. "icon".

Returns:

The config value, or null if no value is set

updateType

private void updateType(Topic viewConfig)

updateTopicType

private void updateTopicType(Topic type,
                             Topic viewConfig)

updateAssociationType

private void updateAssociationType(Topic type,
                                   Topic viewConfig)

updateViewConfig

private void updateViewConfig(DMXType type,
                              Topic viewConfig)

setViewConfigLabel

private void setViewConfigLabel(ViewConfiguration viewConfig)

setConfigTopicLabel

private void setConfigTopicLabel(Topic viewConfig)

addDefaultViewConfig

private void addDefaultViewConfig(TypeModel typeModel)

Add a default view config topic to the given type model in case no one is set already.

This ensures a programmatically created type (through a migration) will have a view config in any case, for being edited interactively afterwards.

getWebclientUrl

private String getWebclientUrl()

isDirectModelledChildTopic

private boolean isDirectModelledChildTopic(DMXObject parentObject,
                                           RelatedTopic childTopic)

hasAssocDef

private boolean hasAssocDef(DMXObject parentObject,
                            RelatedTopic childTopic)