aboutsummaryrefslogtreecommitdiffstats
path: root/server/src/main/java/com/vaadin/data/provider/BackEndDataProvider.java
blob: 2ceebc995aa02ab447c8f3a60d3f83b943af1932 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*
 * Copyright 2000-2016 Vaadin Ltd.
 *
 * 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 com.vaadin.data.provider;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.stream.Stream;

import com.vaadin.server.SerializableFunction;
import com.vaadin.shared.Registration;

/**
 * A {@link DataProvider} for any back end.
 *
 * @param <T>
 *            data provider data type
 * @param <F>
 *            data provider filter type
 */
public class BackEndDataProvider<T, F> extends AbstractDataProvider<T, F> {

    private final SerializableFunction<Query<T, F>, Stream<T>> request;
    private final SerializableFunction<Query<T, F>, Integer> sizeCallback;

    /**
     * Constructs a new DataProvider to request data from an arbitrary back end
     * request function.
     *
     * @param request
     *            function that requests data from back end based on query
     * @param sizeCallback
     *            function that return the amount of data in back end for query
     */
    public BackEndDataProvider(
            SerializableFunction<Query<T, F>, Stream<T>> request,
            SerializableFunction<Query<T, F>, Integer> sizeCallback) {
        Objects.requireNonNull(request, "Request function can't be null");
        Objects.requireNonNull(sizeCallback, "Size callback can't be null");
        this.request = request;
        this.sizeCallback = sizeCallback;
    }

    @Override
    public Stream<T> fetch(Query<T, F> query) {
        return request.apply(query);
    }

    @Override
    public int size(Query<T, F> query) {
        return sizeCallback.apply(query);
    }

    /**
     * Sets a default sorting order to the data provider.
     *
     * @param sortOrders
     *            a list of sorting information containing field ids and
     *            directions
     * @return new data provider with modified sorting
     */
    @SuppressWarnings("serial")
    public BackEndDataProvider<T, F> sortingBy(
            List<SortOrder<String>> sortOrders) {
        BackEndDataProvider<T, F> parent = this;
        return new BackEndDataProvider<T, F>(query -> {
            List<SortOrder<String>> queryOrder = new ArrayList<>(
                    query.getSortOrders());
            queryOrder.addAll(sortOrders);
            return parent.fetch(new Query<>(query.getOffset(), query.getLimit(),
                    queryOrder, query.getInMemorySorting(),
                    query.getFilter().orElse(null)));
        }, sizeCallback) {

            @Override
            public Registration addDataProviderListener(
                    DataProviderListener listener) {
                return parent.addDataProviderListener(listener);
            }

            @Override
            public void refreshAll() {
                parent.refreshAll();
            }
        };
    }

    @Override
    public boolean isInMemory() {
        return false;
    }

}