de.deepamehta.plugins.tags

Class TaggingPlugin

Show UML class diagram

java.lang.Object

de.deepamehta.core.osgi.PluginActivator

de.deepamehta.plugins.tags.TaggingPlugin

All Implemented Interfaces:

PluginContext, TaggingService, org.osgi.framework.BundleActivator

public class TaggingPlugin
extends PluginActivator
implements TaggingService

A basic plugin-service for fetching topics in DeepaMehta 4 by type and one or many tags.

Version:

1.3.9-SNAPSHOT compatible with DeepaMehta 4.7

Author:

Malte Reißig ()

Field Summary

Fields

Modifier and Type	Field and Description
private static String	AGGREGATION
private static String	CHILD_URI
private Logger	log
private static String	PARENT_URI
static String	VIEW_CSS_CLASS_COUNT_URI
static String	VIEW_RELATED_COUNT_URI
private WorkspacesService	workspaceService

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

bundle, dms

Fields inherited from interface de.deepamehta.plugins.tags.TaggingService

TAG_DEFINITION_URI, TAG_LABEL_URI, TAG_URI

Constructor Summary

Constructors

Constructor and Description
TaggingPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
Topic	createTagTopic(String name, String definition, boolean lowerCase) Creates a topic of type "dm4.tags.tag" after checking for existence by name and trimming the name.
private void	enrichTopicViewModelAboutCSSClass(Topic resource, int related_count)
private void	enrichTopicViewModelAboutRelatedCount(Topic resource, int count) Private Helper Methods
Topic	getTagTopic(String name, boolean caseSensitive) Returns a topic (typeUri="dm4.tags.tag") with the given name.
ResultList<RelatedTopic>	getTopicsByTagAndTypeURI(long tagId, String relatedTopicTypeUri) Convenience method to fetch a list of topics (of a given Topic Type) using the "Tag" with the given topic id.
ResultList<RelatedTopic>	getTopicsByTagsAndTypeUri(String tags, String relatedTopicTypeUri) Convenience method to fetch a list of topics (of a given Topic Type) using a list of "Tags".
String	getViewTagsModelWithRelatedCount(String relatedTopicTypeUri) Generate a JSONArray with properties helpful to produce an interactive tag cloud.
private boolean	hasRelatedTopicTag(RelatedTopic resource, long tagId)

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

log

private Logger log

CHILD_URI

private static final String CHILD_URI

See Also:

Constant Field Values

PARENT_URI

private static final String PARENT_URI

See Also:

Constant Field Values

AGGREGATION

private static final String AGGREGATION

See Also:

Constant Field Values

VIEW_RELATED_COUNT_URI

public static final String VIEW_RELATED_COUNT_URI

See Also:

Constant Field Values

VIEW_CSS_CLASS_COUNT_URI

public static final String VIEW_CSS_CLASS_COUNT_URI

See Also:

Constant Field Values

workspaceService

private WorkspacesService workspaceService

Constructor Detail

TaggingPlugin

public TaggingPlugin()

Method Detail

getTopicsByTagAndTypeURI

public ResultList<RelatedTopic> getTopicsByTagAndTypeURI(long tagId,
                                                String relatedTopicTypeUri)

Convenience method to fetch a list of topics (of a given Topic Type) using the "Tag" with the given topic id. Note: This method provides no real benefit for developers familiar with the getRelatedTopics() of the deepamehta-core API. It's just a convenient call.

Specified by:

getTopicsByTagAndTypeURI in interface TaggingService

Parameters:

tagId - A topic id ot a "dm4.tags.tag"-Topic

relatedTopicTypeUri - A Topic Type URI identifying a type of topics. The Topic Type Definition is expected to have an Aggregation Definition with cardinality set to Many to the Topic Type Tag (typeUri="dm4.tags.tag").

getTopicsByTagsAndTypeUri

public ResultList<RelatedTopic> getTopicsByTagsAndTypeUri(String tags,
                                                 String relatedTopicTypeUri)

Convenience method to fetch a list of topics (of a given Topic Type) using a list of "Tags".

Specified by:

getTopicsByTagsAndTypeUri in interface TaggingService

Parameters:

tags - A String of a JSONObject containing a JSONArray (under the key="tags") of "dm4.tags.tag"-Topics is expected. For example: "{ "tags": [ { "id": 1234 } ] }").

relatedTopicTypeUri - A type_uri of a composite (e.g. "org.deepamehta.resources.resource") which must aggregate one or many "dm4.tags.tag".

getViewTagsModelWithRelatedCount

public String getViewTagsModelWithRelatedCount(String relatedTopicTypeUri)

Generate a JSONArray with properties helpful to produce an interactive tag cloud.

Specified by:

getViewTagsModelWithRelatedCount in interface TaggingService

Parameters:

relatedTopicTypeUri - Type URI of related Topic Type counted.

Returns:

String Containing a JSON Object with some properties helpful for visualization (including CSS class names).

createTagTopic

public Topic createTagTopic(String name,
                   String definition,
                   boolean lowerCase)
                     throws IllegalArgumentException

Creates a topic of type "dm4.tags.tag" after checking for existence by name and trimming the name. If a tag with the given name ("dm4.tags.label") already exists, an IllegalArgumentException is thrown.

Specified by:

createTagTopic in interface TaggingService

Parameters:

name - Label of the tag.

definition - Definition the label stands for.

lowerCase - Do existence check after converting the given name with a .toLowerCase() call.

Returns:

Topic The complete tag topic created.

Throws:

IllegalArgumentException

getTagTopic

public Topic getTagTopic(String name,
                boolean caseSensitive)

Returns a topic (typeUri="dm4.tags.tag") with the given name.

Specified by:

getTagTopic in interface TaggingService

Parameters:

name - label of given tag

caseSensitive - flag if to use toLowerCase when getting

Returns:

Topic The topic or null if no topic was found under the given name.

enrichTopicViewModelAboutRelatedCount

private void enrichTopicViewModelAboutRelatedCount(Topic resource,
                                         int count)

Private Helper Methods

enrichTopicViewModelAboutCSSClass

private void enrichTopicViewModelAboutCSSClass(Topic resource,
                                     int related_count)

hasRelatedTopicTag

private boolean hasRelatedTopicTag(RelatedTopic resource,
                         long tagId)