org.fastquery.page.Page Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fastquery Show documentation
Method of fast database query in complicated environment.
The newest version!
/*
 * Copyright (c) 2016-2088, fastquery.org and/or its affiliates. All rights reserved.
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 *
 * For more information, please see http://www.fastquery.org/.
 *
 */

package org.fastquery.page;

import java.util.List;

/**
 * @author xixifeng ([email protected])
 */
public interface Page
{

    /**
     * 每页行数
     *
     * @return 每页行数
     */
    int getSize();

    /**
     * 当前页的真实记录行数
     *
     * @return 当前页的真实记录行数
     */
    int getNumberOfElements();

    /**
     * 当前页码,从1开始
     *
     * @return 当前页码, 从1开始
     */
    int getNumber();

    /**
     * 当前页的结果集
     *
     * @return 当前页的结果集
     */
    List getContent();

    /**
     * 总行数,注意:如果在不求和的情况下,返回-1.
     *
     * @return 总行数
     */
    long getTotalElements();

    /**
     * 总页码,注意:如果在不求和的情况下,返回-1.

     * 不求总行数,总页数没有办法推算出来.
     *
     * @return 总页数
     */
    int getTotalPages();

    /**
     * 是否有结果集
     *
     * @return 是否有结果集
     */
    boolean isHasContent();

    /**
     * 是否有下一页
     *
     * @return 是否有下一页
     */
    boolean isHasNext();

    /**
     * 是否有上一页
     *
     * @return 是否有上一页
     */
    boolean isHasPrevious();

    /**
     * 是否是第一页
     *
     * @return 是否是第一页
     */
    boolean isFirst();

    /**
     * 是否是最后一页
     *
     * @return 是否是最后一页
     */
    boolean isLast();

    /**
     * 下一页的 {@link Slice}
     *
     * @return 下一页的 {@link Slice}
     */
    Slice getNextPageable();

    /**
     * 上一页的 {@link Slice}
     *
     * @return 上一页的 {@link Slice}
     */
    Slice getPreviousPageable();

    /**
     * 将当前 E 类型的 Page 转换成 T 类型的 -vPage
     *
     * @param    另一个类型
     * @param clazz 类型
     * @return 一个新的 Page 包含 T 类型的实例
     */
     Page convert(Class clazz);
}