org.jahia.services.tags

Class TaggingService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.tags.TaggingService

All Implemented Interfaces:

JahiaAfterInitializationService

public class TaggingService
extends JahiaService
implements JahiaAfterInitializationService

JCR content tagging service.

Author:

Sergiy Shyrkov

Field Summary

Fields

Modifier and Type	Field and Description
static String	J_TAG_LIST
static String	JMIX_TAGGED

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
TaggingService()

Method Summary

Modifier and Type	Method and Description
boolean	createTag(String tag, String siteKey) Deprecated. the tags are no longer nodes, there are stored directly on the content
boolean	deleteTag(String tag, String siteKey) Deprecated. not relevant anymore, the tags are no longer nodes
<X> X	deleteTagUnderPath(String startPath, JCRSessionWrapper session, String selectedTag, TagActionCallback<X> callback) Delete all occurrence of a specific tag under a given path
boolean	exists(String tag, String siteKey) Deprecated. not relevant anymore, the tags are no longer nodes, there are stored directly on the content, Use #getTagsSuggester().suggest(String, String, Long, Long, Long, boolean, org.jahia.services.content.JCRSessionWrapper) instead
static TaggingService	getInstance() Get the tagging service instance
JCRNodeWrapper	getTag(String tag, String siteKey, JCRSessionWrapper session) Deprecated. the tags are no longer nodes, there are stored directly on the content, Use #getTagsSuggester().suggest(String, String, Long, Long, Long, boolean, org.jahia.services.content.JCRSessionWrapper) instead
long	getTagCount(String tag, String siteKey) Deprecated. Use #getTagsSuggester().suggest(String, String, Long, Long, Long, boolean, org.jahia.services.content.JCRSessionWrapper) instead
TagHandler	getTagHandler()
TagsSuggester	getTagsSuggester()
void	init()
void	initAfterAllServicesAreStarted()
void	renameTag(JCRNodeWrapper node, String selectedTag, String tagNewName) Rename a specific tag on a node
void	renameTag(String nodePath, String selectedTag, String tagNewName, JCRSessionWrapper session) Rename a specific tag on a node
<X> X	renameTagUnderPath(String startPath, JCRSessionWrapper session, String selectedTag, String tagNewName, TagActionCallback<X> callback) Rename all occurrence of a specific tag under a given path The session will be saved each 100 nodes processed
void	setTagHandler(TagHandler tagHandler)
void	setTagsSuggester(TagsSuggester tagsSuggester)
void	start()
void	stop()
List<String>	tag(JCRNodeWrapper node, List<String> tags) Tag the specific node
List<String>	tag(JCRNodeWrapper node, String tag) Tag the specific node
boolean	tag(JCRNodeWrapper node, String tag, String siteKey, boolean createTagIfNotExists) Deprecated. Use tag(org.jahia.services.content.JCRNodeWrapper, String) instead
List<String>	tag(String nodePath, List<String> tags, JCRSessionWrapper session) Tag the specific node
List<String>	tag(String nodePath, String tag, JCRSessionWrapper session) Tag the specific node
boolean	tag(String nodePath, String tag, String siteKey, boolean createTagIfNotExists) Deprecated. Use tag(org.jahia.services.content.JCRNodeWrapper, String) instead
boolean	tag(String nodePath, String tag, String siteKey, boolean createTagIfNotExists, JCRSessionWrapper session) Deprecated. Use tag(org.jahia.services.content.JCRNodeWrapper, String) instead
List<String>	untag(JCRNodeWrapper node, List<String> tags) Untag the specific node
List<String>	untag(JCRNodeWrapper node, String tag) Untag the specific node
List<String>	untag(String nodePath, List<String> tags, JCRSessionWrapper session) Untag the specific node
List<String>	untag(String nodePath, String tag, JCRSessionWrapper session) Untag the specific node

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Field Detail

JMIX_TAGGED

public static final String JMIX_TAGGED

See Also:

Constant Field Values

J_TAG_LIST

public static final String J_TAG_LIST

See Also:

Constant Field Values

Constructor Detail

TaggingService

public TaggingService()

Method Detail

getInstance

public static TaggingService getInstance()

Get the tagging service instance

Returns:

get the tagging service instance

init

public void init()
          throws javax.jcr.nodetype.NoSuchNodeTypeException

Throws:

javax.jcr.nodetype.NoSuchNodeTypeException

initAfterAllServicesAreStarted

