View Javadoc
1   /**
2    * This file Copyright (c) 2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.task.app;
35  
36  import info.magnolia.context.Context;
37  import info.magnolia.jcr.util.NodeTypes;
38  import info.magnolia.task.Task;
39  import info.magnolia.task.TasksManager;
40  import info.magnolia.task.app.data.TaskCategory;
41  import info.magnolia.ui.contentapp.DataFilter;
42  
43  import java.util.Arrays;
44  import java.util.List;
45  import java.util.Map;
46  import java.util.stream.Collectors;
47  import java.util.stream.Stream;
48  
49  import javax.inject.Provider;
50  
51  import com.vaadin.data.provider.AbstractDataProvider;
52  import com.vaadin.data.provider.Query;
53  import com.vaadin.data.provider.QuerySortOrder;
54  import com.vaadin.shared.data.sort.SortDirection;
55  
56  /**
57   * {@link AbstractDataProvider} implementation capable of serving {@link Task} objects via {@link TasksManager}.
58   */
59  public class TasksDataProvider extends AbstractDataProvider<Task, DataFilter> {
60  
61      private static final List<Task.Status> ALL_STATUSES = Arrays.asList(Task.Status.values());
62      private static final List<Task.Status> UNCLAIMED_STATUS = Arrays.asList(Task.Status.Created);
63      private static final List<Task.Status> ONGOING_STATUS = Arrays.asList(Task.Status.InProgress);
64      private static final List<Task.Status> DONE_STATUS = Arrays.asList(Task.Status.Resolved);
65      private static final List<Task.Status> FAILED_STATUS = Arrays.asList(Task.Status.Failed);
66      private static final List<Task.Status> SCHEDULED_STATUS = Arrays.asList(Task.Status.Scheduled);
67  
68      private final TasksManager tasksManager;
69      private final Provider<Context> contextProvider;
70      private List<Task.Status> displayedTaskStatus = ALL_STATUSES;
71  
72      public TasksDataProvider(TasksManager tasksManager, Provider<Context> contextProvider, TaskCategory category) {
73          this.tasksManager = tasksManager;
74          this.contextProvider = contextProvider;
75  
76          if (category != null) {
77              switch (category) {
78              case UNCLAIMED:
79                  displayedTaskStatus = UNCLAIMED_STATUS;
80                  break;
81              case ONGOING:
82                  displayedTaskStatus = ONGOING_STATUS;
83                  break;
84              case DONE:
85                  displayedTaskStatus = DONE_STATUS;
86                  break;
87              case FAILED:
88                  displayedTaskStatus = FAILED_STATUS;
89                  break;
90              case SCHEDULED:
91                  displayedTaskStatus = SCHEDULED_STATUS;
92                  break;
93              }
94          }
95      }
96  
97      long size() {
98          return tasksManager.getTasksAmountByUserAndStatus(contextProvider.get().getUser().getName(), displayedTaskStatus);
99      }
100 
101     @Override
102     public Stream<Task> fetch(Query<Task, DataFilter> query) {
103         final Map<String, Boolean> sortCriteria = query.getSortOrders().stream()
104                 .collect(Collectors.toMap(QuerySortOrder::getSorted, so -> so.getDirection() == SortDirection.ASCENDING ? Boolean.TRUE : Boolean.FALSE, (a, b) -> b));
105 
106         // by default, sort result set by timestamp
107         if (sortCriteria.isEmpty()) {
108             sortCriteria.put(NodeTypes.LastModified.NAME, true);
109         }
110 
111         return tasksManager
112                 .findTasksByUserAndStatus(contextProvider.get().getUser().getName(), displayedTaskStatus, sortCriteria, query.getLimit(), query.getOffset())
113                 .stream()
114                 .filter(task -> query.getFilter()
115                         .map(dataFilter -> task.getPath().equals(dataFilter.getPathFilter()))
116                         .orElse(true)
117                 );
118     }
119 
120     @Override
121     public boolean isInMemory() {
122         return true;
123     }
124 
125     @Override
126     public int size(Query<Task, DataFilter> query) {
127         // not nice but legal and unlikely to break unless a user wants to
128         // keep 2147483647+1 tasks  w/o never cleaning up
129         return (int) size();
130     }
131 }