Package org.ametys.web.filter
Class StaticPageFilter
java.lang.Object
org.ametys.web.filter.DefaultPageFilter
org.ametys.web.filter.StaticPageFilter
- All Implemented Interfaces:
PluginAware
,PageFilter
,Configurable
,Serviceable
public class StaticPageFilter
extends DefaultPageFilter
implements Configurable, PluginAware, Serviceable
This class represents a static filter for pages
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.ametys.web.filter.PageFilter
PageFilter.Context, PageFilter.ContextLanguage
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
The feature nameprotected String
The plugin nameFields inherited from class org.ametys.web.filter.DefaultPageFilter
_context, _contextLang, _depth, _id, _length, _logger, _metadata, _pageId, _resolver, _sortCriteria, _tags, _title
-
Constructor Summary
ConstructorDescriptionEmpty constructorStaticPageFilter
(String id, AmetysObjectResolver resolver) Constructor -
Method Summary
Modifier and TypeMethodDescriptionprotected PageFilter.Context
_configureContext
(Configuration configuration) Configure the context searchprotected PageFilter.ContextLanguage
_configureContextLanguage
(Configuration configuration) Configure the context languageprotected int
_configureDepth
(Configuration configuration) Configure the depth search_configureMetadata
(Configuration configuration) Configure the metadataprotected SortCriteria
_configureSortCriteria
(Configuration configuration) Configure the sort criteria_configureTags
(Configuration configuration) Configure the tag keysvoid
configure
(Configuration configuration) 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.ametys.web.filter.DefaultPageFilter
addMetadata, addSortCriteria, addTag, getContext, getContextExpression, getContextLanguage, getContextLanguagesExpression, getDepth, getFilterExpression, getId, getLength, getMatchingPages, getMetadataExpression, getMetadataValues, getPageId, getSortCriteria, getTags, getTagsExpression, getTitle, getXPathQuery, getXPathQuery, setContext, setContextLanguage, setDepth, setId, setLength, setPageId, setResolver, setTitle
-
Field Details
-
_pluginName
The plugin name -
_featureName
The feature name
-
-
Constructor Details
-
StaticPageFilter
public StaticPageFilter()Empty constructor -
StaticPageFilter
Constructor- Parameters:
id
- The filter idresolver
- The ametys object resolver
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Throws:
ServiceException
-
setPluginInfo
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 interfacePluginAware
- Parameters:
pluginName
- Unique identifier for the plugin hosting the extensionfeatureName
- Unique feature identifier (unique for a given pluginName)id
- Unique identifier of this component
-
configure
- Specified by:
configure
in interfaceConfigurable
- Throws:
ConfigurationException
-
_configureTags
Configure the tag keys- Parameters:
configuration
- The tags configuration- Returns:
- The set of tag keys
- Throws:
ConfigurationException
- If an error occurs
-
_configureMetadata
protected Map<String,String> _configureMetadata(Configuration configuration) throws ConfigurationException Configure the metadata- Parameters:
configuration
- The metadata configuration- Returns:
- The metadata to filter by
- Throws:
ConfigurationException
- If an error occurs
-
_configureSortCriteria
protected SortCriteria _configureSortCriteria(Configuration configuration) throws ConfigurationException Configure the sort criteria- Parameters:
configuration
- The sort criteria configuration- Returns:
- The sort criteria
- Throws:
ConfigurationException
- If an error occurs
-
_configureContext
protected PageFilter.Context _configureContext(Configuration configuration) throws ConfigurationException Configure the context search- Parameters:
configuration
- The context configuration- Returns:
- The search context
- Throws:
ConfigurationException
- If an error occurs
-
_configureContextLanguage
protected PageFilter.ContextLanguage _configureContextLanguage(Configuration configuration) throws ConfigurationException Configure the context language- Parameters:
configuration
- The context configuration- Returns:
- The context language
- Throws:
ConfigurationException
- If an error occurs
-
_configureDepth
Configure the depth search- Parameters:
configuration
- The depth configuration- Returns:
- The depth
- Throws:
ConfigurationException
- If an error occurs
-