org.primefaces.component.datatable.feature.FilterFeature Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation
Show all versions of primefaces Show documentation
PrimeFaces is one of the most popular UI libraries in Java EE Ecosystem and widely used by software companies, world renowned brands, banks, financial institutions, insurance companies, universities and more.
/**
* The MIT License
*
* Copyright (c) 2009-2019 PrimeTek
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.primefaces.component.datatable.feature;
import java.io.IOException;
import java.lang.reflect.Array;
import java.util.*;
import javax.el.ELContext;
import javax.el.MethodExpression;
import javax.el.ValueExpression;
import javax.faces.FacesException;
import javax.faces.component.UIComponent;
import javax.faces.component.UINamingContainer;
import javax.faces.component.ValueHolder;
import javax.faces.context.FacesContext;
import org.primefaces.PrimeFaces;
import org.primefaces.component.api.DynamicColumn;
import org.primefaces.component.api.UIColumn;
import org.primefaces.component.column.Column;
import org.primefaces.component.columngroup.ColumnGroup;
import org.primefaces.component.columns.Columns;
import org.primefaces.component.datatable.DataTable;
import org.primefaces.component.datatable.DataTableRenderer;
import org.primefaces.component.datatable.FilterState;
import org.primefaces.component.datatable.TableState;
import org.primefaces.component.row.Row;
import org.primefaces.event.data.PostFilterEvent;
import org.primefaces.model.FilterMeta;
import org.primefaces.model.filter.*;
import org.primefaces.util.LangUtils;
public class FilterFeature implements DataTableFeature {
private static final String STARTS_WITH_MATCH_MODE = "startsWith";
private static final String ENDS_WITH_MATCH_MODE = "endsWith";
private static final String CONTAINS_MATCH_MODE = "contains";
private static final String EXACT_MATCH_MODE = "exact";
private static final String LESS_THAN_MODE = "lt";
private static final String LESS_THAN_EQUALS_MODE = "lte";
private static final String GREATER_THAN_MODE = "gt";
private static final String GREATER_THAN_EQUALS_MODE = "gte";
private static final String EQUALS_MODE = "equals";
private static final String IN_MODE = "in";
private static final String GLOBAL_MODE = "global";
private static final Map FILTER_CONSTRAINTS;
static {
FILTER_CONSTRAINTS = new HashMap<>();
FILTER_CONSTRAINTS.put(STARTS_WITH_MATCH_MODE, new StartsWithFilterConstraint());
FILTER_CONSTRAINTS.put(ENDS_WITH_MATCH_MODE, new EndsWithFilterConstraint());
FILTER_CONSTRAINTS.put(CONTAINS_MATCH_MODE, new ContainsFilterConstraint());
FILTER_CONSTRAINTS.put(EXACT_MATCH_MODE, new ExactFilterConstraint());
FILTER_CONSTRAINTS.put(LESS_THAN_MODE, new LessThanFilterConstraint());
FILTER_CONSTRAINTS.put(LESS_THAN_EQUALS_MODE, new LessThanEqualsFilterConstraint());
FILTER_CONSTRAINTS.put(GREATER_THAN_MODE, new GreaterThanFilterConstraint());
FILTER_CONSTRAINTS.put(GREATER_THAN_EQUALS_MODE, new GreaterThanEqualsFilterConstraint());
FILTER_CONSTRAINTS.put(EQUALS_MODE, new EqualsFilterConstraint());
FILTER_CONSTRAINTS.put(IN_MODE, new InFilterConstraint());
FILTER_CONSTRAINTS.put(GLOBAL_MODE, new GlobalFilterConstraint());
}
private boolean isFilterRequest(FacesContext context, DataTable table) {
return context.getExternalContext().getRequestParameterMap().containsKey(table.getClientId(context) + "_filtering");
}
@Override
public boolean shouldDecode(FacesContext context, DataTable table) {
return false;
}
@Override
public boolean shouldEncode(FacesContext context, DataTable table) {
return isFilterRequest(context, table);
}
@Override
public void decode(FacesContext context, DataTable table) {
String globalFilterParam = table.getClientId(context) + UINamingContainer.getSeparatorChar(context) + "globalFilter";
List filterMetadata = populateFilterMetaData(context, table);
Map filterParameterMap = populateFilterParameterMap(context, table, filterMetadata, globalFilterParam);
table.setFilters(filterParameterMap);
table.setFilterMetadata(filterMetadata);
}
@Override
public void encode(FacesContext context, DataTableRenderer renderer, DataTable table) throws IOException {
Map params = context.getExternalContext().getRequestParameterMap();
String globalFilterValue = null;
//reset state
String clientId = table.getClientId(context);
table.updateFilteredValue(context, null);
table.setValue(null);
table.setFirst(0);
table.setRowIndex(-1);
//update rows with rpp value
String rppValue = params.get(clientId + "_rppDD");
if (rppValue != null) {
table.setRows(Integer.parseInt(rppValue));
}
if (table.isLazy()) {
if (table.isLiveScroll()) {
table.loadLazyScrollData(0, table.getScrollRows());
}
else if (table.isVirtualScroll()) {
int rows = table.getRows();
int scrollRows = table.getScrollRows();
int virtualScrollRows = (scrollRows * 2);
scrollRows = (rows == 0) ? virtualScrollRows : ((virtualScrollRows > rows) ? rows : virtualScrollRows);
table.loadLazyScrollData(0, scrollRows);
}
else {
table.loadLazyData();
}
}
else {
String globalFilterParam = clientId + UINamingContainer.getSeparatorChar(context) + "globalFilter";
globalFilterValue = params.get(globalFilterParam);
filter(context, table, table.getFilterMetadata(), globalFilterValue);
//sort new filtered data to restore sort state
boolean sorted = table.getValueExpression(DataTable.PropertyKeys.sortBy.toString()) != null
|| table.getSortBy() != null;
if (sorted) {
SortFeature sortFeature = (SortFeature) table.getFeature(DataTableFeatureKey.SORT);
if (table.isMultiSort()) {
sortFeature.multiSort(context, table);
}
else {
sortFeature.singleSort(context, table);
}
}
}
context.getApplication().publishEvent(context, PostFilterEvent.class, table);
renderer.encodeTbody(context, table, true);
if (table.isMultiViewState()) {
List filterMetadata = table.getFilterMetadata();
List filters = new ArrayList<>();
for (FilterMeta filterMeta : filterMetadata) {
filters.add(new FilterState(filterMeta.getColumn().getColumnKey(), filterMeta.getFilterValue()));
}
TableState ts = table.getTableState(true);
ts.setFilters(filters);
ts.setGlobalFilterValue(globalFilterValue);
if (table.isPaginator()) {
ts.setFirst(table.getFirst());
ts.setRows(table.getRows());
}
}
}
public void filter(FacesContext context, DataTable table, List filterMetadata, String globalFilterValue) {
List filteredData = new ArrayList();
Locale filterLocale = table.resolveDataLocale();
boolean hasGlobalFilter = !LangUtils.isValueBlank(globalFilterValue);
GlobalFilterConstraint globalFilterConstraint = (GlobalFilterConstraint) FILTER_CONSTRAINTS.get(GLOBAL_MODE);
ELContext elContext = context.getELContext();
for (int i = 0; i < table.getRowCount(); i++) {
table.setRowIndex(i);
boolean localMatch = true;
boolean globalMatch = false;
for (FilterMeta filterMeta : filterMetadata) {
Object filterValue = filterMeta.getFilterValue();
UIColumn column = filterMeta.getColumn();
MethodExpression filterFunction = column.getFilterFunction();
ValueExpression filterByVE = filterMeta.getFilterByVE();
if (column instanceof DynamicColumn) {
((DynamicColumn) column).applyStatelessModel();
}
Object columnValue = filterByVE.getValue(elContext);
FilterConstraint filterConstraint = getFilterConstraint(column);
if (hasGlobalFilter && !globalMatch) {
globalMatch = globalFilterConstraint.applies(columnValue, globalFilterValue, filterLocale);
}
if (filterFunction != null) {
localMatch = (Boolean) filterFunction.invoke(elContext, new Object[]{columnValue, filterValue, filterLocale});
}
else if (!filterConstraint.applies(columnValue, filterValue, filterLocale)) {
localMatch = false;
}
if (!localMatch) {
break;
}
}
boolean matches = localMatch;
if (hasGlobalFilter) {
matches = localMatch && globalMatch;
}
if (matches) {
filteredData.add(table.getRowData());
}
}
//Metadata for callback
if (table.isPaginator() || table.isVirtualScroll()) {
PrimeFaces.current().ajax().addCallbackParam("totalRecords", filteredData.size());
}
//save filtered data
table.updateFilteredValue(context, filteredData);
//update value
table.updateValue(table.getFilteredValue());
table.setRowIndex(-1); //reset datamodel
}
public Map populateFilterParameterMap(FacesContext context, DataTable table, List filterMetadata,
String globalFilterParam) {
Map params = context.getExternalContext().getRequestParameterMap();
Map filterParameterMap = new HashMap<>();
for (FilterMeta filterMeta : filterMetadata) {
Object filterValue = filterMeta.getFilterValue();
if (filterValue == null) {
continue;
}
if (filterValue.getClass().isArray() && Array.getLength(filterValue) == 0) {
continue;
}
if (LangUtils.isValueBlank(filterValue.toString())) {
continue;
}
UIColumn column = filterMeta.getColumn();
String filterField = null;
ValueExpression filterByVE = column.getValueExpression(Column.PropertyKeys.filterBy.toString());
if (column.isDynamic()) {
((DynamicColumn) column).applyStatelessModel();
Object filterByProperty = column.getFilterBy();
String field = column.getField();
if (field == null) {
filterField = (filterByProperty == null) ? table.resolveDynamicField(filterByVE) : filterByProperty.toString();
}
else {
filterField = field;
}
}
else {
String field = column.getField();
if (field == null) {
filterField = (filterByVE == null) ? (String) column.getFilterBy() : table.resolveStaticField(filterByVE);
}
else {
filterField = field;
}
}
filterParameterMap.put(filterField, filterValue);
}
if (params.containsKey(globalFilterParam)) {
filterParameterMap.put("globalFilter", params.get(globalFilterParam));
}
return filterParameterMap;
}
public List populateFilterMetaData(FacesContext context, DataTable table) {
List filterMetadata = new ArrayList<>();
String separator = String.valueOf(UINamingContainer.getSeparatorChar(context));
Map params = context.getExternalContext().getRequestParameterMap();
boolean hasFrozenColumns = table.getFrozenColumns() > 0;
if (!hasFrozenColumns) {
ColumnGroup headerGroup = getColumnGroup(table, "header");
if (headerGroup != null) {
populateFilterMetaDataInColumnGroup(context, filterMetadata, headerGroup, params, separator);
}
else {
populateFilterMetaDataWithoutColumnGroups(context, table, filterMetadata, params, separator);
}
}
else {
ColumnGroup frozenHeaderGroup = getColumnGroup(table, "frozenHeader");
ColumnGroup scrollableHeaderGroup = getColumnGroup(table, "scrollableHeader");
if (frozenHeaderGroup != null) {
populateFilterMetaDataInColumnGroup(context, filterMetadata, frozenHeaderGroup, params, separator);
populateFilterMetaDataInColumnGroup(context, filterMetadata, scrollableHeaderGroup, params, separator);
}
else {
populateFilterMetaDataWithoutColumnGroups(context, table, filterMetadata, params, separator);
}
}
return filterMetadata;
}
private void populateFilterMetaDataInColumnGroup(FacesContext context, List filterMetadata, ColumnGroup group,
Map params, String separator) {
if (group == null) {
return;
}
for (UIComponent child : group.getChildren()) {
Row headerRow = (Row) child;
if (headerRow.isRendered()) {
for (UIComponent headerRowChild : headerRow.getChildren()) {
if (headerRowChild instanceof Column) {
Column column = (Column) headerRowChild;
if (column.isRendered()) {
ValueExpression filterVE = column.getValueExpression(Column.PropertyKeys.filterBy.toString());
if (filterVE != null) {
UIComponent filterFacet = column.getFacet("filter");
Object filterValue = (filterFacet == null)
? params.get(column.getClientId(context) + separator + "filter")
: ((ValueHolder) filterFacet).getLocalValue();
filterMetadata.add(new FilterMeta(column, filterVE, filterValue));
}
}
}
else if (headerRowChild instanceof Columns) {
Columns uiColumns = (Columns) headerRowChild;
List dynamicColumns = uiColumns.getDynamicColumns();
for (DynamicColumn dynaColumn : dynamicColumns) {
dynaColumn.applyStatelessModel();
if (dynaColumn.isRendered()) {
ValueExpression filterVE = dynaColumn.getValueExpression(Column.PropertyKeys.filterBy.toString());
if (filterVE != null) {
String filterId = dynaColumn.getContainerClientId(context) + separator + "filter";
UIComponent filterFacet = dynaColumn.getFacet("filter");
Object filterValue = (filterFacet == null) ? params.get(filterId) : ((ValueHolder) filterFacet).getLocalValue();
filterMetadata.add(new FilterMeta(dynaColumn, filterVE, filterValue));
}
}
}
}
}
}
}
}
private void populateFilterMetaDataWithoutColumnGroups(FacesContext context, DataTable table, List filterMetadata,
Map params, String separator) {
for (UIColumn column : table.getColumns()) {
ValueExpression filterVE = column.getValueExpression(Column.PropertyKeys.filterBy.toString());
if (filterVE != null) {
UIComponent filterFacet = column.getFacet("filter");
Object filterValue = null;
String filterId;
if (column instanceof Column) {
filterId = column.getClientId(context) + separator + "filter";
filterValue = (filterFacet == null) ? params.get(filterId) : ((ValueHolder) filterFacet).getLocalValue();
}
else if (column instanceof DynamicColumn) {
DynamicColumn dynamicColumn = (DynamicColumn) column;
dynamicColumn.applyModel();
filterId = dynamicColumn.getContainerClientId(context) + separator + "filter";
filterValue = (filterFacet == null) ? params.get(filterId) : ((ValueHolder) filterFacet).getLocalValue();
dynamicColumn.cleanModel();
}
filterMetadata.add(new FilterMeta(column, filterVE, filterValue));
}
}
}
private ColumnGroup getColumnGroup(DataTable table, String target) {
for (UIComponent child : table.getChildren()) {
if (child instanceof ColumnGroup) {
ColumnGroup colGroup = (ColumnGroup) child;
String type = colGroup.getType();
if (type != null && type.equals(target)) {
return colGroup;
}
}
}
return null;
}
public FilterConstraint getFilterConstraint(UIColumn column) {
String filterMatchMode = column.getFilterMatchMode();
FilterConstraint filterConstraint = FILTER_CONSTRAINTS.get(filterMatchMode);
if (filterConstraint == null) {
throw new FacesException("Illegal filter match mode:" + filterMatchMode);
}
return filterConstraint;
}
}