public void initAfterAllServicesAreStarted()
                                    throws JahiaInitializationException

Specified by:

initAfterAllServicesAreStarted in interface JahiaAfterInitializationService

Throws:

JahiaInitializationException

createTag

@Deprecated
public boolean createTag(String tag,
                                     String siteKey)
                              throws javax.jcr.RepositoryException

Deprecated. the tags are no longer nodes, there are stored directly on the content

Parameters:

tag - the tag to create

siteKey - the site where the tag need to be create

Returns:

true if the tag is successfully created

Throws:

javax.jcr.RepositoryException - in case of errors

deleteTag

@Deprecated
public boolean deleteTag(String tag,
                                     String siteKey)
                              throws javax.jcr.RepositoryException

Deprecated. not relevant anymore, the tags are no longer nodes

Parameters:

tag - the tag to delete

siteKey - the site where the tag need to be delete

Returns:

true if the tag is successfully deleted

Throws:

javax.jcr.RepositoryException - in case of errors

exists

@Deprecated
public boolean exists(String tag,
                                  String siteKey)
                           throws javax.jcr.RepositoryException

Deprecated. not relevant anymore, the tags are no longer nodes, there are stored directly on the content, Use #getTagsSuggester().suggest(String, String, Long, Long, Long, boolean, org.jahia.services.content.JCRSessionWrapper) instead

Parameters:

tag - the tag to test the existence

siteKey - the site where the tag need to be search

Returns:

true if the tag exist

Throws:

javax.jcr.RepositoryException - in case of errors

getTag

@Deprecated
public JCRNodeWrapper getTag(String tag,
                                         String siteKey,
                                         JCRSessionWrapper session)
                                  throws javax.jcr.RepositoryException

Deprecated. the tags are no longer nodes, there are stored directly on the content, Use #getTagsSuggester().suggest(String, String, Long, Long, Long, boolean, org.jahia.services.content.JCRSessionWrapper) instead

Parameters:

tag - the tag to retrieve

siteKey - the site to search the tag

session - the session used to retrieve the tag

Returns:

return the tag node, null in case of tag not found

Throws:

javax.jcr.RepositoryException - in case of errors

getTagCount

@Deprecated
public long getTagCount(String tag,
                                    String siteKey)
                             throws javax.jcr.RepositoryException

Deprecated. Use #getTagsSuggester().suggest(String, String, Long, Long, Long, boolean, org.jahia.services.content.JCRSessionWrapper) instead

Parameters:

tag - the tag to retrieve

siteKey - the site to search the tag

Returns:

the count

Throws:

javax.jcr.RepositoryException - in case of errors

tag

@Deprecated
public boolean tag(JCRNodeWrapper node,
                               String tag,
                               String siteKey,
                               boolean createTagIfNotExists)
                        throws javax.jcr.RepositoryException

Deprecated. Use tag(org.jahia.services.content.JCRNodeWrapper, String) instead

Parameters:

node - the node to tag

tag - the tag to apply on the node

siteKey - the site where the tag is locate

createTagIfNotExists - create the tag if not exist

Returns:

true if the tag is correctly apply on the node

Throws:

javax.jcr.RepositoryException - in case of errors

tag

@Deprecated
public boolean tag(String nodePath,
                               String tag,
                               String siteKey,
                               boolean createTagIfNotExists,
                               JCRSessionWrapper session)
                        throws javax.jcr.RepositoryException

Deprecated. Use tag(org.jahia.services.content.JCRNodeWrapper, String) instead

Parameters:

nodePath - the node to tag

tag - the tag to apply on the node

siteKey - the site where the tag is locate

createTagIfNotExists - create the tag if not exist

session - the session used to tag the content

Returns:

true if the tag is correctly apply on the node

Throws:

javax.jcr.RepositoryException - in case of errors

tag

@Deprecated
public boolean tag(String nodePath,
                               String tag,
                               String siteKey,
                               boolean createTagIfNotExists)
                        throws javax.jcr.RepositoryException

Deprecated. Use tag(org.jahia.services.content.JCRNodeWrapper, String) instead

Parameters:

nodePath - the node to tag

tag - the tag to apply on the node

siteKey - the site where the tag is locate

createTagIfNotExists - create the tag if not exist

Returns:

true if the tag is correctly apply on the node

Throws:

javax.jcr.RepositoryException - in case of errors

tag

