Package org.ametys.plugins.workspaces.keywords

Class KeywordJCRDAO

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.tag.jcr.AbstractJCRTagsDAO

org.ametys.plugins.workspaces.keywords.KeywordJCRDAO

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class KeywordJCRDAO
extends AbstractJCRTagsDAO

Component for operations on JCR categories

Field Summary

Fields

Modifier and Type	Field	Description
protected RightManager	_rightManager	The rights manager
protected KeywordProviderExtensionPoint	_tagProviderExtPt	The tag provider extension point
static final String	ROLE	The Avalon role

Fields inherited from class org.ametys.cms.tag.jcr.AbstractJCRTagsDAO

_currentUserProvider, _observationManager, _resolver

Constructor Summary

Constructors

Constructor	Description
KeywordJCRDAO()

Method Summary

Modifier and Type	Method	Description
protected void	_checkUserRight()	Check if the user right to access the feature
protected JCRTag	_createJCRTag(String parentId, String name, String title, String description, Map<String,Object> otherParameters, Map<String,Object> contextualParameters)	Create a JCR tag under his parent
protected Tag	_getTagFromName(String name, Map<String,Object> contextualParameters)	Get the tag from the name
protected Set<TagProvider<? extends Tag>>	_getTagProviders()	Get all tag's providers
ModifiableTraversableAmetysObject	_getTagRootObject(String tagProviderId, Map<String,Object> contextualParameters)	Get the tag root node object
protected JCRTag	_updateJCRTag(String tagId, String title, String description, Map<String,Object> otherParameters)	Update a JCR tag
Map<String,Object>	getTag(String tagId)	Find a JCR tag and return its data
Map<String,Object>	getTagRootNode(String tagProviderId, Map<String,Object> contextualParameters)	Get the root node for tags
void	service(ServiceManager serviceManager)

Methods inherited from class org.ametys.cms.tag.jcr.AbstractJCRTagsDAO

_findUniqueName, _hasTag, addTag, createTag, deleteTag, moveTags, updateTag

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The Avalon role

_tagProviderExtPt

protected KeywordProviderExtensionPoint _tagProviderExtPt

The tag provider extension point

_rightManager

protected RightManager _rightManager

The rights manager

Constructor Details

KeywordJCRDAO

public KeywordJCRDAO()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractJCRTagsDAO

Throws:

ServiceException

_getTagRootObject

public ModifiableTraversableAmetysObject _getTagRootObject(String tagProviderId,
 Map<String,Object> contextualParameters)
                                                    throws javax.jcr.RepositoryException

Description copied from class: AbstractJCRTagsDAO

Get the tag root node object

Specified by:

_getTagRootObject in class AbstractJCRTagsDAO

Parameters:

tagProviderId - The tag provider id

contextualParameters - Contextual parameters transmitted by the environment.

Returns:

The tag root node object

Throws:

javax.jcr.RepositoryException - If an error occurred in the repository

_checkUserRight

protected void _checkUserRight()
                        throws IllegalStateException

Description copied from class: AbstractJCRTagsDAO

Check if the user right to access the feature

Specified by:

_checkUserRight in class AbstractJCRTagsDAO

Throws:

IllegalStateException - if the user has no right

_getTagFromName

protected Tag _getTagFromName(String name,
 Map<String,Object> contextualParameters)

Description copied from class: AbstractJCRTagsDAO

Get the tag from the name

Specified by:

_getTagFromName in class AbstractJCRTagsDAO

Parameters:

name - the name

contextualParameters - the contextual parameters

Returns:

the tag

_createJCRTag

protected JCRTag _createJCRTag(String parentId,
 String name,
 String title,
 String description,
 Map<String,Object> otherParameters,
 Map<String,Object> contextualParameters)
                        throws javax.jcr.RepositoryException

Description copied from class: AbstractJCRTagsDAO

Create a JCR tag under his parent

Specified by:

_createJCRTag in class AbstractJCRTagsDAO

Parameters:

parentId - the parent id

name - the name

title - the title

description - the description

otherParameters - the other parameters

contextualParameters - Contextual parameters transmitted by the environment.

Returns:

the created JCR tag

Throws:

javax.jcr.RepositoryException - if an error occurred

_updateJCRTag

protected JCRTag _updateJCRTag(String tagId,
 String title,
 String description,
 Map<String,Object> otherParameters)
                        throws UnknownAmetysObjectException

Description copied from class: AbstractJCRTagsDAO

Update a JCR tag

Specified by:

_updateJCRTag in class AbstractJCRTagsDAO

Parameters:

tagId - the tag id to update

title - the title

description - the description

otherParameters - the other parameters

Returns:

return the updated JCR tag

Throws:

UnknownAmetysObjectException - if an error occurred

_getTagProviders

protected Set<TagProvider<? extends Tag>> _getTagProviders()

Description copied from class: AbstractJCRTagsDAO

Get all tag's providers

Specified by:

_getTagProviders in class AbstractJCRTagsDAO

Returns:

the providers

getTagRootNode

public Map<String,Object> getTagRootNode(String tagProviderId,
 Map<String,Object> contextualParameters)
                                  throws ProcessingException

Description copied from class: AbstractJCRTagsDAO

Get the root node for tags

Overrides:

getTagRootNode in class AbstractJCRTagsDAO

Parameters:

tagProviderId - The tag provider id

contextualParameters - Contextual parameters transmitted by the environment.

Returns:

The root node in key "id"

Throws:

ProcessingException - If an error occurred in the repository

getTag

public Map<String,Object> getTag(String tagId)

Description copied from class: AbstractJCRTagsDAO

Find a JCR tag and return its data

Overrides:

getTag in class AbstractJCRTagsDAO

Parameters:

tagId - The tag's id

Returns:

The result map