Package org.ametys.web.sitemap

Class DefaultSitemapIndicator

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.sitemap.AbstractStaticSitemapIndicator

org.ametys.web.sitemap.DefaultSitemapIndicator

All Implemented Interfaces:

LogEnabled, PluginAware, Prioritizable, SitemapTreeIndicator, Configurable, Contextualizable, Serviceable

public class DefaultSitemapIndicator
extends AbstractStaticSitemapIndicator
implements Serviceable, Contextualizable

Default implementation of SitemapTreeIndicator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DefaultSitemapIndicator.Condition	The tag condition.

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected RightManager	_rightManager	The right manager

Constructor Summary

Constructors

Constructor	Description
DefaultSitemapIndicator()

Method Summary

Modifier and Type	Method	Description
void	configure(String id, Configuration configuration, String defaultI18nCatalog, String iconPathPrefix)	Configure sitemap indicator
void	contextualize(Context context)
Map<String,String>	getMetadata()	Get metadata
DefaultSitemapIndicator.Condition	getMetadataCondition()	Get the metadata condition
Page.PageType	getPageType()	The page type
Map<String,String>	getProperties()	Get properties
DefaultSitemapIndicator.Condition	getPropertiesCondition()	Get the metadata condition
List<String>	getTags()	The tags
DefaultSitemapIndicator.Condition	getTagsCondition()	The tags condition
boolean	isLive()	Determines the live version
boolean	isRestricted()	Determines the limited access
boolean	matches(SitemapElement sitemapElement)	Check if the sitemap element matches the indicator's conditions
static DefaultSitemapIndicator	newInstance(String id, Configuration configuration, ServiceManager manager, Context context, String defaultI18nCatalog, String iconPathPrefix)	Create a new instance of DefaultSitemapIndicator
void	service(ServiceManager manager)

Methods inherited from class org.ametys.web.sitemap.AbstractStaticSitemapIndicator

configure, getIcon, getIconDecorator, getIconGlyph, getId, getLabel, getPriority, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_rightManager

protected RightManager _rightManager

The right manager

Constructor Details

DefaultSitemapIndicator

public DefaultSitemapIndicator()

Method Details

service

public void service(ServiceManager manager)
             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

newInstance

public static DefaultSitemapIndicator newInstance(String id,
 Configuration configuration,
 ServiceManager manager,
 Context context,
 String defaultI18nCatalog,
 String iconPathPrefix)
                                           throws ServiceException,
ConfigurationException,
ContextException

Create a new instance of DefaultSitemapIndicator

Parameters:

id - the unique id

configuration - the configuration

manager - the service manager

context - the avalon context

defaultI18nCatalog - the default i18n catalogue

iconPathPrefix - the prefix path for icon

Returns:

the sitemap indicator

Throws:

ServiceException - if an error occured while loading components

ConfigurationException - if configuraion failed

ContextException - if fail to initialize context

configure

public void configure(String id,
 Configuration configuration,
 String defaultI18nCatalog,
 String iconPathPrefix)
               throws ConfigurationException

Description copied from class: AbstractStaticSitemapIndicator

Configure sitemap indicator

Overrides:

configure in class AbstractStaticSitemapIndicator

Parameters:

id - the unique id. Can be null to get id from configuration

configuration - the configuration

defaultI18nCatalog - the default i18n catalogue

iconPathPrefix - the prefix path for icon

Throws:

ConfigurationException - if configuration is invalid

matches

public boolean matches(SitemapElement sitemapElement)

Description copied from interface: SitemapTreeIndicator

Check if the sitemap element matches the indicator's conditions

Specified by:

matches in interface SitemapTreeIndicator

Parameters:

sitemapElement - the sitemap element to check

Returns:

true if the element matches the indicator

getMetadataCondition

public DefaultSitemapIndicator.Condition getMetadataCondition()

Get the metadata condition

Returns:

the metadata condition

getTagsCondition

public DefaultSitemapIndicator.Condition getTagsCondition()

The tags condition

Returns:

The tags condition

getPropertiesCondition

public DefaultSitemapIndicator.Condition getPropertiesCondition()

Get the metadata condition

Returns:

the metadata condition

getTags

public List<String> getTags()

The tags

Returns:

The tags

getPageType

public Page.PageType getPageType()

The page type

Returns:

The page type

isLive

public boolean isLive()

Determines the live version

Returns:

true if this icon is for live version

isRestricted

public boolean isRestricted()

Determines the limited access

Returns:

true if this icon is for page with limited access

getMetadata

public Map<String,String> getMetadata()

Get metadata

Returns:

the metadata

getProperties

public Map<String,String> getProperties()

Get properties

Returns:

the properties