fr.ifremer.isisfish.ui.widget.filter

Class FilterModel<M,R>

java.lang.Object

fr.ifremer.isisfish.ui.widget.filter.FilterModel<M,R>

public abstract class FilterModel<M,R>
extends Object

This class represents a generic filter model.

It contains all data to be used for filter process.

Author:

chemit

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	exclusiveMode flag to says inclusive mode (need one param accept) or exclusive mode (need all params to accept)
protected List<M>	original list of original items
protected List<String>	paramKeys list of param keys to be used
protected Map<String,FilterParamModel<M,?>>	paramModels map -> paramKey to param models
protected List<M>	result current filter result list of items

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilterModel(List<M> original, Map<String,FilterParamModel<M,?>> paramModels)

Method Summary

Methods

Modifier and Type	Method and Description
abstract R	convertToResult(M item)
List<M>	doFilter()
List<M>	getFiltered()
List<R>	getFilteredResult()
int	getNbOriginal()
int	getNbResult()
List<M>	getOriginal()
FilterParamModel<M,?>	getParamModel(String paramKey)
void	reset()
void	selectAll()
void	setFiltered(List<M> filtered)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

original

protected List<M> original

list of original items

result

protected List<M> result

current filter result list of items

paramKeys

protected List<String> paramKeys

list of param keys to be used

paramModels

protected Map<String,FilterParamModel<M,?>> paramModels

map -> paramKey to param models

exclusiveMode

protected boolean exclusiveMode

flag to says inclusive mode (need one param accept) or exclusive mode (need all params to accept)

Constructor Detail

FilterModel

protected FilterModel(List<M> original,
           Map<String,FilterParamModel<M,?>> paramModels)

Method Detail

convertToResult

public abstract R convertToResult(M item)

Parameters:

item - item to convert to result

Returns:

converted value from item

getParamModel

public FilterParamModel<M,?> getParamModel(String paramKey)

reset

public void reset()

doFilter

public List<M> doFilter()

selectAll

public void selectAll()

getFiltered

public List<M> getFiltered()

getFilteredResult

public List<R> getFilteredResult()

getOriginal

public List<M> getOriginal()

getNbResult

public int getNbResult()

getNbOriginal

public int getNbOriginal()

toString

public String toString()

Overrides:

toString in class Object

setFiltered

public void setFiltered(List<M> filtered)