Package org.ametys.web.filter
Class StaticWebContentFilter
- java.lang.Object
-
- org.ametys.cms.filter.DefaultContentFilter
-
- org.ametys.web.filter.DefaultWebContentFilter
-
- org.ametys.web.filter.StaticWebContentFilter
-
- All Implemented Interfaces:
ContentFilter
,PluginAware
,WebContentFilter
,Configurable
,Serviceable
- Direct Known Subclasses:
EventsFilter
public class StaticWebContentFilter extends DefaultWebContentFilter implements Configurable, PluginAware, Serviceable
This class represents a static filter for contents
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.ametys.web.filter.DefaultWebContentFilter
DefaultWebContentFilter.ContentComparator, DefaultWebContentFilter.DefaultFilterSearchContext
-
Nested classes/interfaces inherited from interface org.ametys.cms.filter.ContentFilter
ContentFilter.Condition, ContentFilter.ContextLanguage
-
Nested classes/interfaces inherited from interface org.ametys.web.filter.WebContentFilter
WebContentFilter.AccessLimitation, WebContentFilter.Context, WebContentFilter.FilterSearchContext
-
-
Field Summary
Fields Modifier and Type Field Description protected String
_featureName
The feature nameprotected String
_pluginName
The plugin name-
Fields inherited from class org.ametys.web.filter.DefaultWebContentFilter
_accessLimitation, _description, _logger, _maskOrphan, _searchContexts, _siteManager, _tagProviderEP, _title
-
Fields inherited from class org.ametys.cms.filter.DefaultContentFilter
_additionalFilterExpression, _contentTypeEP, _contentTypes, _contextLang, _id, _length, _metadata, _metadataCondition, _resolver, _sortCriteria, _srcResolver, _viewName
-
-
Constructor Summary
Constructors Constructor Description StaticWebContentFilter()
ConstructorStaticWebContentFilter(String id, AmetysObjectResolver resolver, ContentTypeExtensionPoint contentTypeExtensionPoint, SiteManager siteManager, TagProviderExtensionPoint tagProviderEP)
ConstructorStaticWebContentFilter(String id, StaticWebContentFilter originalFilter, AmetysObjectResolver resolver, ContentTypeExtensionPoint contentTypeExtensionPoint, SiteManager siteManager, TagProviderExtensionPoint tagProviderEP)
Creates a new filter from copy of another
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Expression
_configureComplexMetadata(Configuration configuration, ContentFilter.Condition metadataOperator)
Configure complex metadata conditions (may filter on non-string metadata, and not limited to equality.)protected List<String>
_configureContentTypes(Configuration configuration)
Configure the content type idsprotected WebContentFilter.Context
_configureContext(Configuration configuration)
Configure the context searchprotected ContentFilter.ContextLanguage
_configureContextLanguage(Configuration configuration)
Configure the context languageprotected int
_configureDepth(Configuration configuration)
Configure the depth searchprotected I18nizableText
_configureDescription(Configuration configuration)
Configure the filter's descriptionprotected Map<String,String>
_configureMetadata(Configuration configuration)
Configure simple metadata clauses (fixed string values).protected void
_configureSearchContexts(Configuration configuration)
Configure the search contexts.protected SortCriteria
_configureSortCriteria(Configuration configuration)
Configure the sort criteriaprotected I18nizableText
_configureTitle(Configuration configuration)
Configure the filter's titleprotected Expression
_getComplexDateExpression(String metadataName, String operator, String value, Configuration configuration)
Get a complex date metadata expression.void
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.DefaultWebContentFilter
addMetadata, addSearchContext, createSeachContext, getAccessLimitation, getContextLanguage, getDescription, getFilterExpression, getMatchingContents, getMatchingContents, getSearchContexts, getTitle, getXPathQuery, getXPathQuery, maskOrphanContents, setAccessLimitation, setContextLanguage, setDescription, setMaskOrphanContents, setTitle
-
Methods inherited from class org.ametys.cms.filter.DefaultContentFilter
addContentType, addSortCriteria, getAdditionalFilterExpression, getContentTypes, getContentTypesExpression, getContextLanguagesExpression, getFilterExpression, getId, getLength, getMatchingContents, getMatchingContents, getMetadataCondition, getMetadataExpression, getMetadataValues, getSortCriteria, getView, getXPathQuery, getXPathQuery, setAdditionalFilterExpression, setId, setLength, setMetadataCondition, setResolver, setView
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.ametys.cms.filter.ContentFilter
addContentType, addSortCriteria, getAdditionalFilterExpression, getContentTypes, getId, getLength, getMatchingContents, getMatchingContents, getMetadataCondition, getMetadataValues, getSortCriteria, getView, setAdditionalFilterExpression, setId, setLength, setMetadataCondition, setResolver, setView
-
-
-
-
Field Detail
-
_pluginName
protected String _pluginName
The plugin name
-
_featureName
protected String _featureName
The feature name
-
-
Constructor Detail
-
StaticWebContentFilter
public StaticWebContentFilter()
Constructor
-
StaticWebContentFilter
public StaticWebContentFilter(String id, AmetysObjectResolver resolver, ContentTypeExtensionPoint contentTypeExtensionPoint, SiteManager siteManager, TagProviderExtensionPoint tagProviderEP)
Constructor- Parameters:
id
- The filter idresolver
- The ametys object resolvercontentTypeExtensionPoint
- The extension point for content typessiteManager
- The site managertagProviderEP
- The tag provider
-
StaticWebContentFilter
public StaticWebContentFilter(String id, StaticWebContentFilter originalFilter, AmetysObjectResolver resolver, ContentTypeExtensionPoint contentTypeExtensionPoint, SiteManager siteManager, TagProviderExtensionPoint tagProviderEP)
Creates a new filter from copy of another- Parameters:
id
- The filter unique identifieroriginalFilter
- The original filter to be copiedresolver
- The ametys object resolvercontentTypeExtensionPoint
- The extension point for content typessiteManager
- The site managertagProviderEP
- The tag provider
-
-
Method Detail
-
service
public void service(ServiceManager smanager) throws ServiceException
- Specified by:
service
in interfaceServiceable
- Throws:
ServiceException
-
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 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
public void configure(Configuration configuration) throws ConfigurationException
- Specified by:
configure
in interfaceConfigurable
- Throws:
ConfigurationException
-
_configureTitle
protected I18nizableText _configureTitle(Configuration configuration) throws ConfigurationException
Configure the filter's title- Parameters:
configuration
- The title configuration- Returns:
- The filter's title
- Throws:
ConfigurationException
- If an error occurs
-
_configureDescription
protected I18nizableText _configureDescription(Configuration configuration) throws ConfigurationException
Configure the filter's description- Parameters:
configuration
- The description configuration- Returns:
- The filter's description
- Throws:
ConfigurationException
- If an error occurs
-
_configureContentTypes
protected List<String> _configureContentTypes(Configuration configuration) throws ConfigurationException
Configure the content type ids- Parameters:
configuration
- The content types configuration- Returns:
- The set of content type ids
- Throws:
ConfigurationException
- If an error occurs
-
_configureSearchContexts
protected void _configureSearchContexts(Configuration configuration) throws ConfigurationException
Configure the search contexts.- Parameters:
configuration
- the filter configuration.- Throws:
ConfigurationException
- if an error occurs.
-
_configureMetadata
protected Map<String,String> _configureMetadata(Configuration configuration) throws ConfigurationException
Configure simple metadata clauses (fixed string values).- Parameters:
configuration
- The metadata configuration- Returns:
- The metadata to filter by, as a Map of metadata name -> value.
- Throws:
ConfigurationException
- If an error occurs
-
_configureComplexMetadata
protected Expression _configureComplexMetadata(Configuration configuration, ContentFilter.Condition metadataOperator) throws ConfigurationException
Configure complex metadata conditions (may filter on non-string metadata, and not limited to equality.)- Parameters:
configuration
- The metadata conditions configuration.metadataOperator
- the metadata operator.- Returns:
- An expression for complex metadata conditions.
- Throws:
ConfigurationException
- If an error occurs
-
_getComplexDateExpression
protected Expression _getComplexDateExpression(String metadataName, String operator, String value, Configuration configuration) throws ConfigurationException
Get a complex date metadata expression.- Parameters:
metadataName
- the metadata name.operator
- the comparison operator.value
- the compared value.configuration
- the configuration being processed.- Returns:
- the date Expression.
- Throws:
ConfigurationException
- if the configuration is not valid.
-
_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 WebContentFilter.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 ContentFilter.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
protected int _configureDepth(Configuration configuration) throws ConfigurationException
Configure the depth search- Parameters:
configuration
- The depth configuration- Returns:
- The depth
- Throws:
ConfigurationException
- If an error occurs
-
-