org.exoplatform.services.cms.folksonomy.impl

Class NewFolksonomyServiceImpl

java.lang.Object

org.exoplatform.services.cms.folksonomy.impl.NewFolksonomyServiceImpl

All Implemented Interfaces:

NewFolksonomyService, org.picocontainer.Startable

public class NewFolksonomyServiceImpl
extends Object
implements NewFolksonomyService, org.picocontainer.Startable

Created by The eXo Platform SARL Author : Dang Van Minh minh.dang@exoplatform.com Nov 16, 2009 10:30:24 AM

Field Summary

Fields inherited from interface org.exoplatform.services.cms.folksonomy.NewFolksonomyService

EXO_TAGGED, EXO_TAGSTYLE, EXO_TOTAL, EXO_UUID, GROUP, HTML_STYLE_PROP, PRIVATE, PUBLIC, SITE, TAG_RATE_PROP

Constructor Summary

Constructors

Constructor and Description

NewFolksonomyServiceImpl(org.exoplatform.container.xml.InitParams initParams, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, LinkManager linkManager, org.exoplatform.services.jcr.ext.distribution.DataDistributionManager dataDistributionManager, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviderService, org.exoplatform.services.cache.CacheService cacheService)

Method Summary

Modifier and Type	Method and Description
void	addGroupsTag(String[] tagsName, javax.jcr.Node documentNode, String workspace, String[] roles) Adds a group tag to a document.
void	addPrivateTag(String[] tagsName, javax.jcr.Node documentNode, String workspace, String userName) Adds a private tag to a document.
void	addPublicTag(String treePath, String[] tagsName, javax.jcr.Node documentNode, String workspace) Adds a public tag to a document.
void	addSiteTag(String siteName, String[] tagsName, javax.jcr.Node node, String workspace) Adds a site tag to a document.
void	addTagPermission(String usersOrGroups) Adds a given user or group to the list of tag permissions.
void	addTagPermissionPlugin(org.exoplatform.container.component.ComponentPlugin plugin) Add new users or groups into tagPermissionPlugin_
void	addTagStyle(String styleName, String tagRange, String htmlStyle, String workspace) Adds a tag style.
void	addTagStylePlugin(org.exoplatform.container.component.ComponentPlugin plugin) Add new TagStylePlugin in plugin_
boolean	canEditTag(int scope, List<String> memberships) Checks if a given user has the "edit tag" permission.
List<javax.jcr.Node>	getAllDocumentsByTag(String tagPath, String workspace, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Gets all documents which are marked with a given tag.
List<javax.jcr.Node>	getAllDocumentsByTagsAndPath(String selectedPath, Set<String> tagPaths, String workspace, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Gets all documents which are marked with given tags and that are located in a selected path.
List<javax.jcr.Node>	getAllGroupTags(String[] roles, String workspace) Gets all tags of groups that a given user belongs to.
List<javax.jcr.Node>	getAllGroupTags(String role, String workspace) Gets all tags of a group that a given user belongs to.
List<javax.jcr.Node>	getAllPrivateTags(String userName) Gets all private tags of a given user.
List<javax.jcr.Node>	getAllPublicTags(String treePath, String workspace) Gets all public tags.
List<javax.jcr.Node>	getAllSiteTags(String siteName, String workspace) Gets all site tags.
List<String>	getAllTagNames(String workspace, int scope, String value) Gets names of all tags under a given scope.
List<javax.jcr.Node>	getAllTagStyle(String workspace) Gets all tag styles of a folksonomy tree.
org.exoplatform.services.jcr.ext.distribution.DataDistributionType	getDataDistributionType() Gets a type of data distribution.
List<javax.jcr.Node>	getLinkedTagsOfDocument(javax.jcr.Node documentNode, String workspace) Gets all tags linked to a given document.
List<javax.jcr.Node>	getLinkedTagsOfDocumentByScope(int scope, String value, javax.jcr.Node documentNode, String workspace) Get all tags linked to a given document by scope.
List<String>	getTagPermissionList() Gets a list of users and groups who have the tag permission.
String	getTagStyle(String tagStylePath, String workspace) Gets a tag style.
void	init() init all available TagStylePlugin
void	initTagPermissionListCache() init the cache tagPermissionList
javax.jcr.Node	modifyPublicTagName(String tagPath, String newTagName, String workspace, String treePath) Renames a public tag.
javax.jcr.Node	modifyTagName(String tagPath, String newTagName, String workspace) Deprecated.
void	removeTag(String tagPath, String workspace) Removes a tag.
void	removeTagOfDocument(String tagPath, javax.jcr.Node document, String workspace) Removes tag from a given document.
void	removeTagPermission(String usersOrGroups) Removes a given user or group from the list of tag permissions.
void	removeTagsOfNodeRecursively(javax.jcr.Node node, String workspace, String username, String groups) Removes all tags linked to the child nodes of a given node.
void	start() Implement method in Startable Call init() method
void	stop() Implement method in Startable
void	updateTagStyle(String styleName, String tagRange, String htmlStyle, String workspace) Updates a tag style.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NewFolksonomyServiceImpl

public NewFolksonomyServiceImpl(org.exoplatform.container.xml.InitParams initParams,
                                org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator,
                                LinkManager linkManager,
                                org.exoplatform.services.jcr.ext.distribution.DataDistributionManager dataDistributionManager,
                                org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviderService,
                                org.exoplatform.services.cache.CacheService cacheService)
                         throws Exception

Throws:

Exception

Method Detail

start

public void start()

Implement method in Startable Call init() method

Specified by:

start in interface org.picocontainer.Startable

See Also:

init()

stop

public void stop()

Implement method in Startable

Specified by:

stop in interface org.picocontainer.Startable

addPrivateTag

public void addPrivateTag(String[] tagsName,
                          javax.jcr.Node documentNode,
                          String workspace,
                          String userName)
                   throws Exception

Adds a private tag to a document. A folksonomy link will be created in the tag node.

Specified by:

addPrivateTag in interface NewFolksonomyService

Parameters:

tagsName - The array of tag names.

documentNode - The document node to which the private tag is added.

workspace - Name of the workspace that contains the document node.

userName - The user who added the private tag.

Throws:

Exception - The exception

addGroupsTag

public void addGroupsTag(String[] tagsName,
                         javax.jcr.Node documentNode,
                         String workspace,
                         String[] roles)
                  throws Exception

Adds a group tag to a document. A folksonomy link will be created in the tag node.

Specified by:

addGroupsTag in interface NewFolksonomyService

Parameters:

tagsName - The array of tag names.

documentNode - The document node to which the group tag is added.

workspace - Name of the workspace that contains the document node.

roles - Roles of the user who added the group tag.

Throws:

Exception - The exception

addPublicTag

public void addPublicTag(String treePath,
                         String[] tagsName,
                         javax.jcr.Node documentNode,
                         String workspace)
                  throws Exception

Adds a public tag to a document. A folksonomy link will be created in the tag node.

Specified by:

addPublicTag in interface NewFolksonomyService

Parameters:

treePath - Path of the folksonomy tree.

tagsName - The array of the tag names.

documentNode - The document node to which the public tag is added.

workspace - Name of the workspace that contains the document node.

Throws:

Exception - The exception

addSiteTag

public void addSiteTag(String siteName,
                       String[] tagsName,
                       javax.jcr.Node node,
                       String workspace)
                throws Exception

Adds a site tag to a document. A folksonomy link will be created in the tag node.

Specified by:

addSiteTag in interface NewFolksonomyService

Parameters:

siteName - The site name.

tagsName - The array of tag names.

node - The document node to which the site tag is added.

workspace - Name of the workspace that contains the document node.

Throws:

Exception - The exception

getAllDocumentsByTagsAndPath

public List<javax.jcr.Node> getAllDocumentsByTagsAndPath(String selectedPath,
                                                         Set<String> tagPaths,
                                                         String workspace,
                                                         org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
                                                  throws Exception

Gets all documents which are marked with given tags and that are located in a selected path.

Specified by:

getAllDocumentsByTagsAndPath in interface NewFolksonomyService

Parameters:

selectedPath - Parent path to filter nodes

tagPaths - list of tags JCR paths

workspace - the workspace of resulted nodes

sessionProvider - use session provider to query JCR

Returns:

the filtered List of Node

Throws:

Exception

getAllDocumentsByTag

public List<javax.jcr.Node> getAllDocumentsByTag(String tagPath,
                                                 String workspace,
                                                 org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
                                          throws Exception

Gets all documents which are marked with a given tag.

Specified by:

getAllDocumentsByTag in interface NewFolksonomyService

Parameters:

tagPath - Path of the given tag.

workspace - Name of the workspace that contains the given tag.

sessionProvider - The session provider.

Returns:

The list of documents.

Throws:

Exception - The exception

getAllGroupTags

public List<javax.jcr.Node> getAllGroupTags(String[] roles,
                                            String workspace)
                                     throws Exception

Gets all tags of groups that a given user belongs to.

Specified by:

getAllGroupTags in interface NewFolksonomyService

Parameters:

roles - Roles of the given user.

workspace - Name of the workspace that contains tags.

Returns:

The tags of groups.

Throws:

Exception - The exception

getAllGroupTags

public List<javax.jcr.Node> getAllGroupTags(String role,
                                            String workspace)
                                     throws Exception

Gets all tags of a group that a given user belongs to.

Specified by:

getAllGroupTags in interface NewFolksonomyService

Parameters:

role - Roles of the given user.

workspace - Name of the workspace that contains tags.

Returns:

The tags of the given group.

Throws:

Exception - The exception

getAllPrivateTags

public List<javax.jcr.Node> getAllPrivateTags(String userName)
                                       throws Exception

Gets all private tags of a given user.

Specified by:

getAllPrivateTags in interface NewFolksonomyService

Parameters:

userName - Name of the given user.

Returns:

The list of private tags.

Throws:

Exception - The exception

getAllPublicTags

public List<javax.jcr.Node> getAllPublicTags(String treePath,
                                             String workspace)
                                      throws Exception

Gets all public tags.

Specified by:

getAllPublicTags in interface NewFolksonomyService

Parameters:

treePath - Path of the folksonomy tree.

workspace - Name of the workspace that contains public tags.

Returns:

The list of public tags.

Throws:

Exception - The exception

getAllSiteTags

public List<javax.jcr.Node> getAllSiteTags(String siteName,
                                           String workspace)
                                    throws Exception

Gets all site tags.

Specified by:

getAllSiteTags in interface NewFolksonomyService

Parameters:

siteName - The site name.

workspace - Name of the workspace that contains the site tags.

Returns:

The list of site tags.

Throws:

Exception - The exception

getAllTagStyle

public List<javax.jcr.Node> getAllTagStyle(String workspace)
                                    throws Exception

Gets all tag styles of a folksonomy tree.

Specified by:

getAllTagStyle in interface NewFolksonomyService

Parameters:

workspace - Name of the workspace that contains the tag styles.

Returns:

The tag styles.

Throws:

Exception - The exception

getTagStyle

public String getTagStyle(String tagStylePath,
                          String workspace)
                   throws Exception

Gets a tag style.

Specified by:

getTagStyle in interface NewFolksonomyService

Parameters:

tagStylePath - Path to the tag.

workspace - Name of the workspace that contains the tag.

Returns:

Style values of the tag.

Throws:

Exception - The exception

addTagStylePlugin

public void addTagStylePlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Add new TagStylePlugin in plugin_

Parameters:

plugin -

init

public void init()
          throws Exception

init all available TagStylePlugin

Specified by:

init in interface NewFolksonomyService

Throws:

Exception

initTagPermissionListCache

public void initTagPermissionListCache()
                                throws Exception

init the cache tagPermissionList

Specified by:

initTagPermissionListCache in interface NewFolksonomyService

Throws:

Exception

modifyTagName

@Deprecated
public javax.jcr.Node modifyTagName(String tagPath,
                                                String newTagName,
                                                String workspace)
                                         throws Exception

Deprecated.

Renames a tag.

Specified by:

modifyTagName in interface NewFolksonomyService

Parameters:

tagPath - Path of the tag.

newTagName - New name of the tag.

workspace - Name of the workspace that contains the renamed tag.

Returns:

The renamed tag.

Throws:

Exception - The exception

modifyPublicTagName

public javax.jcr.Node modifyPublicTagName(String tagPath,
                                          String newTagName,
                                          String workspace,
                                          String treePath)
                                   throws Exception

Renames a public tag.

Specified by:

modifyPublicTagName in interface NewFolksonomyService

Parameters:

tagPath - Path of the public tag.

newTagName - New name of the public tag.

workspace - Name of the workspace that contains the renamed public tag.

treePath - Path of the folksonomy tree.

Returns:

The renamed public tag.

Throws:

Exception - The exception

removeTag

public void removeTag(String tagPath,
                      String workspace)
               throws Exception

Removes a tag.

Specified by:

removeTag in interface NewFolksonomyService

Parameters:

tagPath - Path of the tag.

workspace - Name of the workspace that contains the removed tag.

Throws:

Exception - The exception

removeTagOfDocument

public void removeTagOfDocument(String tagPath,
                                javax.jcr.Node document,
                                String workspace)
                         throws Exception

Removes tag from a given document.

Specified by:

removeTagOfDocument in interface NewFolksonomyService

Parameters:

tagPath - Path of the tag.

document - The document from which the tag is removed.

Throws:

Exception - The exception

updateTagStyle

public void updateTagStyle(String styleName,
                           String tagRange,
                           String htmlStyle,
                           String workspace)
                    throws Exception

Updates a tag style.

Specified by:

updateTagStyle in interface NewFolksonomyService

Parameters:

styleName - Name of the tag style.

tagRange - The number of times the tag is used for the tag style.

htmlStyle - The tag style.

workspace - Name of the workspace that contains the tag style.

Throws:

Exception - The exception

addTagStyle

public void addTagStyle(String styleName,
                        String tagRange,
                        String htmlStyle,
                        String workspace)
                 throws Exception

Adds a tag style.

Specified by:

addTagStyle in interface NewFolksonomyService

Parameters:

styleName - Name of the tag style.

tagRange - The number of times the tag is used for the tag style.

htmlStyle - The tag style.

workspace - Name of the workspace that contains the tag style.

Throws:

Exception - The exception

removeTagsOfNodeRecursively

public void removeTagsOfNodeRecursively(javax.jcr.Node node,
                                        String workspace,
                                        String username,
                                        String groups)
                                 throws Exception

Removes all tags linked to the child nodes of a given node.

Specified by:

removeTagsOfNodeRecursively in interface NewFolksonomyService

Parameters:

node - The given node.

workspace - Name of the workspace that contains all tags.

username - The user who removed all tags.

Throws:

Exception - The exception

getLinkedTagsOfDocument

public List<javax.jcr.Node> getLinkedTagsOfDocument(javax.jcr.Node documentNode,
                                                    String workspace)
                                             throws Exception

Description copied from interface: NewFolksonomyService

Gets all tags linked to a given document.

Specified by:

getLinkedTagsOfDocument in interface NewFolksonomyService

Parameters:

documentNode - The document node.

workspace - Name of the workspace that contains all tags.

Returns:

The list of tags.

Throws:

Exception - The exception

getLinkedTagsOfDocumentByScope

public List<javax.jcr.Node> getLinkedTagsOfDocumentByScope(int scope,
                                                           String value,
                                                           javax.jcr.Node documentNode,
                                                           String workspace)
                                                    throws Exception

Description copied from interface: NewFolksonomyService

Get all tags linked to a given document by scope.

Specified by:

getLinkedTagsOfDocumentByScope in interface NewFolksonomyService

Parameters:

scope - The tag's scope.

documentNode - The document node.

workspace - Name of the workspace that contains all tags.

Returns:

The list of tags.

Throws:

Exception - The exception

addTagPermissionPlugin

public void addTagPermissionPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Add new users or groups into tagPermissionPlugin_

Parameters:

plugin -

addTagPermission

public void addTagPermission(String usersOrGroups)

Adds a given user or group to the list of tag permissions.

Specified by:

addTagPermission in interface NewFolksonomyService

Parameters:

usersOrGroups - Name of the given user or group.

removeTagPermission

public void removeTagPermission(String usersOrGroups)

Removes a given user or group from the list of tag permissions.

Specified by:

removeTagPermission in interface NewFolksonomyService

Parameters:

usersOrGroups - Name of the user or group.

getTagPermissionList

public List<String> getTagPermissionList()

Gets a list of users and groups who have the tag permission.

Specified by:

getTagPermissionList in interface NewFolksonomyService

Returns:

The list of users and groups.

canEditTag

public boolean canEditTag(int scope,
                          List<String> memberships)

Checks if a given user has the "edit tag" permission.

Specified by:

canEditTag in interface NewFolksonomyService

Parameters:

scope - The tag's scope.

memberships - The memberships.

Returns:

"True" if the given user has the "edit tag" permission. Otherwise, it returns "false".

getAllTagNames

public List<String> getAllTagNames(String workspace,
                                   int scope,
                                   String value)
                            throws Exception

Gets names of all tags under a given scope.

Specified by:

getAllTagNames in interface NewFolksonomyService

Parameters:

workspace - Name of the workspace that contains the tags.

scope - The tags' scope.

value - Path of the folksonomy tree.

Returns:

The tag names.

Throws:

Exception - The exception

getDataDistributionType

public org.exoplatform.services.jcr.ext.distribution.DataDistributionType getDataDistributionType()

Gets a type of data distribution.

Specified by:

getDataDistributionType in interface NewFolksonomyService

Returns:

The type of data distribution.