org.ametys.cms.filter

Class DefaultContentFilter

java.lang.Object

org.ametys.cms.filter.DefaultContentFilter

All Implemented Interfaces:

ContentFilter

Direct Known Subclasses:

DefaultWebContentFilter, StaticContentFilter

public class DefaultContentFilter
extends Object
implements ContentFilter

This is the default implementation of a ContentFilter. The filter's property are set by setter function and constructor

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.filter.ContentFilter

ContentFilter.Condition, ContentFilter.ContextLanguage

Field Summary

Fields

Modifier and Type	Field and Description
protected Expression	_additionalFilterExpression The additional expression
protected ContentTypeExtensionPoint	_contentTypeEP The extension point for content types
protected List<String>	_contentTypes The list of content types to match
protected ContentFilter.ContextLanguage	_contextLang The list of content languages to match
protected String	_id The filter id
protected int	_length The number max of results
protected Map<String,String>	_metadata The metadata to match
protected ContentFilter.Condition	_metadataCondition The metadata condition
protected String	_metadataSetName The view
protected AmetysObjectResolver	_resolver The Ametys object resolver
protected SortCriteria	_sortCriteria The sort criteria
protected SourceResolver	_srcResolver The source resolver

Constructor Summary

Constructors

Constructor and Description
DefaultContentFilter() Constructor
DefaultContentFilter(String id, AmetysObjectResolver resolver, ContentTypeExtensionPoint contentTypeExtensionPoint) Creates a new filter
DefaultContentFilter(String id, DefaultContentFilter originalFilter, AmetysObjectResolver resolver, ContentTypeExtensionPoint contentTypeExtensionPoint) Creates a new filter from copy of another

Method Summary

Modifier and Type	Method and Description
void	addContentType(String cTypeId) Add a content type to the filter
void	addMetadata(String metadataId, String value) Add a metadata filter
void	addSortCriteria(String metadataId, boolean ascending, boolean useLowerCase) Add a sort criteria
Expression	getAdditionalFilterExpression() Get the current filter expression
List<String>	getContentTypes() Get the content types to match contents
protected Expression	getContentTypesExpression() Get the expression corresponding to the filter's content types
ContentFilter.ContextLanguage	getContextLanguage() Get the context language
protected Expression	getContextLanguagesExpression(String lang) Get the Expression associated with the given language context
protected Expression	getFilterExpression() Get the expression corresponding to this filter
String	getId() Get the filter id
int	getLength() Get the max number of results
AmetysObjectIterable<Content>	getMatchingContents() Get the contents matching this filter.
AmetysObjectIterable<Content>	getMatchingContents(String lang) Get the contents matching this filter.
ContentFilter.Condition	getMetadataCondition() The metadata condition
protected Expression	getMetadataExpression() Get the expression corresponding to the filter's tags
Map<String,String>	getMetadataValues() Get the content types to match contents
SortCriteria	getSortCriteria() Get the sort criteria allows to sort query results.
String	getView() Get the name of MetadataSet used for matching contents
String	getXPathQuery() Creates the XPath query corresponding to this filter.
String	getXPathQuery(String lang) Creates the XPath query corresponding to this filter.
void	setAdditionalFilterExpression(Expression expression) Set the filter expression that should complete metadata filtering (by doing an AND between both)
void	setContextLanguage(ContentFilter.ContextLanguage context) Set the context language
void	setId(String id) Set the filter id.
void	setLength(int length) Set the max number o results
void	setMetadataCondition(ContentFilter.Condition condition) Set the metadata condition
void	setResolver(AmetysObjectResolver resolver) Set the ametys object resolver to execute query
void	setView(String metadataSetName) Set the filter view

Methods inherited from class java.lang.Object

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

Field Detail

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_srcResolver

protected SourceResolver _srcResolver

The source resolver

_id

protected String _id

The filter id

_contentTypes

protected List<String> _contentTypes

The list of content types to match

_contextLang

protected ContentFilter.ContextLanguage _contextLang

The list of content languages to match

_metadata

protected Map<String,String> _metadata

The metadata to match

_metadataCondition

protected ContentFilter.Condition _metadataCondition

The metadata condition

_length

protected int _length

The number max of results

_metadataSetName

protected String _metadataSetName

The view

_sortCriteria

protected SortCriteria _sortCriteria

The sort criteria

_additionalFilterExpression

protected Expression _additionalFilterExpression

The additional expression

_contentTypeEP

protected ContentTypeExtensionPoint _contentTypeEP

The extension point for content types

Constructor Detail

DefaultContentFilter

public DefaultContentFilter()

Constructor

DefaultContentFilter

public DefaultContentFilter(String id,
                            AmetysObjectResolver resolver,
                            ContentTypeExtensionPoint contentTypeExtensionPoint)

Creates a new filter

Parameters:

id - The filter unique identifier

resolver - The ametys object resolver

contentTypeExtensionPoint - The extension point for content types

DefaultContentFilter

public DefaultContentFilter(String id,
                            DefaultContentFilter originalFilter,
                            AmetysObjectResolver resolver,
                            ContentTypeExtensionPoint contentTypeExtensionPoint)

Creates a new filter from copy of another

Parameters:

id - The filter unique identifier

originalFilter - The original filter to be copied

resolver - The ametys object resolver

contentTypeExtensionPoint - The extension point for content types

Method Detail

getContentTypes

public List<String> getContentTypes()

Description copied from interface: ContentFilter

Get the content types to match contents

Specified by:

getContentTypes in interface ContentFilter

Returns:

