org.exoplatform.services.cms.folksonomy

Interface NewFolksonomyService

public interface NewFolksonomyService

Manages all tags and their styles. Currently, it just supports adding/editing/removing private and public tags.

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXO_TAGGED Property name EXO_TAGGED
static String	EXO_TAGSTYLE Property name EXO_TAGSTYLE
static String	EXO_TOTAL Property name EXO_TOTAL
static String	EXO_UUID Property name EXO_UUID
static int	GROUP Property name GROUP
static String	HTML_STYLE_PROP Property name HTML_STYLE_PROP
static int	PRIVATE Property name PRIVATE
static int	PUBLIC Property name PUBLIC
static int	SITE Property name SITE
static String	TAG_RATE_PROP Property name TAG_RATE_PROP

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	addTagStyle(String styleName, String tagRange, String htmlStyle, String workspace) Adds a tag style.
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, SessionProvider sessionProvider) Gets all documents which are marked with a given tag.
List<javax.jcr.Node>	getAllDocumentsByTagsAndPath(String selectedPath, Set<String> tagPaths, String workspace, 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[] role, 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 tagPath, String workspace) Gets a tag style.
void	init() Initializes all tag style plugins.
void	initTagPermissionListCache() Initializes the predefined tag permission list
javax.jcr.Node	modifyPublicTagName(String tagPath, String newTagName, String workspace, String treeTagPath) Renames a public tag.
javax.jcr.Node	modifyTagName(String tagPath, String newTagName, String workspace) Renames a tag.
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	updateTagStyle(String styleName, String tagRange, String htmlStyle, String workspace) Updates a tag style.

Field Detail

TAG_RATE_PROP

static final String TAG_RATE_PROP

Property name TAG_RATE_PROP

See Also:

Constant Field Values

HTML_STYLE_PROP

static final String HTML_STYLE_PROP

Property name HTML_STYLE_PROP

See Also:

Constant Field Values

EXO_TOTAL

static final String EXO_TOTAL

Property name EXO_TOTAL

See Also:

Constant Field Values

EXO_TAGGED

static final String EXO_TAGGED

Property name EXO_TAGGED

See Also:

Constant Field Values

EXO_UUID

static final String EXO_UUID

Property name EXO_UUID

See Also:

Constant Field Values

EXO_TAGSTYLE

static final String EXO_TAGSTYLE

Property name EXO_TAGSTYLE

See Also:

Constant Field Values

PUBLIC

static final int PUBLIC

Property name PUBLIC

See Also:

Constant Field Values

GROUP

static final int GROUP

Property name GROUP

See Also:

Constant Field Values

SITE

static final int SITE

Property name SITE

See Also:

Constant Field Values

PRIVATE

static final int PRIVATE

Property name PRIVATE

See Also:

Constant Field Values

Method Detail

addPrivateTag

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.

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

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.

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

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.

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

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.

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

getAllPrivateTags

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

Gets all private tags of a given user.

Parameters:

userName - Name of the given user.

Returns:

The list of private tags.

Throws:

Exception - The exception

getAllPublicTags

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

Gets all public tags.

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

getAllGroupTags

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

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

Parameters:

role - Roles of the given user.

workspace - Name of the workspace that contains tags.

Returns:

The tags of groups.

Throws:

Exception - The exception

getAllGroupTags

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

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

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

getAllSiteTags

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

Gets all site tags.

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

getAllDocumentsByTagsAndPath

List<javax.jcr.Node> getAllDocumentsByTagsAndPath(String selectedPath,
                                                  Set<String> tagPaths,
                                                  String workspace,
                                                  SessionProvider sessionProvider)
                                           throws Exception

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

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

List<javax.jcr.Node> getAllDocumentsByTag(String tagPath,
                                          String workspace,
                                          SessionProvider sessionProvider)
                                   throws Exception

Gets all documents which are marked with a given tag.

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

getTagStyle

String getTagStyle(String tagPath,
                   String workspace)
            throws Exception

Gets a tag style.

Parameters:

tagPath - Path to the tag.

workspace - Name of the workspace that contains the tag.

Returns:

Style values of the tag.

Throws:

Exception - The exception

addTagStyle

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

Adds a tag style.

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

updateTagStyle

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

Updates a tag style.

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

getAllTagStyle

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

Gets all tag styles of a folksonomy tree.

Parameters:

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

Returns:

The tag styles.

Throws:

Exception - The exception

init

void init()
   throws Exception

Initializes all tag style plugins.

Throws:

Exception - The exception

initTagPermissionListCache

void initTagPermissionListCache()
                         throws Exception

Initializes the predefined tag permission list

Throws:

Exception

removeTagOfDocument

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

Removes tag from a given document.

Parameters:

tagPath - Path of the tag.

document - The document from which the tag is removed.

Throws:

Exception - The exception

removeTag

void removeTag(String tagPath,
               String workspace)
        throws Exception

Removes a tag.

Parameters:

tagPath - Path of the tag.

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

Throws:

Exception - The exception

modifyTagName

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

Renames a tag.

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

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

Renames a public tag.

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.

treeTagPath - Path of the folksonomy tree.

Returns:

The renamed public tag.

Throws:

Exception - The exception

getLinkedTagsOfDocument

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

Gets all tags linked to a given document.

Parameters:

documentNode - The document node.

workspace - Name of the workspace that contains all tags.

Returns:

The list of tags.

Throws:

Exception - The exception

getLinkedTagsOfDocumentByScope

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

Get all tags linked to a given document by scope.

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

removeTagsOfNodeRecursively

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.

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

addTagPermission

void addTagPermission(String usersOrGroups)

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

Parameters:

usersOrGroups - Name of the given user or group.

removeTagPermission

void removeTagPermission(String usersOrGroups)

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

Parameters:

usersOrGroups - Name of the user or group.

getTagPermissionList

List<String> getTagPermissionList()

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

Returns:

The list of users and groups.

canEditTag

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

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

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

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

Gets names of all tags under a given scope.

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

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

Gets a type of data distribution.

Returns:

The type of data distribution.