/*
* Copyright 2009-2014 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.component.api.DynamicColumn;
import org.primefaces.component.api.UIColumn;
import org.primefaces.component.datatable.DataTable;
import org.primefaces.component.datatable.DataTableRenderer;
import org.primefaces.context.RequestContext;
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");
}
public void decode(FacesContext context, DataTable table) {
table.setRowIndex(-1);
String clientId = table.getClientId(context);
Map<String,String> params = context.getExternalContext().getRequestParameterMap();
String sortKey = params.get(clientId + "_sortKey");
String sortDir = params.get(clientId + "_sortDir");
if(table.isMultiSort()) {
List<SortMeta> multiSortMeta = new ArrayList<SortMeta>();
String[] sortKeys = sortKey.split(",");
String[] sortOrders = sortDir.split(",");
for(int i = 0; i < sortKeys.length; i++) {
UIColumn sortColumn = table.findColumn(sortKeys[i]);
ValueExpression columnSortByVE = sortColumn.getValueExpression("sortBy");
String sortField;
if(sortColumn.isDynamic()) {
((DynamicColumn) sortColumn).applyStatelessModel();
String field = sortColumn.getField();
if(field == null)
sortField = table.resolveDynamicField(columnSortByVE);
else
sortField = field;
}
else {
String field = sortColumn.getField();
if(field == null)
sortField = table.resolveStaticField(columnSortByVE);
else
sortField = field;
}
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("sortBy");
table.setValueExpression("sortBy", sortByVE);
table.setSortColumn(sortColumn);
table.setSortFunction(sortColumn.getSortFunction());
table.setSortOrder(convertSortOrderParam(sortDir));
table.setSortField(sortColumn.getField());
}
}
public void encode(FacesContext context, DataTableRenderer renderer, DataTable table) throws IOException {
table.setFirst(0);
if(table.isLazy()) {
table.loadLazyData();
}
else {
if(table.isMultiSort())
multiSort(context, table);
else
singleSort(context, table);
if(table.isPaginator()) {
RequestContext requestContext = RequestContext.getCurrentInstance();
if(requestContext != null) {
requestContext.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);
}
public void singleSort(FacesContext context, DataTable table) {
Object value = table.getValue();
if(value == null)
return;
ValueExpression sortByVE = table.getValueExpression("sortBy");
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(sortByVE, table.getVar(), sortOrder, sortFunction, table.isCaseSensitiveSort(), table.resolveDataLocale(), table.getNullSortOrder()));
}
public void multiSort(FacesContext context, DataTable table) {
Object value = table.getValue();
List<SortMeta> 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("sortBy");
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);
}
public boolean shouldDecode(FacesContext context, DataTable table) {
return isSortRequest(context, table);
}
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;
}
}