public List<String> tag(JCRNodeWrapper node,
                        List<String> tags)
                 throws javax.jcr.RepositoryException

Tag the specific node

Parameters:

node - the node to tag

tags - the tag list to apply on the node

Returns:

the list of added tags

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

tag

public List<String> tag(String nodePath,
                        List<String> tags,
                        JCRSessionWrapper session)
                 throws javax.jcr.RepositoryException

Tag the specific node

Parameters:

nodePath - the path of the node to tag

tags - the tag list to apply on the node

session - the session used to perform the operation

Returns:

the list of added tags

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

tag

public List<String> tag(JCRNodeWrapper node,
                        String tag)
                 throws javax.jcr.RepositoryException

Tag the specific node

Parameters:

node - the node to tag

tag - the tag to apply on the node

Returns:

the list of added tags

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

tag

public List<String> tag(String nodePath,
                        String tag,
                        JCRSessionWrapper session)
                 throws javax.jcr.RepositoryException

Tag the specific node

Parameters:

nodePath - the path of the node to tag

tag - the tag to apply on the node

session - the session used to perform the operation

Returns:

the list of added tags

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

untag

public List<String> untag(JCRNodeWrapper node,
                          List<String> tags)
                   throws javax.jcr.RepositoryException

Untag the specific node

Parameters:

node - the node to untag

tags - the tag list to remove from the node

Returns:

the list of deleted tags

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

untag

public List<String> untag(String nodePath,
                          List<String> tags,
                          JCRSessionWrapper session)
                   throws javax.jcr.RepositoryException

Untag the specific node

Parameters:

nodePath - the path of the node to untag

tags - the tag list to remove from the node

session - the session used to perform the operation

Returns:

the list of deleted tags

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

untag

public List<String> untag(JCRNodeWrapper node,
                          String tag)
                   throws javax.jcr.RepositoryException

Untag the specific node

Parameters:

node - the node to untag

tag - the tag to remove from the node

Returns:

the list of deleted tags

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

untag

public List<String> untag(String nodePath,
                          String tag,
                          JCRSessionWrapper session)
                   throws javax.jcr.RepositoryException

Untag the specific node

Parameters:

nodePath - the path of the node to untag

tag - the tag to remove from the node

session - the session used to perform the operation

Returns:

the list of deleted tags

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

renameTag

public void renameTag(JCRNodeWrapper node,
                      String selectedTag,
                      String tagNewName)
               throws javax.jcr.RepositoryException

Rename a specific tag on a node

Parameters:

node - target node

selectedTag - tag to rename

tagNewName - new tag name

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

renameTag

public void renameTag(String nodePath,
                      String selectedTag,
                      String tagNewName,
                      JCRSessionWrapper session)
               throws javax.jcr.RepositoryException

Rename a specific tag on a node

Parameters:

nodePath - target node path

selectedTag - tag to rename

tagNewName - new tag name

session - the session used to perform the operation

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

renameTagUnderPath

public <X> X renameTagUnderPath(String startPath,
                                JCRSessionWrapper session,
                                String selectedTag,
                                String tagNewName,
                                TagActionCallback<X> callback)
                         throws javax.jcr.RepositoryException

Rename all occurrence of a specific tag under a given path The session will be saved each 100 nodes processed

Parameters:

startPath - the start path for the renaming

session - the session used to perform the operation

selectedTag - tag to rename

tagNewName - new tag name

callback - an optional callback can be used to hook on the actions processed

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

deleteTagUnderPath

public <X> X deleteTagUnderPath(String startPath,
                                JCRSessionWrapper session,
                                String selectedTag,
                                TagActionCallback<X> callback)
                         throws javax.jcr.RepositoryException

Delete all occurrence of a specific tag under a given path

Parameters:

startPath - the start path for the deleting

session - the session used to perform the operation

selectedTag - tag to delete

callback - an optional callback can be used to hook on the actions processed

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

setTagsSuggester

public void setTagsSuggester(TagsSuggester tagsSuggester)

getTagHandler

public TagHandler getTagHandler()

setTagHandler

public void setTagHandler(TagHandler tagHandler)

getTagsSuggester

public TagsSuggester getTagsSuggester()

start

public void start()
           throws JahiaInitializationException

Specified by:

start in class JahiaService

Throws:

JahiaInitializationException

stop

public void stop()
          throws JahiaException

Specified by:

stop in class JahiaService

Throws:

JahiaException