nl.vpro.domain.api.Result Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-domain Show documentation
Contains the objects used by the Frontend API, like forms and result objects
There is a newer version: 8.3.3
/*
 * Copyright (C) 2013 All rights reserved
 * VPRO The Netherlands
 */
package nl.vpro.domain.api;

import lombok.*;

import java.time.Duration;
import java.util.*;
import java.util.function.*;
import java.util.stream.Collector;
import java.util.stream.Stream;

import javax.xml.bind.annotation.*;

import org.checkerframework.checker.nullness.qual.NonNull;

import com.fasterxml.jackson.annotation.*;

import nl.vpro.domain.media.*;
import nl.vpro.domain.page.Page;

/**
 * @author Roelof Jan Koekoek
 * @since 2.0
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "resultType", propOrder = {"items"})
@XmlSeeAlso({Page.class, Program.class, Group.class, Segment.class, ApiScheduleEvent.class, Suggestion.class})
@JsonPropertyOrder({"total", "totalQualifier", "offset", "max", "items"})
@EqualsAndHashCode
public class Result implements Iterable {

    @XmlAttribute
    protected Long total;


    /**
     * The value of {@link #getTotal()} may  not be exact
     * @since 5.12
     */
    @XmlAttribute
    @Getter
    protected TotalQualifier totalQualifier = TotalQualifier.MISSING;

    @XmlAttribute
    protected Long offset = 0L;

    @XmlAttribute
    protected Integer max;

    @XmlElementWrapper(name = "items")
    @XmlElement(name = "item")
    @JsonProperty("items")
    @JsonInclude(JsonInclude.Include.ALWAYS)
    protected List items;

    @XmlTransient
    @Getter
    @Setter
    private Duration took;

    public Result() {
    }

    public Result(List items, Long offset, Integer max, Total total) {
        this.items = items;
        this.offset = offset;
        this.max = max;
        this.total = total.total;
        this.totalQualifier = total.qualifier;
    }

    public Result(Result copy) {
        this.items = copy.items;
        this.offset = copy.offset;
        this.max = copy.max;
        this.total = copy.total;
        this.totalQualifier = copy.totalQualifier;
    }

    public List getItems() {
        return items;
    }

    /**
     * The offset (base 0) of the list.
     */
    public Long getOffset() {
        return offset;
    }

    /**
     * The maximum size of this list as originally requested by the client.
     */
    public Integer getMax() {
        return max;
    }

    /**
     * The actual size of this list.
     */
    public Integer getSize() {
        return items == null ? 0 : items.size();
    }


    /**
     * The size of the list if no offset or max would have been applied.
     */
    public Long getTotal() {
        return total;
    }

    @NonNull
    @Override
    public Iterator iterator() {
        return items == null ? Collections.emptyIterator() : Collections.unmodifiableList(getItems()).iterator();
    }

    public Stream stream() {
        return items == null ? Stream.of() : items.stream();
    }

    public static  Collector, Result> collector() {
        return new Collector, Result>() {
            @Override
            public Supplier> supplier() {
                return ArrayList::new;

            }

            @Override
            public BiConsumer, T> accumulator() {
                return List::add;
            }

            @Override
            public BinaryOperator> combiner() {
                return (left,right) -> {left.addAll(right); return left;};

            }

            @Override
            public Function, Result> finisher() {
                return l -> new Result(l, null, null, new Total((long) l.size(), TotalQualifier.EQUAL_TO));
            }


            @Override
            public Set characteristics() {
                return Collections.emptySet();

            }
        };
    }

    @Override
    public String toString() {
        return "" + getItems();
    }


    /**
     * @since 5.12
     * @throws IndexOutOfBoundsException  if the index is out of range (index < 0 || index >= size())
     */
    public T get(int i) {
        return items.get(i);
    }

    /**
     * @since 5.12
     */
    public enum TotalQualifier {
        EQUAL_TO,
        APPROXIMATE,
        GREATER_THAN_OR_EQUAL_TO,
        MISSING
    }

    /**
     * @since 5.12
     */
    public static class Total {
        public static final Total EMPTY = equalsTo(0L);
        public static final Total MISSING = new Total(null, TotalQualifier.MISSING);

        public static Total equalsTo(Long total) {
            return new Total(total, TotalQualifier.EQUAL_TO);
        }
        public static Total equalsTo(int total) {
            return new Total((long) total, TotalQualifier.EQUAL_TO);
        }
        public static Total approximate(Long total) {
            return new Total(total, TotalQualifier.APPROXIMATE);
        }

        public static Total atLeast(Long total) {
            return new Total(total, TotalQualifier.GREATER_THAN_OR_EQUAL_TO);
        }

        final Long total;
        final TotalQualifier qualifier;

        public Total(Long total, TotalQualifier qualifier) {
            this.total = total;
            this.qualifier = qualifier;
        }
    }


}