com.thinkmore.framework.orm.Page.java Source code

Introduction

Here is the source code for com.thinkmore.framework.orm.Page.java

Source

/**
 * Copyright (c) 2005-2009 springside.org.cn
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 
 * $Id: Page.java 763 2009-12-27 18:36:21Z calvinxiu $
 */
package com.thinkmore.framework.orm;

import java.util.Collections;
import java.util.List;
import org.apache.commons.lang3.StringUtils;
import org.springframework.jdbc.core.JdbcTemplate;

/**
 * ORM???. ???1.
 * 
 * @param <T>
 *            Page.
 * 
 * @author calvin
 */
public class Page<T> {
    // -- ?? --//
    public static final String ASC = "asc";
    public static final String DESC = "desc";
    // -- ? --//
    protected int pageNo = 1;
    protected int pageSize = 20;
    protected String orderBy = null;
    protected String order = null;
    protected boolean autoCount = true;
    // --  --//
    protected List<?> result = Collections.emptyList();
    protected long totalCount = -1;
    private JdbcTemplate jdbcTemplate;

    // --  --//
    private Page() {
    }

    public Page(int pageNo) {
        this.setPageNo(pageNo);
    }

    public Page(int pageNo, int pageSize) {
        this.setPageNo(pageNo);
        this.setPageSize(pageSize);
    }

    // -- ? --//
    /**
     * ??,??1,1.
     */
    public int getPageNo() {
        return pageNo;
    }

    /**
     * ??,??1,11.
     */
    public void setPageNo(final int pageNo) {
        if (pageNo < 1) {
            this.pageNo = 1;
        } else {
            this.pageNo = pageNo;
        }
    }

    public Page<T> pageNo(final int thePageNo) {
        setPageNo(thePageNo);
        return this;
    }

    /**
     * ??,1.
     */
    public int getPageSize() {
        return pageSize;
    }

    /**
     * ??,11.
     */
    public void setPageSize(final int pageSize) {
        this.pageSize = pageSize;
        if (pageSize < 1) {
            this.pageSize = 1;
        }
    }

    public Page<T> pageSize(final int thePageSize) {
        setPageSize(thePageSize);
        return this;
    }

    /**
     * ?pageNopageSize???,??1.
     */
    public int getFirst() {
        return ((pageNo - 1) * pageSize) + 1;
    }

    /**
     * ?,.?','.
     */
    public String getOrderBy() {
        return orderBy;
    }

    /**
     * ?,?','.
     */
    public void setOrderBy(final String orderBy) {
        this.orderBy = orderBy;
    }

    public Page<T> orderBy(final String theOrderBy) {
        setOrderBy(theOrderBy);
        return this;
    }

    /**
     * ??.
     */
    public String getOrder() {
        return order;
    }

    /**
     * ???.
     * 
     * @param order
     *            ?descasc,?','.
     */
    public void setOrder(final String order) {
        // order?
        String[] orders = StringUtils.split(StringUtils.lowerCase(order), ',');
        for (String orderStr : orders) {
            if (!StringUtils.equals(DESC, orderStr) && !StringUtils.equals(ASC, orderStr)) {
                throw new IllegalArgumentException("??" + orderStr + "??");
            }
        }
        this.order = StringUtils.lowerCase(order);
    }

    public Page<T> order(final String theOrder) {
        setOrder(theOrder);
        return this;
    }

    /**
     * ??,.
     */
    public boolean isOrderBySetted() {
        return (StringUtils.isNotBlank(orderBy) && StringUtils.isNotBlank(order));
    }

    /**
     * ??count?, false.
     */
    public boolean isAutoCount() {
        return autoCount;
    }

    /**
     * ??count?.
     */
    public void setAutoCount(final boolean autoCount) {
        this.autoCount = autoCount;
    }

    public Page<T> autoCount(final boolean theAutoCount) {
        setAutoCount(theAutoCount);
        return this;
    }

    // --  --//
    /**
     * ?.
     */
    public List<?> getResult() {
        return result;
    }

    /**
     * .
     */
    public void setResult(final List<?> result) {
        this.result = result;
    }

    /**
     * ?, -1.
     */
    public long getTotalCount() {
        return totalCount;
    }

    /**
     * .
     */
    public void setTotalCount(final long totalCount) {
        this.totalCount = totalCount;
    }

    /**
     * ?pageSizetotalCount, -1.
     */
    public long getTotalPages() {
        if (totalCount < 0) {
            return -1;
        }
        long count = totalCount / pageSize;
        if (totalCount % pageSize > 0) {
            count++;
        }
        return count;
    }

    /**
     * ?.
     */
    public boolean isHasNext() {
        return (pageNo + 1 <= getTotalPages());
    }

    /**
     * ??, ??1. ????.
     */
    public int getNextPage() {
        if (isHasNext()) {
            return pageNo + 1;
        } else {
            return pageNo;
        }
    }

    /**
     * ?.
     */
    public boolean isHasPre() {
        return (pageNo - 1 >= 1);
    }

    /**
     * ??, ??1. ???.
     */
    public int getPrePage() {
        if (isHasPre()) {
            return pageNo - 1;
        } else {
            return pageNo;
        }
    }

    public JdbcTemplate getJdbcTemplate() {
        return jdbcTemplate;
    }

    public void setJdbcTemplate(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }
}