de.deepamehta.tags

Class TaggingPlugin

java.lang.Object

de.deepamehta.core.osgi.PluginActivator

de.deepamehta.tags.TaggingPlugin

All Implemented Interfaces:

de.deepamehta.core.osgi.PluginContext, TaggingService, org.osgi.framework.BundleActivator

public class TaggingPlugin
extends de.deepamehta.core.osgi.PluginActivator
implements TaggingService

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

Version:

1.3.11 compatible with DeepaMehta 4.9

Author:

Malte Reißig ()

Field Summary

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

bundle, dm4, mf

Fields inherited from interface de.deepamehta.tags.TaggingService

DEFINITION_URI, LABEL_URI, TAG

Constructor Summary

Constructors

Constructor and Description
TaggingPlugin()

Method Summary

Modifier and Type	Method and Description
de.deepamehta.core.Topic	createTagTopic(String name, String definition, boolean caseSensitive) Creates a topic of type "dm4.tags.tag" after checking for existence by name and trimming the name.
de.deepamehta.core.Topic	getTagTopic(String name, boolean caseSensitive) Returns a topic (typeUri="dm4.tags.tag") with the given name.
List<de.deepamehta.core.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.
List<de.deepamehta.core.RelatedTopic>	getTopicsByTagsAndTypeUri(String tags, String relatedTopicTypeUri) Convenience method to fetch a list of topics (of a given Topic Type) using a list of "Tags".
List<TagViewModel>	getViewTagsModelWithRelatedCount(String relatedTopicTypeUri) Generate a JSONArray with properties helpful to produce an interactive tag cloud.

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

Constructor Detail

TaggingPlugin

public TaggingPlugin()

Method Detail

getTopicsByTagAndTypeURI

public List<de.deepamehta.core.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").

Returns:

A list of RelatedTopics of the given type (identified by typeUri) and associated with the given Tag (identified by topic id).

getTopicsByTagsAndTypeUri

public List<de.deepamehta.core.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".

Returns:

A list of RelatedTopics of the given type (identified by typeUri) and associated with a list of tags (identified by string encoded JSON Array of topic ids).

getViewTagsModelWithRelatedCount

public List<TagViewModel> 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) all tags regarding a specific topic type (identified by typeUri) which aggregates one or many tags.

createTagTopic

public de.deepamehta.core.Topic createTagTopic(String name,
                                               String definition,
                                               boolean caseSensitive)
                                        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.

caseSensitive - If false does existence check for tag applying .toLowerCase()

Returns:

Topic The complete tag topic created.

Throws:

IllegalArgumentException

getTagTopic

public de.deepamehta.core.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.