org.ametys.cms.tag

Class StaticTagProvider

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.tag.StaticTagProvider

All Implemented Interfaces:

TagProvider, PluginAware, Configurable, Contextualizable, LogEnabled, Serviceable

Direct Known Subclasses:

JCRTagProvider, SkinTagProvider

public class StaticTagProvider
extends AbstractLogEnabled
implements TagProvider, Contextualizable, Configurable, PluginAware, Serviceable

Class representing a static tag provider.

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	_context The context.
protected I18nizableText	_description The description
protected String	_featureName The feature name
protected String	_id The id
protected I18nizableText	_label The label
protected List<String>	_localIds List of statically defined ids
protected ServiceManager	_manager The service manager
protected String	_pluginName The plugin name
protected Map<String,Tag>	_tags The tags
protected TagTargetTypeExtensionPoint	_targetTypeEP Target types

Constructor Summary

Constructors

Constructor and Description
StaticTagProvider() Constructor

Method Summary

Modifier and Type	Method and Description
private Tag	_recursiveSearchTags(Map<String,Tag> tags, String tagID)
void	configure(Configuration configuration)
protected I18nizableText	configureDescription(Configuration configuration, String defaultCatalogue) Configure description from the passed configuration
protected I18nizableText	configureLabel(Configuration configuration, String defaultCatalogue) Configure label from the passed configuration
protected Map<String,Tag>	configureTags(Configuration configuration, Tag parent, String defaultCatalogue) Configure tag from the passed configuration
void	contextualize(Context context)
I18nizableText	getDescription() Returns the provider's description.
Map<String,Tag>	getFilteredTags(String targetType, Map<String,Object> contextualParameters) Returns the provider's tags filtered by target type
String	getId() Returns the provider's id.
I18nizableText	getLabel() Returns the provider's label.
List<String>	getLocalIds() Returns the list of statically defined ids
String	getPluginName() Get the plugin name
Tag	getTag(String tagID, Map<String,Object> contextualParameters) Returns the provider's tag.
Map<String,Tag>	getTags(Map<String,Object> contextualParameters) Returns the provider's tags.
Collection<Tag>	getTags(String tagID, Map<String,Object> contextualParameters) Returns the direct children of the provider's tag.
boolean	hasTag(String tagID, Map<String,Object> contextualParameters) Determines if the tag exists.
void	service(ServiceManager smanager)
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

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

_localIds

protected List<String> _localIds

List of statically defined ids

_pluginName

protected String _pluginName

The plugin name

_featureName

protected String _featureName

The feature name

_manager

protected ServiceManager _manager

The service manager

_context

protected Context _context

The context.

_id

protected String _id

The id

_label

protected I18nizableText _label

The label

_description

protected I18nizableText _description

The description

_tags

protected Map<String,Tag> _tags

The tags

_targetTypeEP

protected TagTargetTypeExtensionPoint _targetTypeEP

Target types

Constructor Detail

StaticTagProvider

public StaticTagProvider()

Constructor

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: TagProvider

Returns the provider's id.

Specified by:

getId in interface TagProvider

Returns:

the provider's id.

getLocalIds

public List<String> getLocalIds()

Returns the list of statically defined ids

Returns:

the list of statically defined ids

getLabel

public I18nizableText getLabel()

Description copied from interface: TagProvider

Returns the provider's label.

Specified by:

getLabel in interface TagProvider

Returns:

the provider's label.

getDescription

public I18nizableText getDescription()

Description copied from interface: TagProvider

Returns the provider's description.

Specified by:

getDescription in interface TagProvider

Returns:

the provider's description.

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

Parameters:

contextualParameters - contextual parameters

Returns:

the provider's tags.

getFilteredTags

public Map<String,Tag> getFilteredTags(String targetType,
                                       Map<String,Object> contextualParameters)

Description copied from interface: TagProvider

Returns the provider's tags filtered by target type

Specified by:

getFilteredTags in interface TagProvider

Parameters:

targetType - If not null, returns only tags matching this target type

contextualParameters - contextual parameters

Returns:

the provider's tags.

hasTag

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

Description copied from interface: TagProvider

Determines if the tag exists.

Specified by:

hasTag in interface TagProvider

Parameters:

tagID - The tag unique name

contextualParameters - contextual parameters

Returns:

true if the tag exists.

getTag

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

Description copied from interface: TagProvider

Returns the provider's tag.

Specified by:

getTag in interface TagProvider

Parameters:

tagID - The tag name

contextualParameters - contextual parameters

Returns:

the provider's tag.

_recursiveSearchTags

private Tag _recursiveSearchTags(Map<String,Tag> tags,
                                 String tagID)

getTags

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

Description copied from interface: TagProvider

Returns the direct children of the provider's tag.

Specified by:

getTags in interface TagProvider

Parameters:

tagID - The tag name

contextualParameters - contextual parameters

Returns:

the provider's tag.

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getPluginName

public String getPluginName()

Get the plugin name

Returns:

the plugin name

configureTags

protected Map<String,Tag> configureTags(Configuration configuration,
                                        Tag parent,
                                        String defaultCatalogue)
                                 throws ConfigurationException

Configure tag from the passed configuration

Parameters:

configuration - The configuration

parent - The parent tag if any

defaultCatalogue - The default catalogue for i18n

Returns:

a Set of Tag

Throws:

ConfigurationException - If an error occurred

configureLabel

protected I18nizableText configureLabel(Configuration configuration,
                                        String defaultCatalogue)
                                 throws ConfigurationException

Configure label from the passed configuration

Parameters:

configuration - The configuration

defaultCatalogue - The default catalogue

Returns:

The label

Throws:

ConfigurationException - If an error occurred

configureDescription

protected I18nizableText configureDescription(Configuration configuration,
                                              String defaultCatalogue)
                                       throws ConfigurationException

Configure description from the passed configuration

Parameters:

configuration - The configuration

defaultCatalogue - The default catalogue

Returns:

The description

Throws:

ConfigurationException - If an error occurred