The content types to match contents

getMetadataValues

public Map<String,String> getMetadataValues()

Description copied from interface: ContentFilter

Get the content types to match contents

Specified by:

getMetadataValues in interface ContentFilter

Returns:

The content types to match contents

getMetadataCondition

public ContentFilter.Condition getMetadataCondition()

Description copied from interface: ContentFilter

The metadata condition

Specified by:

getMetadataCondition in interface ContentFilter

Returns:

The metadata condition

getContextLanguage

public ContentFilter.ContextLanguage getContextLanguage()

Description copied from interface: ContentFilter

Get the context language

Specified by:

getContextLanguage in interface ContentFilter

Returns:

The context language

getId

public String getId()

Description copied from interface: ContentFilter

Get the filter id

Specified by:

getId in interface ContentFilter

Returns:

The filter id

getLength

public int getLength()

Description copied from interface: ContentFilter

Get the max number of results

Specified by:

getLength in interface ContentFilter

Returns:

The max number of results

getView

public String getView()

Description copied from interface: ContentFilter

Get the name of MetadataSet used for matching contents

Specified by:

getView in interface ContentFilter

Returns:

The name of MetadataSet used for matching contents

getSortCriteria

public SortCriteria getSortCriteria()

Description copied from interface: ContentFilter

Get the sort criteria allows to sort query results.

Specified by:

getSortCriteria in interface ContentFilter

Returns:

the sort criteria

addContentType

public void addContentType(String cTypeId)

Description copied from interface: ContentFilter

Add a content type to the filter

Specified by:

addContentType in interface ContentFilter

Parameters:

cTypeId - The content type id to add

addMetadata

public void addMetadata(String metadataId,
                        String value)

Description copied from interface: ContentFilter

Add a metadata filter

Specified by:

addMetadata in interface ContentFilter

Parameters:

metadataId - The metadata id.

value - The value to test. Set null to test existence

setMetadataCondition

public void setMetadataCondition(ContentFilter.Condition condition)

Description copied from interface: ContentFilter

Set the metadata condition

Specified by:

setMetadataCondition in interface ContentFilter

Parameters:

condition - The condition to set

getAdditionalFilterExpression

public Expression getAdditionalFilterExpression()

Description copied from interface: ContentFilter

Get the current filter expression

Specified by:

getAdditionalFilterExpression in interface ContentFilter

Returns:

The expression. Can be null.

setAdditionalFilterExpression

public void setAdditionalFilterExpression(Expression expression)

Description copied from interface: ContentFilter

Set the filter expression that should complete metadata filtering (by doing an AND between both)

Specified by:

setAdditionalFilterExpression in interface ContentFilter

Parameters:

expression - The expression to set. Can be null to remove curren expression

setContextLanguage

public void setContextLanguage(ContentFilter.ContextLanguage context)

Description copied from interface: ContentFilter

Set the context language

Specified by:

setContextLanguage in interface ContentFilter

Parameters:

context - The context language to set

setId

public void setId(String id)

Description copied from interface: ContentFilter

Set the filter id.

Specified by:

setId in interface ContentFilter

Parameters:

id - The id to set.

setResolver

public void setResolver(AmetysObjectResolver resolver)

Description copied from interface: ContentFilter

Set the ametys object resolver to execute query

Specified by:

setResolver in interface ContentFilter

Parameters:

resolver - The ametys object resolver to set

setLength

public void setLength(int length)

Description copied from interface: ContentFilter

Set the max number o results

Specified by:

setLength in interface ContentFilter

Parameters:

length - The max number of results

setView

public void setView(String metadataSetName)

Description copied from interface: ContentFilter

Set the filter view

Specified by:

setView in interface ContentFilter

Parameters:

metadataSetName - The name of MetadataSet

addSortCriteria

public void addSortCriteria(String metadataId,
                            boolean ascending,
                            boolean useLowerCase)

Description copied from interface: ContentFilter

Add a sort criteria

Specified by:

addSortCriteria in interface ContentFilter

Parameters:

metadataId - The metadata id to sort

ascending - true to ascending sort

useLowerCase - true for case insensitive order on a string property

getMatchingContents

public AmetysObjectIterable<Content> getMatchingContents()

Description copied from interface: ContentFilter

Get the contents matching this filter.

Specified by:

getMatchingContents in interface ContentFilter

Returns:

The matching contents.

getMatchingContents

public AmetysObjectIterable<Content> getMatchingContents(String lang)

Description copied from interface: ContentFilter

Get the contents matching this filter.

Specified by:

getMatchingContents in interface ContentFilter

Parameters:

lang - The current language.

Returns:

The matching contents.

getXPathQuery

public String getXPathQuery()

Creates the XPath query corresponding to this filter.

Returns:

the created XPath query

getXPathQuery

public String getXPathQuery(String lang)

Creates the XPath query corresponding to this filter.

Parameters:

lang - The current language

Returns:

the created XPath query

getFilterExpression

protected Expression getFilterExpression()

Get the expression corresponding to this filter

Returns:

The created expression to match contents

getContentTypesExpression

protected Expression getContentTypesExpression()

Get the expression corresponding to the filter's content types

Returns:

The expression corresponding to the filter's content types

getContextLanguagesExpression

protected Expression getContextLanguagesExpression(String lang)

Get the Expression associated with the given language context

Parameters:

lang - The current language

Returns:

a Expression associated with the given language context

getMetadataExpression

protected Expression getMetadataExpression()

Get the expression corresponding to the filter's tags

Returns:

The expression corresponding to the filter's tags