Java tutorial
/** * Copyright 2005-2013 The Kuali Foundation * * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php * * 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.kuali.rice.krad.web.controller.helper; import org.apache.commons.collections.CollectionUtils; import org.apache.commons.lang.StringUtils; import org.kuali.rice.krad.uif.UifConstants; import org.kuali.rice.krad.uif.UifParameters; import org.kuali.rice.krad.uif.component.BindingInfo; import org.kuali.rice.krad.uif.container.CollectionGroup; import org.kuali.rice.krad.uif.layout.TableLayoutManager; import org.kuali.rice.krad.uif.util.ColumnSort; import org.kuali.rice.krad.uif.util.ComponentFactory; import org.kuali.rice.krad.uif.util.MultiColumnComparator; import org.kuali.rice.krad.uif.util.ObjectPropertyUtils; import org.kuali.rice.krad.uif.view.View; import org.kuali.rice.krad.web.form.UifFormBase; import javax.json.Json; import javax.json.JsonArray; import javax.json.JsonObject; import javax.json.JsonReader; import javax.servlet.http.HttpServletRequest; import java.io.StringReader; import java.util.ArrayList; import java.util.Arrays; import java.util.List; /** * @author Kuali Rice Team (rice.collab@kuali.org) */ public class DataTablesPagingHelper { private int totalCollectionSize; private Integer filteredCollectionSize; private TableLayoutManager tableLayoutManager; public void processPagingRequest(View view, String tableId, UifFormBase form, DataTablesInputs dataTablesInputs) { // Set property to trigger special JSON rendering logic in uifRender.ftl form.setRequestJsonTemplate(UifConstants.TableToolsValues.JSON_TEMPLATE); if (view != null) { // avoid blowing the stack if the session expired // don't set the component to update unless we have a postedView, otherwise we'll get an NPE later form.setUpdateComponentId(tableId); @SuppressWarnings("unchecked") List<ColumnSort> oldColumnSorts = (List<ColumnSort>) form.getExtensionData() .get(tableId + UifConstants.IdSuffixes.COLUMN_SORTS); // Create references that we'll need beyond the synchronized block here. CollectionGroup newCollectionGroup = null; List<Object> modelCollection = null; List<ColumnSort> newColumnSorts = null; synchronized (view) { // only one concurrent request per view please CollectionGroup oldCollectionGroup = (CollectionGroup) view.getViewIndex() .getComponentById(tableId); newColumnSorts = buildColumnSorts(dataTablesInputs, oldCollectionGroup); // get a new instance of the collection group component that we'll run the lifecycle on newCollectionGroup = (CollectionGroup) ComponentFactory .getNewInstanceForRefresh(form.getPostedView(), tableId); // copy over bindingInfo BindingInfo originalBindingInfo = newCollectionGroup.getBindingInfo(); newCollectionGroup.setBindingInfo(oldCollectionGroup.getBindingInfo()); // get the collection for this group from the model modelCollection = ObjectPropertyUtils.getPropertyValue(form, newCollectionGroup.getBindingInfo() .getPropertyAdjustedBindingPath(newCollectionGroup.getPropertyName())); applyTableJsonSort(modelCollection, oldColumnSorts, newColumnSorts, oldCollectionGroup, view); // set up the collection group properties related to paging in the collection group to set the bounds for // what needs to be rendered newCollectionGroup.setUseServerPaging(true); newCollectionGroup.setDisplayStart(dataTablesInputs.iDisplayStart); newCollectionGroup.setDisplayLength(dataTablesInputs.iDisplayLength); // set back original binding info newCollectionGroup.setBindingInfo(originalBindingInfo); // run lifecycle on the table component and update in view view.getViewHelperService().performComponentLifecycle(view, form, newCollectionGroup, oldCollectionGroup.getId()); } this.tableLayoutManager = (TableLayoutManager) newCollectionGroup.getLayoutManager(); this.filteredCollectionSize = newCollectionGroup.getFilteredCollectionSize(); this.totalCollectionSize = modelCollection.size(); // these other params above don't need to stay in the form after this request, but <tableId>_columnSorts // does so that we avoid re-sorting on each request. form.getExtensionData().put(tableId + "_columnSorts", newColumnSorts); } } /** * Extract the sorting information from the DataTablesInputs into a more generic form. * * @param dataTablesInputs the parsed request data from dataTables * @return the List of ColumnSort elements representing the requested sort columns, types, and directions */ private List<ColumnSort> buildColumnSorts(DataTablesInputs dataTablesInputs, CollectionGroup collectionGroup) { int[] sortCols = dataTablesInputs.iSortCol_; // cols being sorted on (for multi-col sort) boolean[] sortable = dataTablesInputs.bSortable_; // which columns are sortable String[] sortDir = dataTablesInputs.sSortDir_; // direction to sort // parse table options to gather the sort types String aoColumnDefsValue = ((TableLayoutManager) collectionGroup.getLayoutManager()).getRichTable() .getTemplateOptions().get(UifConstants.TableToolsKeys.AO_COLUMN_DEFS); JsonArray jsonColumnDefs = null; if (!StringUtils.isEmpty(aoColumnDefsValue)) { // we'll parse this using a JSON library to make things simpler // function definitions are not allowed in JSON aoColumnDefsValue = aoColumnDefsValue.replaceAll("function\\([^)]*\\)\\s*\\{[^}]*\\}", "\"REDACTED\""); JsonReader jsonReader = Json.createReader(new StringReader(aoColumnDefsValue)); jsonColumnDefs = jsonReader.readArray(); } List<ColumnSort> columnSorts = new ArrayList<ColumnSort>(sortCols.length); for (int sortColsIndex = 0; sortColsIndex < sortCols.length; sortColsIndex++) { int sortCol = sortCols[sortColsIndex]; // get the index of the column being sorted on if (sortable[sortCol]) { String sortType = getSortType(jsonColumnDefs, sortCol); ColumnSort.Direction sortDirection = ColumnSort.Direction .valueOf(sortDir[sortColsIndex].toUpperCase()); columnSorts.add(new ColumnSort(sortCol, sortDirection, sortType)); } } return columnSorts; } /** * Get the sort type string from the parsed column definitions object. * * @param jsonColumnDefs the JsonArray representation of the aoColumnDefs property from the RichTable template * options * @param sortCol the index of the column to get the sort type for * @return the name of the sort type specified in the template options, or the default of "string" if none is * found. */ private String getSortType(JsonArray jsonColumnDefs, int sortCol) { String sortType = "string"; // default to string if nothing is spec'd if (jsonColumnDefs != null) { JsonObject column = jsonColumnDefs.getJsonObject(sortCol); if (column.containsKey("sType")) { sortType = column.getString("sType"); } } return sortType; } /** * Sort the given modelCollection (in place) according to the specified columnSorts. * * <p>Not all columns will necessarily be directly mapped to the modelCollection, so the collectionGroup and view * are available as well for use in calculating those other column values. However, if all the columns are in fact * mapped to the elements of the modelCollection, subclasses should be able to easily override this method to * provide custom sorting logic.</p> * * <p> * Create an index array and sort that. The array slots represents the slots in the modelCollection, and * the values are indices to the elements in the modelCollection. At the end, we'll re-order the * modelCollection so that the elements are in the collection slots that correspond to the array locations. * * A small example may be in order. Here's the incoming modelCollection: * * modelCollection = { "Washington, George", "Adams, John", "Jefferson, Thomas", "Madison, James" } * * Initialize the array with its element references all matching initial positions in the modelCollection: * * reSortIndices = { 0, 1, 2, 3 } * * After doing our sort in the array (where we sort indices based on the values in the modelCollection): * * reSortIndices = { 1, 2, 3, 0 } * * Then, we go back and apply that ordering to the modelCollection: * * modelCollection = { "Adams, John", "Jefferson, Thomas", "Madison, James", "Washington, George" } * * Why do it this way instead of just sorting the modelCollection directly? Because we may need to know * the original index of the element e.g. for the auto sequence column. * </p> * * @param modelCollection the collection to sort * @param oldColumnSorts the sorting that reflects the current state of the collection * @param newColumnSorts the sorting to apply to the collection * @param collectionGroup the CollectionGroup that is being rendered * @param view the view */ protected void applyTableJsonSort(List<Object> modelCollection, List<ColumnSort> oldColumnSorts, List<ColumnSort> newColumnSorts, CollectionGroup collectionGroup, View view) { boolean isCollectionEmpty = CollectionUtils.isEmpty(modelCollection); boolean isSortingSpecified = !CollectionUtils.isEmpty(newColumnSorts); boolean isSortOrderChanged = newColumnSorts != oldColumnSorts && !newColumnSorts.equals(oldColumnSorts); if (!isCollectionEmpty && isSortingSpecified && isSortOrderChanged) { Integer[] sortIndices = new Integer[modelCollection.size()]; for (int i = 0; i < sortIndices.length; i++) { sortIndices[i] = i; } Arrays.sort(sortIndices, new MultiColumnComparator(modelCollection, collectionGroup, newColumnSorts, view)); // apply the sort to the modelCollection Object[] sorted = new Object[sortIndices.length]; for (int i = 0; i < sortIndices.length; i++) { sorted[i] = modelCollection.get(sortIndices[i]); } for (int i = 0; i < sorted.length; i++) { modelCollection.set(i, sorted[i]); } } } public int getTotalCollectionSize() { return totalCollectionSize; } public Integer getFilteredCollectionSize() { return filteredCollectionSize; } public TableLayoutManager getTableLayoutManager() { return tableLayoutManager; } /** * Input command processor for supporting DataTables server-side processing. * * @see <a href="http://datatables.net/usage/server-side">http://datatables.net/usage/server-side</a> */ public static class DataTablesInputs { private static final String DISPLAY_START = "iDisplayStart"; private static final String DISPLAY_LENGTH = "iDisplayLength"; private static final String COLUMNS = "iColumns"; private static final String REGEX = "bRegex"; private static final String REGEX_PREFIX = "bRegex_"; private static final String SORTABLE_PREFIX = "bSortable_"; private static final String SORTING_COLS = "iSortingCols"; private static final String SORT_COL_PREFIX = "iSortCol_"; private static final String SORT_DIR_PREFIX = "sSortDir_"; private static final String DATA_PROP_PREFIX = "mDataProp_"; private static final String ECHO = "sEcho"; private final int iDisplayStart, iDisplayLength, iColumns, iSortingCols, sEcho; // TODO: All search related options are commented out of this class. // If we implement search for datatables we'll want to re-activate that code to capture the configuration // values from the request // private final String sSearch; // private final Pattern patSearch; private final boolean bRegex; private final boolean[] /*bSearchable_,*/ bRegex_, bSortable_; private final String[] /*sSearch_,*/ sSortDir_, mDataProp_; // private final Pattern[] patSearch_; private final int[] iSortCol_; public DataTablesInputs(HttpServletRequest request) { String s; iDisplayStart = (s = request.getParameter(DISPLAY_START)) == null ? 0 : Integer.parseInt(s); iDisplayLength = (s = request.getParameter(DISPLAY_LENGTH)) == null ? 0 : Integer.parseInt(s); iColumns = (s = request.getParameter(COLUMNS)) == null ? 0 : Integer.parseInt(s); bRegex = (s = request.getParameter(REGEX)) == null ? false : new Boolean(s); // patSearch = (sSearch = request.getParameter("sSearch")) == null // || !bRegex ? null : Pattern.compile(sSearch); // bSearchable_ = new boolean[iColumns]; // sSearch_ = new String[iColumns]; // patSearch_ = new Pattern[iColumns]; bRegex_ = new boolean[iColumns]; bSortable_ = new boolean[iColumns]; for (int i = 0; i < iColumns; i++) { // bSearchable_[i] = (s = request.getParameter("bSearchable_" + i)) == null ? false // : new Boolean(s); bRegex_[i] = (s = request.getParameter(REGEX_PREFIX + i)) == null ? false : new Boolean(s); // patSearch_[i] = (sSearch_[i] = request.getParameter("sSearch_" // + i)) == null // || !bRegex_[i] ? null : Pattern.compile(sSearch_[i]); bSortable_[i] = (s = request.getParameter(SORTABLE_PREFIX + i)) == null ? false : new Boolean(s); } iSortingCols = (s = request.getParameter(SORTING_COLS)) == null ? 0 : Integer.parseInt(s); iSortCol_ = new int[iSortingCols]; sSortDir_ = new String[iSortingCols]; for (int i = 0; i < iSortingCols; i++) { iSortCol_[i] = (s = request.getParameter(SORT_COL_PREFIX + i)) == null ? 0 : Integer.parseInt(s); sSortDir_[i] = request.getParameter(SORT_DIR_PREFIX + i); } mDataProp_ = new String[iColumns]; for (int i = 0; i < iColumns; i++) { mDataProp_[i] = request.getParameter(DATA_PROP_PREFIX + i); } sEcho = (s = request.getParameter(ECHO)) == null ? 0 : Integer.parseInt(s); } @Override public String toString() { StringBuilder sb = new StringBuilder(super.toString()); sb.append("\n\t" + DISPLAY_START + " = "); sb.append(iDisplayStart); sb.append("\n\t" + DISPLAY_LENGTH + " = "); sb.append(iDisplayLength); sb.append("\n\t" + COLUMNS + " = "); sb.append(iColumns); // sb.append("\n\tsSearch = "); // sb.append(sSearch); sb.append("\n\t" + REGEX + " = "); sb.append(bRegex); for (int i = 0; i < iColumns; i++) { // sb.append("\n\tbSearchable_").append(i).append(" = "); // sb.append(bSearchable_[i]); // sb.append("\n\tsSearch_").append(i).append(" = "); // sb.append(sSearch_[i]); sb.append("\n\t").append(REGEX_PREFIX).append(i).append(" = "); sb.append(bRegex_[i]); sb.append("\n\t").append(SORTABLE_PREFIX).append(i).append(" = "); sb.append(bSortable_[i]); } sb.append("\n\t").append(SORTING_COLS); sb.append(iSortingCols); for (int i = 0; i < iSortingCols; i++) { sb.append("\n\t").append(SORT_COL_PREFIX).append(i).append(" = "); sb.append(iSortCol_[i]); sb.append("\n\t").append(SORT_DIR_PREFIX).append(i).append(" = "); sb.append(sSortDir_[i]); } for (int i = 0; i < iColumns; i++) { sb.append("\n\t").append(DATA_PROP_PREFIX).append(i).append(" = "); sb.append(mDataProp_[i]); } sb.append("\n\t" + ECHO + " = "); sb.append(sEcho); return sb.toString(); } } }