Package org.ametys.cms.tag
Class StaticTagProvider
- All Implemented Interfaces:
TagProvider<CMSTag>
,PluginAware
,Configurable
,LogEnabled
,Serviceable
- Direct Known Subclasses:
SkinTagProvider
Class representing a static tag provider.
-
Field Summary
Modifier and TypeFieldDescriptionList of statically defined idsThe tagsprotected TagTargetTypeExtensionPoint
Target typesFields inherited from class org.ametys.cms.tag.AbstractTagProvider
_description, _featureName, _id, _label, _pluginName
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(Configuration configuration) configureTags
(Configuration configuration, CMSTag parent, String defaultCatalogue) Configure tag from the passed configurationReturns the list of statically defined idsReturns the provider's tag.Returns the direct children of the provider's tag.Returns the provider's tags.boolean
Determines if the tag exists.void
service
(ServiceManager smanager) Methods inherited from class org.ametys.cms.tag.AbstractTagProvider
configureDescription, configureLabel, getDescription, getId, getLabel, getPluginName, setPluginInfo
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
-
Field Details
-
_localIds
List of statically defined ids -
_tags
The tags -
_targetTypeEP
Target types
-
-
Constructor Details
-
StaticTagProvider
public StaticTagProvider()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Throws:
ServiceException
-
configure
- Specified by:
configure
in interfaceConfigurable
- Overrides:
configure
in classAbstractTagProvider<CMSTag>
- Throws:
ConfigurationException
-
getLocalIds
Returns the list of statically defined ids- Returns:
- the list of statically defined ids
-
getTags
Description copied from interface:TagProvider
Returns the provider's tags.- Specified by:
getTags
in interfaceTagProvider<CMSTag>
- Parameters:
contextualParameters
- contextual parameters- Returns:
- the provider's tags.
-
hasTag
Description copied from interface:TagProvider
Determines if the tag exists.- Specified by:
hasTag
in interfaceTagProvider<CMSTag>
- Parameters:
tagID
- The tag unique namecontextualParameters
- contextual parameters- Returns:
- true if the tag exists.
-
getTag
Description copied from interface:TagProvider
Returns the provider's tag.- Specified by:
getTag
in interfaceTagProvider<CMSTag>
- Parameters:
tagID
- The tag namecontextualParameters
- contextual parameters- Returns:
- the provider's tag.
-
getTags
Description copied from interface:TagProvider
Returns the direct children of the provider's tag.- Specified by:
getTags
in interfaceTagProvider<CMSTag>
- Parameters:
tagID
- The tag namecontextualParameters
- contextual parameters- Returns:
- the provider's tag.
-
configureTags
protected Map<String,CMSTag> configureTags(Configuration configuration, CMSTag parent, String defaultCatalogue) throws ConfigurationException Configure tag from the passed configuration- Parameters:
configuration
- The configurationparent
- The parent tag if anydefaultCatalogue
- The default catalogue for i18n- Returns:
- a Set of
Tag
- Throws:
ConfigurationException
- If an error occurred
-