Package org.ametys.web.filter

Class DefaultWebContentFilter.DefaultFilterSearchContext

java.lang.Object

org.ametys.web.filter.DefaultWebContentFilter.DefaultFilterSearchContext

All Implemented Interfaces:

WebContentFilter.FilterSearchContext

Direct Known Subclasses:

EventsFilter.EventFilterSearchContext, PostFilter.PostFilterSearchContext

Enclosing class:

DefaultWebContentFilter

public class DefaultWebContentFilter.DefaultFilterSearchContext
extends Object
implements WebContentFilter.FilterSearchContext

Default implementation of a filter search context.

Field Summary

Fields

Modifier and Type	Field	Description
protected WebContentFilter.Context	_context	The context for search
protected ContentFilter.ContextLanguage	_contextLang	The list of content languages to match
protected int	_depth	The search depth
protected String	_pageId	The parent page Id
protected SiteManager	_siteManager	The list of content languages to match
protected List<String>	_sites	The list of sites to match
protected List<String>	_tags	The tags.
protected boolean	_tagsAutoPosting	The tags auto posting
protected ContentFilter.Condition	_tagsCondition	The tags condition

Constructor Summary

Constructors

Constructor	Description
DefaultFilterSearchContext(SiteManager siteManager)	Build a DefaultFilterSearchContext.

Method Summary

Modifier and Type	Method	Description
protected Tag	_getTag(String currentSiteName, String tagName)	Internal tag getter given the search context
void	addSite(String siteName)	Add a site to the filter
void	addTag(String tag)	Add a tag to the filter
WebContentFilter.Context	getContext()	Get the search context
protected Expression	getContextExpression(String siteName)	Get the Expression associated with the given site context
ContentFilter.ContextLanguage	getContextLanguage()	Get the context language
protected Expression	getContextLanguagesExpression(String lang)	Get the Expression associated with the given language context
int	getDepth()	Get the search depth
Expression	getFullExpression(String siteName, String language)	Get the Expression.
String	getPageId()	Get the parent page id
protected Expression	getSharedContentsExpression(String currentSiteName)	Get the expression for shared contents
List<String>	getSites()	Get the site names to match contents
List<String>	getTags()	Get the tag keys to match contents
boolean	getTagsAutoPosting()	Is the tag auto posting enabled?
ContentFilter.Condition	getTagsCondition()	The tags condition
Expression	getTagsExpression(String siteName)	Get the expression corresponding to the filter's tags
void	setContext(WebContentFilter.Context context)	Set the search context
void	setContextLanguage(ContentFilter.ContextLanguage language)	Set the context language
void	setDepth(int depth)	Set the search depth
void	setPageId(String pageId)	set the parent page Id.
void	setTagsAutoPosting(boolean enable)	Enable/disable the tag autoposting feature.
void	setTagsCondition(ContentFilter.Condition condition)	Set the tags condition

Methods inherited from class java.lang.Object

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

Field Detail

_tags

protected List<String> _tags

The tags.

_tagsCondition

protected ContentFilter.Condition _tagsCondition

The tags condition

_tagsAutoPosting

protected boolean _tagsAutoPosting

The tags auto posting

_context

protected WebContentFilter.Context _context

The context for search

_sites

protected List<String> _sites

The list of sites to match

_depth

protected int _depth

The search depth

_contextLang

protected ContentFilter.ContextLanguage _contextLang

The list of content languages to match

_pageId

protected String _pageId

The parent page Id

_siteManager

protected SiteManager _siteManager

The list of content languages to match

Constructor Detail

DefaultFilterSearchContext

public DefaultFilterSearchContext(SiteManager siteManager)

Build a DefaultFilterSearchContext.

Parameters:

siteManager - the site manager.

Method Detail

getDepth

public int getDepth()

Description copied from interface: WebContentFilter.FilterSearchContext

Get the search depth

Specified by:

getDepth in interface WebContentFilter.FilterSearchContext

Returns:

The search depth

getTags

public List<String> getTags()

Description copied from interface: WebContentFilter.FilterSearchContext

Get the tag keys to match contents

Specified by:

getTags in interface WebContentFilter.FilterSearchContext

Returns:

The tag keys to match contents

getTagsCondition

public ContentFilter.Condition getTagsCondition()

Description copied from interface: WebContentFilter.FilterSearchContext

The tags condition

Specified by:

getTagsCondition in interface WebContentFilter.FilterSearchContext

Returns:

The tags condition

getTagsAutoPosting

public boolean getTagsAutoPosting()

Description copied from interface: WebContentFilter.FilterSearchContext

