io.micronaut.data.model.Page Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-data-model Show documentation
Data Repository Support for Micronaut
The newest version!
/*
 * Copyright 2017-2020 original 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
 *
 * https://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 io.micronaut.data.model;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.micronaut.context.annotation.DefaultImplementation;
import io.micronaut.core.annotation.Internal;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.annotation.ReflectiveAccess;
import io.micronaut.core.annotation.TypeHint;
import io.micronaut.data.model.Pageable.Cursor;
import io.micronaut.serde.annotation.Serdeable;

import java.util.Collections;
import java.util.List;
import java.util.function.Function;

/**
 * Inspired by the Spring Data's {@code Page} and GORM's {@code PagedResultList}, this models a type that supports
 * pagination operations.
 *
 * A Page is a result set associated with a particular {@link Pageable} that includes a calculation of the total
 * size of page of records.
 *
 * @param  The generic type
 * @author graemerocher
 * @since 1.0.0
 */
@JsonIgnoreProperties(ignoreUnknown = true)
@TypeHint(Page.class)
@JsonDeserialize(as = DefaultPage.class)
@Serdeable
@DefaultImplementation(DefaultPage.class)
public interface Page extends Slice {

    Page EMPTY = new DefaultPage<>(Collections.emptyList(), Pageable.unpaged(), -1L);

    /**
     * @return Whether this {@link Page} contains the total count of the records
     * @since 4.8.0
     */
    boolean hasTotalSize();

    /**
     * Get the total count of all the records that can be given by this query.
     * The method may produce a {@link IllegalStateException} if the {@link Pageable} request
     * did not ask for total size.
     * For {@link #EMPTY} page the value is -1.
     *
     * @return The total size of the all records.
     */
    long getTotalSize();

    /**
     * Get the total count of pages that can be given by this query.
     * The method may produce a {@link IllegalStateException} if the {@link Pageable} request
     * did not ask for total size.
     *
     * @return The total page of pages
     */
    default int getTotalPages() {
        int size = getSize();
        return size == 0 ? 1 : (int) Math.ceil((double) getTotalSize() / (double) size);
    }

    @Override
    default boolean hasNext() {
        return hasTotalSize()
            ? getOffset() + getSize() < getTotalSize()
            : getContent().size() == getSize();
    }

    /**
     * Maps the content with the given function.
     *
     * @param function The function to apply to each element in the content.
     * @param  The type returned by the function
     * @return A new slice with the mapped content
     */
    @Override
    default @NonNull  Page map(Function function) {
        if (this == EMPTY) {
            return (Page) EMPTY;
        }
        List content = getContent().stream().map(function).toList();
        return new DefaultPage<>(content, getPageable(), hasTotalSize() ? getTotalSize() : null);
    }

    /**
     * Creates a page from the given content, pageable and totalSize.
     *
     * @param content The content
     * @param pageable The pageable
     * @param totalSize The total size
     * @param  The generic type
     * @return The slice
     */
    @ReflectiveAccess
    static @NonNull  Page of(
            @JsonProperty("content") @NonNull List content,
            @JsonProperty("pageable") @NonNull Pageable pageable,
            @JsonProperty("totalSize") @Nullable Long totalSize
    ) {
        return new DefaultPage<>(content, pageable, totalSize);
    }

    /**
     * Creates a page from the given content, pageable, cursors and totalSize.
     * This method is for JSON deserialization. Please use {@link CursoredPage#of} instead.
     *
     * @param content The content
     * @param pageable The pageable
     * @param cursors The cursors for cursored pagination
     * @param totalSize The total size
     * @param  The generic type
     * @return The slice
     */
    @JsonCreator
    @Internal
    @ReflectiveAccess
    static @NonNull  Page ofCursors(
        @JsonProperty("content") @NonNull List content,
        @JsonProperty("pageable") @NonNull Pageable pageable,
        @JsonProperty("cursors") @Nullable List cursors,
        @JsonProperty("totalSize") @Nullable Long totalSize
    ) {
        if (cursors == null) {
            return new DefaultPage<>(content, pageable, totalSize);
        }
        return new DefaultCursoredPage<>(content, pageable, cursors, totalSize);
    }

    /**
     * Creates an empty page object.
     * @param  The generic type
     * @return The slice
     */
    @SuppressWarnings("unchecked")
    static @NonNull  Page empty() {
        return (Page) EMPTY;
    }
}