org.primefaces.component.datatable.feature.SortFeature 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.
/**
* Copyright 2009-2018 PrimeTek.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.primefaces.component.datatable.feature;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import javax.el.MethodExpression;
import javax.el.ValueExpression;
import javax.faces.FacesException;
import javax.faces.context.FacesContext;
import javax.faces.model.ListDataModel;
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.datatable.DataTable;
import org.primefaces.component.datatable.DataTableRenderer;
import org.primefaces.component.datatable.TableState;
import org.primefaces.event.data.PostSortEvent;
import org.primefaces.model.BeanPropertyComparator;
import org.primefaces.model.ChainedBeanPropertyComparator;
import org.primefaces.model.DynamicChainedPropertyComparator;
import org.primefaces.model.SortMeta;
import org.primefaces.model.SortOrder;
public class SortFeature implements DataTableFeature {
private boolean isSortRequest(FacesContext context, DataTable table) {
return context.getExternalContext().getRequestParameterMap().containsKey(table.getClientId(context) + "_sorting");
}
@Override
public void decode(FacesContext context, DataTable table) {
table.setRowIndex(-1);
String clientId = table.getClientId(context);
Map params = context.getExternalContext().getRequestParameterMap();
String sortKey = params.get(clientId + "_sortKey");
String sortDir = params.get(clientId + "_sortDir");
if (table.isMultiSort()) {
List multiSortMeta = new ArrayList();
String[] sortKeys = sortKey.split(",");
String[] sortOrders = sortDir.split(",");
for (int i = 0; i < sortKeys.length; i++) {
UIColumn sortColumn = table.findColumn(sortKeys[i]);
String sortField = table.resolveColumnField(sortColumn);
multiSortMeta.add(
new SortMeta(
sortColumn,
sortField,
SortOrder.valueOf(convertSortOrderParam(sortOrders[i])),
sortColumn.getSortFunction()));
}
table.setMultiSortMeta(multiSortMeta);
}
else {
UIColumn sortColumn = table.findColumn(sortKey);
ValueExpression sortByVE = sortColumn.getValueExpression(Column.PropertyKeys.sortBy.toString());
table.setValueExpression(DataTable.PropertyKeys.sortBy.toString(), sortByVE);
table.setSortColumn(sortColumn);
table.setSortFunction(sortColumn.getSortFunction());
table.setSortOrder(convertSortOrderParam(sortDir));
table.setSortField(table.resolveColumnField(sortColumn));
}
}
@Override
public void encode(FacesContext context, DataTableRenderer renderer, DataTable table) throws IOException {
table.setFirst(0);
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 {
if (table.isMultiSort()) {
multiSort(context, table);
}
else {
singleSort(context, table);
}
if (table.isPaginator()) {
PrimeFaces.current().ajax().addCallbackParam("totalRecords", table.getRowCount());
}
//save state
Object filteredValue = table.getFilteredValue();
if (!table.isLazy() && table.isFilteringEnabled() && filteredValue != null) {
table.updateFilteredValue(context, (List) filteredValue);
}
}
renderer.encodeTbody(context, table, true);
if (table.isMultiViewState()) {
ValueExpression sortVE = table.getValueExpression(DataTable.PropertyKeys.sortBy.toString());
List multiSortMeta = table.isMultiSort() ? table.getMultiSortMeta() : null;
if (sortVE != null || multiSortMeta != null) {
TableState ts = table.getTableState(true);
ts.setSortBy(sortVE);
ts.setMultiSortMeta(multiSortMeta);
ts.setSortOrder(table.getSortOrder());
ts.setSortField(table.getSortField());
ts.setSortFunction(table.getSortFunction());
if (table.isPaginator()) {
ts.setFirst(table.getFirst());
ts.setRows(table.getRows());
}
}
}
}
public void singleSort(FacesContext context, DataTable table) {
Object value = table.getValue();
if (value == null) {
return;
}
ValueExpression sortVE = table.getValueExpression(DataTable.PropertyKeys.sortBy.toString());
SortOrder sortOrder = SortOrder.valueOf(table.getSortOrder().toUpperCase(Locale.ENGLISH));
MethodExpression sortFunction = table.getSortFunction();
List list = null;
UIColumn sortColumn = table.getSortColumn();
if (sortColumn != null && sortColumn.isDynamic()) {
((DynamicColumn) sortColumn).applyStatelessModel();
}
if (value instanceof List) {
list = (List) value;
}
else if (value instanceof ListDataModel) {
list = (List) ((ListDataModel) value).getWrappedData();
}
else {
throw new FacesException("Data type should be java.util.List or javax.faces.model.ListDataModel instance to be sortable.");
}
Collections.sort(list, new BeanPropertyComparator(
sortVE, table.getVar(), sortOrder, sortFunction, table.isCaseSensitiveSort(), table.resolveDataLocale(), table.getNullSortOrder()));
context.getApplication().publishEvent(context, PostSortEvent.class, table);
}
public void multiSort(FacesContext context, DataTable table) {
Object value = table.getValue();
List sortMeta = table.getMultiSortMeta();
List list = null;
boolean caseSensitiveSort = table.isCaseSensitiveSort();
Locale locale = table.resolveDataLocale();
int nullSortOrder = table.getNullSortOrder();
if (value == null) {
return;
}
if (value instanceof List) {
list = (List) value;
}
else if (value instanceof ListDataModel) {
list = (List) ((ListDataModel) value).getWrappedData();
}
else {
throw new FacesException("Data type should be java.util.List or javax.faces.model.ListDataModel instance to be sortable.");
}
ChainedBeanPropertyComparator chainedComparator = new ChainedBeanPropertyComparator();
for (SortMeta meta : sortMeta) {
BeanPropertyComparator comparator;
UIColumn sortColumn = meta.getColumn();
ValueExpression sortByVE = sortColumn.getValueExpression(Column.PropertyKeys.sortBy.toString());
if (sortColumn.isDynamic()) {
((DynamicColumn) sortColumn).applyStatelessModel();
comparator = new DynamicChainedPropertyComparator(
(DynamicColumn) sortColumn, sortByVE, table.getVar(),
meta.getSortOrder(), sortColumn.getSortFunction(), caseSensitiveSort, locale, nullSortOrder);
}
else {
comparator = new BeanPropertyComparator(sortByVE, table.getVar(),
meta.getSortOrder(), sortColumn.getSortFunction(), caseSensitiveSort, locale, nullSortOrder);
}
chainedComparator.addComparator(comparator);
}
Collections.sort(list, chainedComparator);
context.getApplication().publishEvent(context, PostSortEvent.class, table);
}
@Override
public boolean shouldDecode(FacesContext context, DataTable table) {
return isSortRequest(context, table);
}
@Override
public boolean shouldEncode(FacesContext context, DataTable table) {
return isSortRequest(context, table);
}
public String convertSortOrderParam(String order) {
String sortOrder = null;
int orderNumber = Integer.parseInt(order);
switch (orderNumber) {
case 0:
sortOrder = "UNSORTED";
break;
case 1:
sortOrder = "ASCENDING";
break;
case -1:
sortOrder = "DESCENDING";
break;
}
return sortOrder;
}
}