Package com.jalios.jcms

Class CustomCleanFilter

java.lang.Object

com.jalios.jcms.CustomCleanFilter

All Implemented Interfaces:

PluginComponent, CleanFilter

public abstract class CustomCleanFilter
extends java.lang.Object
implements CleanFilter, PluginComponent

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	REVISION

Constructor Summary

Constructors

Constructor	Description
CustomCleanFilter()

Method Summary

Modifier and Type	Method	Description
void	cleanMergeMap(java.util.Map mergeMap)	This method is called to clean the merge map.
abstract java.lang.String	getLabel(java.lang.String userLang)	Returns the label of the filter
java.lang.String	getParameterName()	Returns the name of the request parameter.
void	init(JcmsContext context)	This method is called before a store cleaning.
boolean	init(Plugin plugin)	Initialize the component with the given plugin configuration
boolean	isChecked()	Returns true if this filter must be checked by default.
boolean	isCleanable(InnerLogEntry entry)	Returns true if the entry can be cleaned or false otherwise.
boolean	isCleanable(StorableLogEntry entry, java.lang.Class clazz)	Returns true if the entry can be cleaned or false otherwise.
boolean	isEnabled()

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

CustomCleanFilter

public CustomCleanFilter()

Method Detail

init

public void init(JcmsContext context)

This method is called before a store cleaning.

Parameters:

context - the JCMS context

Since:

jcms-5.5.0

init

public boolean init(Plugin plugin)

Description copied from interface: PluginComponent

Initialize the component with the given plugin configuration

Specified by:

init in interface PluginComponent

Parameters:

plugin - the calling plugin

Returns:

true if the component has been correctly initialized.

Since:

jcms-5.7.1

See Also:

PluginComponent.init(Plugin)

isEnabled

public boolean isEnabled()

getParameterName

public java.lang.String getParameterName()

Returns the name of the request parameter.

Returns:

the name of the request parameter.

Since:

jcms-5.5.0

getLabel

public abstract java.lang.String getLabel(java.lang.String userLang)

Returns the label of the filter

Parameters:

userLang - the user language

Returns:

the label of the filter.

Since:

jcms-5.5.0

isChecked

public boolean isChecked()

Returns true if this filter must be checked by default. False otherwise.

Returns:

true if this filter must be checked by default. False otherwise.

Since:

jcms-5.5.0

isCleanable

public boolean isCleanable(StorableLogEntry entry,
                           java.lang.Class clazz)

Description copied from interface: CleanFilter

Returns true if the entry can be cleaned or false otherwise.

Specified by:

isCleanable in interface CleanFilter

Parameters:

entry - the entry to be checked

clazz - the class of which this entry is applied

Returns:

true if the entry can be cleaned or false otherwise

isCleanable

public boolean isCleanable(InnerLogEntry entry)

Description copied from interface: CleanFilter

Returns true if the entry can be cleaned or false otherwise.

Specified by:

isCleanable in interface CleanFilter

Parameters:

entry - the entry to be checked

Returns:

true if the entry can be cleaned or false otherwise

cleanMergeMap

public void cleanMergeMap(java.util.Map mergeMap)

Description copied from interface: CleanFilter

This method is called to clean the merge map.

Specified by:

cleanMergeMap in interface CleanFilter

Parameters:

mergeMap - the merge map