Is the tag auto posting enabled?

Specified by:

getTagsAutoPosting in interface WebContentFilter.FilterSearchContext

Returns:

true if it is

getContext

public WebContentFilter.Context getContext()

Description copied from interface: WebContentFilter.FilterSearchContext

Get the search context

Specified by:

getContext in interface WebContentFilter.FilterSearchContext

Returns:

The search context

getSites

public List<String> getSites()

Description copied from interface: WebContentFilter.FilterSearchContext

Get the site names to match contents

Specified by:

getSites in interface WebContentFilter.FilterSearchContext

Returns:

The the site names to match contents

addTag

public void addTag(String tag)

Description copied from interface: WebContentFilter.FilterSearchContext

Add a tag to the filter

Specified by:

addTag in interface WebContentFilter.FilterSearchContext

Parameters:

tag - The tag key to add

setTagsCondition

public void setTagsCondition(ContentFilter.Condition condition)

Description copied from interface: WebContentFilter.FilterSearchContext

Set the tags condition

Specified by:

setTagsCondition in interface WebContentFilter.FilterSearchContext

Parameters:

condition - The condition to set

setTagsAutoPosting

public void setTagsAutoPosting(boolean enable)

Description copied from interface: WebContentFilter.FilterSearchContext

Enable/disable the tag autoposting feature.

Specified by:

setTagsAutoPosting in interface WebContentFilter.FilterSearchContext

Parameters:

enable - True to enable the autposting, false to remains in strict match mode.

setContext

public void setContext(WebContentFilter.Context context)

Description copied from interface: WebContentFilter.FilterSearchContext

Set the search context

Specified by:

setContext in interface WebContentFilter.FilterSearchContext

Parameters:

context - The search context to set

addSite

public void addSite(String siteName)

Description copied from interface: WebContentFilter.FilterSearchContext

Add a site to the filter

Specified by:

addSite in interface WebContentFilter.FilterSearchContext

Parameters:

siteName - The site name to add

setDepth

public void setDepth(int depth)

Description copied from interface: WebContentFilter.FilterSearchContext

Set the search depth

Specified by:

setDepth in interface WebContentFilter.FilterSearchContext

Parameters:

depth - The search depth. Set to 0 for no depth limitation.

getContextLanguage

public ContentFilter.ContextLanguage getContextLanguage()

Description copied from interface: WebContentFilter.FilterSearchContext

Get the context language

Specified by:

getContextLanguage in interface WebContentFilter.FilterSearchContext

Returns:

The context language

setContextLanguage

public void setContextLanguage(ContentFilter.ContextLanguage language)

Description copied from interface: WebContentFilter.FilterSearchContext

Set the context language

Specified by:

setContextLanguage in interface WebContentFilter.FilterSearchContext

Parameters:

language - The context language to set

getFullExpression

public Expression getFullExpression(String siteName,
                                    String language)

Description copied from interface: WebContentFilter.FilterSearchContext

Get the Expression.

Specified by:

getFullExpression in interface WebContentFilter.FilterSearchContext

Parameters:

siteName - the site name

language - the language

Returns:

the expression.

getTagsExpression

public Expression getTagsExpression(String siteName)

Description copied from interface: WebContentFilter.FilterSearchContext

Get the expression corresponding to the filter's tags

Specified by:

getTagsExpression in interface WebContentFilter.FilterSearchContext

Parameters:

siteName - The current site name

Returns:

The expression corresponding to the filter's tags

_getTag

protected Tag _getTag(String currentSiteName,
                      String tagName)

Internal tag getter given the search context

Parameters:

currentSiteName - The name of the current site

tagName - the name of the tag

Returns:

The tag or null

getContextExpression

protected Expression getContextExpression(String siteName)

Get the Expression associated with the given site context

Parameters:

siteName - The current site name

Returns:

a Expression associated with the given site context

getSharedContentsExpression

protected Expression getSharedContentsExpression(String currentSiteName)

Get the expression for shared contents

Parameters:

currentSiteName - the current site name

Returns:

the expression to aware of privacy of contents

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

getPageId

public String getPageId()

Description copied from interface: WebContentFilter.FilterSearchContext

Get the parent page id

Specified by:

getPageId in interface WebContentFilter.FilterSearchContext

Returns:

The parent page id

setPageId

public void setPageId(String pageId)

Description copied from interface: WebContentFilter.FilterSearchContext

set the parent page Id.

Specified by:

setPageId in interface WebContentFilter.FilterSearchContext

Parameters:

pageId - Id of the parent page (when fetching child of a page).