paginationcallback.java

分页查询控件 分页查询控件

/*
 * Copyright 2004 original author or authors.
 *
 * 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.extremecomponents.table.callback;

import java.util.Collection;

import org.extremecomponents.base.BaseModel;
import org.extremecomponents.table.bean.Table;
import org.extremecomponents.util.ExtremeUtils;

/**
 * Handles the pagination feature.
 * 
 * @author Jeff Johnston
 */
public final class PaginationCallback implements RetrieveRowsCallback, FilterRowsCallback, SortRowsCallback {
    public final static String TOTAL_ROWS = "totalRows";

    /**
     * Retrieve the collection from the given scope. Requires that a variable be
     * passed in from any of the web scopes (page, request, session,
     * application) that is called "totalRows". The totalRows is a Integer
     * value.
     */
    public Collection retrieveRows(BaseModel model)
            throws Exception {
        Table table = model.getTableHandler().getTable();
        Collection rows = (Collection) ExtremeUtils.retrieveFromScope(model.getPageContext(), table.getCollection(), table
                .getScope());
        
        Object totalRows = ExtremeUtils.retrieveFromScope(model.getPageContext(), TOTAL_ROWS);
        if (totalRows == null) {
            totalRows = (Integer) ExtremeUtils.retrieveFromScope(model.getPageContext(), table.getCollection() + "_" + TOTAL_ROWS);
        }
        
        if (totalRows instanceof Integer) {
            model.getTableHandler().setTotalRows(((Integer)totalRows).intValue());
        } else {
            String message = "You need to specify the " + TOTAL_ROWS + " (as an Integer) to use the " + this.getClass().getName() + ".";
            throw new Exception(message);
        }
        
        return rows;
    }

    public Collection filterRows(BaseModel model, Collection rows)
            throws Exception {
        return rows;
    }

    public Collection sortRows(BaseModel model, Collection rows)
            throws Exception {
        return rows;
    }
}