View Javadoc
1   /**
2    * This file Copyright (c) 2015-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.ui.admincentral.shellapp.pulse.task.data;
35  
36  import info.magnolia.objectfactory.Components;
37  import info.magnolia.task.Task;
38  import info.magnolia.task.TasksManager;
39  import info.magnolia.task.definition.registry.TaskDefinitionRegistry;
40  import info.magnolia.ui.admincentral.shellapp.pulse.data.LazyPulseQuery;
41  import info.magnolia.ui.admincentral.shellapp.pulse.data.PulseConstants;
42  import info.magnolia.ui.admincentral.shellapp.pulse.task.TaskTypeHelper;
43  
44  import java.util.Date;
45  import java.util.List;
46  
47  import javax.inject.Inject;
48  
49  import org.apache.commons.lang3.StringUtils;
50  import org.slf4j.Logger;
51  import org.slf4j.LoggerFactory;
52  
53  import com.vaadin.data.Item;
54  import com.vaadin.data.util.ObjectProperty;
55  
56  /**
57   * {@link LazyPulseQuery} implementation which serves {@link Task} objects via {@link TasksManager}.
58   */
59  public class TaskQuery extends LazyPulseQuery<Task.Status, Task> {
60  
61      private static final Logger log = LoggerFactory.getLogger(TaskQuery.class);
62  
63      private TasksManager tasksManager;
64  
65      private TaskTypeHelper taskTypeHelper;
66  
67      @Inject
68      public TaskQuery(TasksManager tasksManager, TaskQueryDefinition queryDefinition, TaskTypeHelper taskTypeHelper) {
69          super(queryDefinition);
70          this.tasksManager = tasksManager;
71          this.taskTypeHelper = taskTypeHelper;
72      }
73  
74      /**
75       * @deprecated since 5.4.12, {@link TaskQuery#TaskQuery(TasksManager, TaskQueryDefinition, TaskTypeHelper)} is used instead.
76       */
77      @Deprecated
78      public TaskQuery(TasksManager tasksManager, TaskDefinitionRegistry taskDefinitionRegistry, TaskQueryDefinition queryDefinition) {
79          this(tasksManager, queryDefinition, Components.getComponent(TaskTypeHelper.class));
80      }
81  
82      @Override
83      @SuppressWarnings("unchecked")
84      protected void mapObjectToItem(Task task, Item item) {
85          item.addItemProperty(TaskConstants.ID, new ObjectProperty(task.getId()));
86          item.addItemProperty(TaskConstants.STATUS_PROPERTY_ID, new ObjectProperty(task.getStatus()));
87          item.addItemProperty(TaskConstants.NEW_PROPERTY_ID, new ObjectProperty(task.getStatus() == Task.Status.Created, Boolean.class));
88          item.addItemProperty(TaskConstants.TASK_PROPERTY_ID, new ObjectProperty(taskTypeHelper.getTitle(task), String.class));
89          item.addItemProperty(TaskConstants.SENDER_PROPERTY_ID, new ObjectProperty(task.getRequestor(), String.class));
90          item.addItemProperty(TaskConstants.LAST_CHANGE_PROPERTY_ID, new ObjectProperty(task.getModificationDate(), Date.class));
91  
92          item.addItemProperty(TaskConstants.ASSIGNED_TO_PROPERTY_ID, new ObjectProperty(StringUtils.defaultString(task.getActorId()), String.class));
93  
94          String sentTo = "";
95          if (task.getGroupIds() != null && task.getGroupIds().size() > 0) {
96              sentTo += StringUtils.join(task.getGroupIds(), ",");
97          }
98          if (task.getActorIds() != null && task.getActorIds().size() > 0) {
99              sentTo += StringUtils.join(task.getActorIds(), ",");
100         }
101         item.addItemProperty(TaskConstants.SENT_TO_PROPERTY_ID, new ObjectProperty(sentTo, String.class));
102     }
103 
104     @Override
105     protected long getEntriesAmount(List<Task.Status> types) {
106         return tasksManager.getTasksAmountByUserAndStatus(getQueryDefinition().userName(), types);
107     }
108 
109     @Override
110     protected List<Task> getEntries(List<Task.Status> types, int limit, int offset) {
111         long timeMs = System.currentTimeMillis();
112         List<Task> tasksCollection = tasksManager.findTasksByUserAndStatus(getQueryDefinition().userName(), types, getSortCriteria(), limit, offset);
113         log.debug("Fetched {} object list from {} in {}ms", limit, offset, System.currentTimeMillis() - timeMs);
114         return tasksCollection;
115     }
116 
117     @Override
118     protected Task createGroupingEntry(Task.Status type) {
119         Task groupingTask = new Task();
120         groupingTask.setId(PulseConstants.GROUP_PLACEHOLDER_ITEMID + type.name());
121         groupingTask.setStatus(type);
122         return groupingTask;
123     }
124 
125     /**
126      * @deprecated since 5.4.12, please use {@link TaskTypeHelper#getTitle(Task)} instead.
127      */
128     @Deprecated
129     protected String getTaskTitle(Task task) {
130        return taskTypeHelper.getTitle(task);
131     }
132 }