fr.paris.lutece.plugins.directory.modules.multiview.web.record.filter.display.impl

Class AbstractRecordFilterDisplay

java.lang.Object

fr.paris.lutece.plugins.directory.modules.multiview.web.record.filter.display.impl.AbstractRecordFilterDisplay

All Implemented Interfaces:

IRecordFilterDisplay, IFilterable, IRecordListPosition

Direct Known Subclasses:

RecordFilterDisplayDirectory, RecordFilterDisplayEntry, RecordFilterDisplayRecordDateCreation, RecordFilterDisplayWorkflowState

public abstract class AbstractRecordFilterDisplay
extends Object
implements IRecordFilterDisplay

Abstract class for the RecordFilterDisplay objects

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FILTER_TEMPLATE_NAME
protected static String	MARK_FILTER_LIST
protected static String	MARK_FILTER_LIST_VALUE
protected static String	MARK_FILTER_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractRecordFilterDisplay()

Method Summary

Modifier and Type	Method and Description
abstract void	buildTemplate(javax.servlet.http.HttpServletRequest request) Build the Template of the RecordFilterDisplay
RecordParameters	createRecordParameters(javax.servlet.http.HttpServletRequest request) Create a RecordParameters for the filter with the data in the given request
protected abstract Map<String,Object>	getFilterDisplayMapValues(javax.servlet.http.HttpServletRequest request) Get the map of all parameter names and values used by the filter
int	getPosition() Return the position of the element
IRecordFilter	getRecordFilter() Return the RecordFilter of the FilterDisplay
protected String	getRecordFilterDisplayLabel() Return the label of the RecordFilter from its configuration
String	getTemplate() Return the template of the RecordFilterDisplay
String	getValue() Return the value of the RecordFilterDisplay
protected void	manageFilterTemplate(javax.servlet.http.HttpServletRequest request, fr.paris.lutece.util.ReferenceList referenceList, String strParameterName) Build the filter template with the given list for the specified parameter and set it to the filter
void	setPosition(int nPosition) Set the position of the element
void	setRecordFilter(IRecordFilter recordFilter) Set the RecordFilter associated to the FilterDisplay
protected void	setTemplate(String strTemplate) Set the template
protected void	setValue(String strValue) Set the value for the RecordFilterDisplay

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.paris.lutece.plugins.directory.modules.multiview.web.record.filter.display.IRecordFilterDisplay

getParameterName

Field Detail

FILTER_TEMPLATE_NAME

protected static final String FILTER_TEMPLATE_NAME

See Also:

Constant Field Values

MARK_FILTER_LIST

protected static final String MARK_FILTER_LIST

See Also:

Constant Field Values

MARK_FILTER_NAME

protected static final String MARK_FILTER_NAME

See Also:

Constant Field Values

MARK_FILTER_LIST_VALUE

protected static final String MARK_FILTER_LIST_VALUE

See Also:

Constant Field Values

Constructor Detail

AbstractRecordFilterDisplay

public AbstractRecordFilterDisplay()

Method Detail

getValue

public String getValue()

Return the value of the RecordFilterDisplay

Specified by:

getValue in interface IRecordFilterDisplay

Returns:

the value of the RecordFilterDisplay

setValue

protected void setValue(String strValue)

Set the value for the RecordFilterDisplay

Parameters:

strValue - The value to set to the RecordFilterDisplay

getPosition

public int getPosition()

Return the position of the element

Specified by:

getPosition in interface IRecordListPosition

Returns:

the position of the element

setPosition

public void setPosition(int nPosition)

Set the position of the element

Specified by:

setPosition in interface IRecordListPosition

Parameters:

nPosition - The position to set to the element

getTemplate

public String getTemplate()

Return the template of the RecordFilterDisplay

Specified by:

getTemplate in interface IRecordFilterDisplay

Returns:

the template of the RecordFilterDisplay

setTemplate

protected void setTemplate(String strTemplate)

Set the template

Parameters:

strTemplate - The template to setto the filter

getRecordFilter

public IRecordFilter getRecordFilter()

Return the RecordFilter of the FilterDisplay

Specified by:

getRecordFilter in interface IFilterable

Returns:

the RecordFilter of the FilterDisplay

setRecordFilter

public void setRecordFilter(IRecordFilter recordFilter)

Set the RecordFilter associated to the FilterDisplay

Specified by:

setRecordFilter in interface IFilterable

Parameters:

recordFilter - The RecordFilter to associate to the RecordFilterDisplay

buildTemplate

public abstract void buildTemplate(javax.servlet.http.HttpServletRequest request)

Build the Template of the RecordFilterDisplay

Specified by:

buildTemplate in interface IRecordFilterDisplay

Parameters:

request - The HttpServletRequest to use to build the template of the filter

getFilterDisplayMapValues

protected abstract Map<String,Object> getFilterDisplayMapValues(javax.servlet.http.HttpServletRequest request)

Get the map of all parameter names and values used by the filter

Parameters:

request - The request used to retrieve the informations of the filter

Returns:

the map which contains all the parameter names and values of the filter

createRecordParameters

public RecordParameters createRecordParameters(javax.servlet.http.HttpServletRequest request)

Create a RecordParameters for the filter with the data in the given request

Specified by:

createRecordParameters in interface IFilterable

Parameters:

request - The request to retrieve the data of the filter

Returns:

the RecordParameters for the given filter with the data of the request

manageFilterTemplate

protected void manageFilterTemplate(javax.servlet.http.HttpServletRequest request,
                                    fr.paris.lutece.util.ReferenceList referenceList,
                                    String strParameterName)

Build the filter template with the given list for the specified parameter and set it to the filter

Parameters:

request - The HttpServletRequest to use for building the template

referenceList - The ReferenceList to use to populate the filter template

strParameterName - The name of the parameter to attached the value of the ReferenceList

getRecordFilterDisplayLabel

protected String getRecordFilterDisplayLabel()

Return the label of the RecordFilter from its configuration

Returns:

the label of the RecordFilter from its configuration or the default label if not found