org.ametys.cms.tag.jcr

Class JCRTagProvider

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.tag.StaticTagProvider

org.ametys.cms.tag.jcr.JCRTagProvider

All Implemented Interfaces:

TagProvider, PluginAware, Configurable, Contextualizable, LogEnabled, Serviceable

Direct Known Subclasses:

JCRTagProvider

public class JCRTagProvider
extends StaticTagProvider

Class representing a jcr tag provider.

Field Summary

Fields

Modifier and Type	Field and Description
protected AmetysObjectResolver	_resolver The Ametys object resolver
protected static String	CACHE_REQUEST_ATTRIBUTE The request attribute name with cache information
static String	PLUGIN_NODE_NAME Constant for plugin node name
static String	TAGS_NODENAME JCR node name for tags
static String	TAGS_NODETYPE JCR nodetype for tags

Fields inherited from class org.ametys.cms.tag.StaticTagProvider

_context, _description, _featureName, _id, _label, _localIds, _manager, _pluginName, _tags, _targetTypeEP

Constructor Summary

Constructors

Constructor and Description
JCRTagProvider()

Method Summary

Modifier and Type	Method and Description
protected void	_fillCache(TraversableAmetysObject parentTagNode, Tag parentTag, Map<String,Object> cache) Fill cache
protected Map<String,Object>	_getCache(Map<String,Object> contextualParameters) Get the Map of tags by their unique name
protected ModifiableTraversableAmetysObject	_getOrCreateNode(ModifiableTraversableAmetysObject parentNode, String nodeName, String nodeType) Get a node or create it if not exist.
void	configure(Configuration configuration)
ModifiableTraversableAmetysObject	getRootNode(Map<String,Object> contextualParameters) Get the root node for tags
Tag	getTag(String tagName, Map<String,Object> contextualParameters) Returns the provider's tag.
Map<String,Tag>	getTags(Map<String,Object> contextualParameters) Returns the provider's tags.
static String	getXPathQuery(String tagName) Creates the XPath query corresponding to specified tag name
boolean	hasTag(String tagName, Map<String,Object> contextualParameters) Determines if the tag exists.
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.cms.tag.StaticTagProvider

configureDescription, configureLabel, configureTags, contextualize, getDescription, getFilteredTags, getId, getLabel, getLocalIds, getPluginName, getTags, setPluginInfo

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 Detail

PLUGIN_NODE_NAME

public static final String PLUGIN_NODE_NAME

Constant for plugin node name

See Also:

Constant Field Values

TAGS_NODETYPE

public static final String TAGS_NODETYPE

JCR nodetype for tags

See Also:

Constant Field Values

TAGS_NODENAME

public static final String TAGS_NODENAME

JCR node name for tags

See Also:

Constant Field Values

CACHE_REQUEST_ATTRIBUTE

protected static final String CACHE_REQUEST_ATTRIBUTE

The request attribute name with cache information

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

Constructor Detail

JCRTagProvider

public JCRTagProvider()

Method Detail

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class StaticTagProvider

Throws:

ConfigurationException

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticTagProvider

Throws:

ServiceException

_getCache

protected Map<String,Object> _getCache(Map<String,Object> contextualParameters)
                                throws RepositoryException

Get the Map of tags by their unique name

Parameters:

contextualParameters - The contextual parameters

Returns:

The non null cache

Throws:

RepositoryException - If the cache cannot be filled

_fillCache

protected void _fillCache(TraversableAmetysObject parentTagNode,
                          Tag parentTag,
                          Map<String,Object> cache)
                   throws RepositoryException

Fill cache

Parameters:

parentTagNode - The parent tag node

parentTag - The parent tag

cache - The cache

Throws:

RepositoryException - If an error occurred

getTags

public Map<String,Tag> getTags(Map<String,Object> contextualParameters)

Description copied from interface: TagProvider

Returns the provider's tags.

Specified by:

getTags in interface TagProvider

Overrides:

getTags in class StaticTagProvider

Parameters:

contextualParameters - contextual parameters

Returns:

the provider's tags.

hasTag

public boolean hasTag(String tagName,
                      Map<String,Object> contextualParameters)

Description copied from interface: TagProvider

Determines if the tag exists.

Specified by:

hasTag in interface TagProvider

Overrides:

hasTag in class StaticTagProvider

Parameters:

tagName - The tag unique name

contextualParameters - contextual parameters

Returns:

true if the tag exists.

getTag

public Tag getTag(String tagName,
                  Map<String,Object> contextualParameters)

Description copied from interface: TagProvider

Returns the provider's tag.

Specified by:

getTag in interface TagProvider

Overrides:

getTag in class StaticTagProvider

Parameters:

tagName - The tag name

contextualParameters - contextual parameters

Returns:

the provider's tag.

getRootNode

public ModifiableTraversableAmetysObject getRootNode(Map<String,Object> contextualParameters)
                                              throws RepositoryException

Get the root node for tags

Parameters:

contextualParameters - The contextual parameters

Returns:

The root node

Throws:

RepositoryException - if an error occurred

_getOrCreateNode

protected ModifiableTraversableAmetysObject _getOrCreateNode(ModifiableTraversableAmetysObject parentNode,
                                                             String nodeName,
                                                             String nodeType)
                                                      throws AmetysRepositoryException

Get a node or create it if not exist.

Parameters:

parentNode - the parent node

nodeName - the node name

nodeType - the node type

Returns:

the node

Throws:

AmetysRepositoryException - if an error occurred

getXPathQuery

public static String getXPathQuery(String tagName)

Creates the XPath query corresponding to specified tag name

Parameters:

tagName - the tag name

Returns:

the created XPath query