public class StaticContentFilter extends DefaultContentFilter implements Configurable, PluginAware, Serviceable
Modifier and Type | Class and Description |
---|---|
static class |
StaticContentFilter.DynamicDateExpression
Constructs an
Expression representing a comparison between a metadata and the time the build() method is called. |
ContentFilter.Condition, ContentFilter.ContextLanguage
Modifier and Type | Field and Description |
---|---|
protected String |
_featureName
The feature name
|
protected String |
_pluginName
The plugin name
|
_additionalFilterExpression, _contentTypeEP, _contentTypes, _contextLang, _id, _length, _metadata, _metadataCondition, _metadataSetName, _resolver, _sortCriteria, _srcResolver
Constructor and Description |
---|
StaticContentFilter()
Constructor
|
StaticContentFilter(String id,
AmetysObjectResolver resolver,
ContentTypeExtensionPoint contentTypeExtensionPoint)
Constructor
|
Modifier and Type | Method and 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 ids
|
protected ContentFilter.ContextLanguage |
_configureContextLanguage(Configuration configuration)
Configure the context language
|
protected Map<String,String> |
_configureMetadata(Configuration configuration)
Configure simple metadata clauses (fixed string values).
|
protected SortCriteria |
_configureSortCriteria(Configuration configuration)
Configure the sort criteria
|
protected 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. |
addContentType, addMetadata, addSortCriteria, getAdditionalFilterExpression, getContentTypes, getContentTypesExpression, getContextLanguage, getContextLanguagesExpression, getFilterExpression, getId, getLength, getMatchingContents, getMatchingContents, getMetadataCondition, getMetadataExpression, getMetadataValues, getSortCriteria, getView, getXPathQuery, getXPathQuery, setAdditionalFilterExpression, setContextLanguage, setId, setLength, setMetadataCondition, setResolver, setView
protected String _pluginName
protected String _featureName
public StaticContentFilter()
public StaticContentFilter(String id, AmetysObjectResolver resolver, ContentTypeExtensionPoint contentTypeExtensionPoint)
id
- The filter idresolver
- The ametys object resolvercontentTypeExtensionPoint
- The extension point for content typespublic void service(ServiceManager smanager) throws ServiceException
service
in interface Serviceable
ServiceException
public void setPluginInfo(String pluginName, String featureName, String id)
PluginAware
setPluginInfo
in interface PluginAware
pluginName
- Unique identifier for the plugin hosting the extensionfeatureName
- Unique feature identifier (unique for a given pluginName)id
- Unique identifier of this componentpublic void configure(Configuration configuration) throws ConfigurationException
configure
in interface Configurable
ConfigurationException
protected List<String> _configureContentTypes(Configuration configuration) throws ConfigurationException
configuration
- The content types configurationConfigurationException
- If an error occursprotected Map<String,String> _configureMetadata(Configuration configuration) throws ConfigurationException
configuration
- The metadata configurationConfigurationException
- If an error occursprotected Expression _configureComplexMetadata(Configuration configuration, ContentFilter.Condition metadataOperator) throws ConfigurationException
configuration
- The metadata conditions configuration.metadataOperator
- the metadata operator.ConfigurationException
- If an error occursprotected Expression _getComplexDateExpression(String metadataName, String operator, String value, Configuration configuration) throws ConfigurationException
metadataName
- the metadata name.operator
- the comparison operator.value
- the compared value.configuration
- the configuration being processed.ConfigurationException
- if the configuration is not valid.protected SortCriteria _configureSortCriteria(Configuration configuration) throws ConfigurationException
configuration
- The sort criteria configurationConfigurationException
- If an error occursprotected ContentFilter.ContextLanguage _configureContextLanguage(Configuration configuration) throws ConfigurationException
configuration
- The context configurationConfigurationException
- If an error occurs