1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package com.xpn.xwiki.plugin.activitystream.impl

File ActivityEventImpl.java

 

Coverage histogram

../../../../../../img/srcFileCovDistChart8.png
54% of files have more coverage

Code metrics

16
68
50
1
477
305
58
0.85
1.36
50
1.16

Classes

Class Line # Actions
ActivityEventImpl 33 68 0% 58 30
0.776119477.6%
 

Contributing tests

This file is covered by 1 test. .

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package com.xpn.xwiki.plugin.activitystream.impl;
21   
22    import java.util.ArrayList;
23    import java.util.Date;
24    import java.util.List;
25    import java.util.Map;
26   
27    import com.xpn.xwiki.XWikiContext;
28    import com.xpn.xwiki.plugin.activitystream.api.ActivityEvent;
29   
30    /**
31    * @version $Id: 9ba812daea17b9d91f4a1c357749c7a55e922866 $
32    */
 
33    public class ActivityEventImpl implements ActivityEvent
34    {
35    /**
36    * ID.
37    */
38    protected String eventId;
39   
40    /**
41    * Request ID.
42    */
43    protected String requestId;
44   
45    /**
46    * Priority.
47    */
48    protected int priority;
49   
50    /**
51    * Date the event occured.
52    */
53    protected Date date;
54   
55    /**
56    * Stream the event belongs to.
57    */
58    protected String stream;
59   
60    /**
61    * Application which fired the event (as of august 2009 this application is always "xwiki").
62    */
63    protected String application;
64   
65    /**
66    * Type of the event, see {@link com.xpn.xwiki.plugin.activitystream.api.ActivityEventType ActivityEventType}.
67    */
68    protected String type;
69   
70    /**
71    * Context user at the time the event has been fired.
72    */
73    protected String user;
74   
75    /**
76    * Wiki in which the event occured, example: "xwiki".
77    */
78    protected String wiki;
79   
80    /**
81    * Space (local serialized reference) in which the event occurred, example: "Main", "A.B", "A.B.C", etc.
82    */
83    protected String space;
84   
85    /**
86    * Name of the document which fired the event, example: "Main.WebHome".
87    */
88    protected String page;
89   
90    /**
91    * URL of the document which fired the event, example: "/xwiki/bin/view/Main/WebHome".
92    */
93    protected String url;
94   
95    /**
96    * Title of the event.
97    */
98    protected String title;
99   
100    /**
101    * Body message of the event.
102    */
103    protected String body = "";
104   
105    /**
106    * Version of the document at the time the event occured.
107    */
108    protected String version = "";
109   
110    /**
111    * Free param 1.
112    */
113    protected String param1 = "";
114   
115    /**
116    * Free param 2.
117    */
118    protected String param2 = "";
119   
120    /**
121    * Free param 3.
122    */
123    protected String param3 = "";
124   
125    /**
126    * Free param 4.
127    */
128    protected String param4 = "";
129   
130    /**
131    * Free param 5.
132    */
133    protected String param5 = "";
134   
135    /**
136    * True if the page which fired the event is marked as hidden, false otherwise.
137    */
138    protected boolean hidden;
139   
140    /**
141    * Named parameters.
142    */
143    protected Map<String, String> parameters;
144   
 
145  0 toggle @Override
146    public String getDisplayTitle(XWikiContext context)
147    {
148  0 return context.getMessageTool().get(this.title, getParams());
149    }
150   
 
151  0 toggle @Override
152    public String getDisplayBody(XWikiContext context)
153    {
154  0 return context.getMessageTool().get(this.body, getParams());
155    }
156   
 
157  0 toggle @Override
158    public String getDisplayDate(XWikiContext context)
159    {
160  0 return context.getWiki().formatDate(this.date, null, context);
161    }
162   
 
163  0 toggle @Override
164    public String getDisplayUser(XWikiContext context)
165    {
166  0 return context.getWiki().getUserName(this.user, context);
167    }
168   
 
169  64 toggle @Override
170    public void setParams(List<String> params)
171    {
172  64 if (params != null) {
173  64 if (params.size() > 0) {
174  64 setParam1(params.get(0));
175    }
176  64 if (params.size() > 1) {
177  1 setParam2(params.get(1));
178    }
179  64 if (params.size() > 2) {
180  0 setParam3(params.get(2));
181    }
182  64 if (params.size() > 3) {
183  0 setParam4(params.get(3));
184    }
185  64 if (params.size() > 4) {
186  0 setParam5(params.get(4));
187    }
188    }
189    }
190   
191    /**
192    * @return the parameters of the event
193    */
 
194  0 toggle public List<String> getParams()
195    {
196  0 List<String> params = new ArrayList<String>();
197  0 params.add(getParam1());
198  0 params.add(getParam2());
199  0 params.add(getParam3());
200  0 params.add(getParam4());
201  0 params.add(getParam5());
202  0 return params;
203    }
204   
 
205  192 toggle @Override
206    public String getEventId()
207    {
208  192 return this.eventId;
209    }
210   
 
211  279 toggle @Override
212    public void setEventId(String eventId)
213    {
214  279 this.eventId = eventId;
215    }
216   
 
217  283 toggle @Override
218    public String getRequestId()
219    {
220  283 return this.requestId;
221    }
222   
 
223  215 toggle @Override
224    public void setRequestId(String requestId)
225    {
226  215 this.requestId = requestId;
227    }
228   
 
229  128 toggle @Override
230    public int getPriority()
231    {
232  128 return this.priority;
233    }
234   
 
235  215 toggle @Override
236    public void setPriority(int priority)
237    {
238  215 this.priority = priority;
239    }
240   
 
241  352 toggle @Override
242    public String getApplication()
243    {
244  352 return this.application;
245    }
246   
 
247  215 toggle @Override
248    public void setStream(String stream)
249    {
250  215 this.stream = stream;
251    }
252   
 
253  169 toggle @Override
254    public String getVersion()
255    {
256  169 return this.version;
257    }
258   
 
259  216 toggle @Override
260    public void setVersion(String version)
261    {
262  216 if (version != null) {
263  216 this.version = version;
264    }
265    }
266   
 
267  128 toggle @Override
268    public String getParam1()
269    {
270  128 return this.param1;
271    }
272   
 
273  215 toggle @Override
274    public void setParam1(String param1)
275    {
276  215 this.param1 = param1;
277    }
278   
 
279  128 toggle @Override
280    public String getParam2()
281    {
282  128 return this.param2;
283    }
284   
 
285  152 toggle @Override
286    public void setParam2(String param2)
287    {
288  152 this.param2 = param2;
289    }
290   
 
291  128 toggle @Override
292    public String getParam3()
293    {
294  128 return this.param3;
295    }
296   
 
297  151 toggle @Override
298    public void setParam3(String param3)
299    {
300  151 this.param3 = param3;
301    }
302   
 
303  128 toggle @Override
304    public String getParam4()
305    {
306  128 return this.param4;
307    }
308   
 
309  151 toggle @Override
310    public void setParam4(String param4)
311    {
312  151 this.param4 = param4;
313    }
314   
 
315  128 toggle @Override
316    public String getParam5()
317    {
318  128 return this.param5;
319    }
320   
 
321  151 toggle @Override
322    public void setParam5(String param5)
323    {
324  151 this.param5 = param5;
325    }
326   
 
327  365 toggle @Override
328    public String getWiki()
329    {
330  365 return this.wiki;
331    }
332   
 
333  216 toggle @Override
334    public void setWiki(String wiki)
335    {
336  216 this.wiki = wiki;
337    }
338   
 
339  723 toggle @Override
340    public String getType()
341    {
342  723 return this.type;
343    }
344   
 
345  216 toggle @Override
346    public void setType(String type)
347    {
348  216 this.type = type;
349    }
350   
 
351  477 toggle @Override
352    public String getUser()
353    {
354  477 return this.user;
355    }
356   
 
357  216 toggle @Override
358    public void setUser(String user)
359    {
360  216 this.user = user;
361    }
362   
 
363  192 toggle @Override
364    public String getSpace()
365    {
366  192 return this.space;
367    }
368   
 
369  215 toggle @Override
370    public void setSpace(String space)
371    {
372  215 this.space = space;
373    }
374   
 
375  283 toggle @Override
376    public String getPage()
377    {
378  283 return this.page;
379    }
380   
 
381  216 toggle @Override
382    public void setPage(String page)
383    {
384  216 this.page = page;
385    }
386   
 
387  192 toggle @Override
388    public String getUrl()
389    {
390  192 return this.url;
391    }
392   
 
393  212 toggle @Override
394    public void setUrl(String url)
395    {
396  212 this.url = url;
397    }
398   
 
399  128 toggle @Override
400    public String getTitle()
401    {
402  128 return this.title;
403    }
404   
 
405  215 toggle @Override
406    public void setTitle(String title)
407    {
408  215 this.title = title;
409    }
410   
 
411  128 toggle @Override
412    public String getBody()
413    {
414  128 return this.body;
415    }
416   
 
417  215 toggle @Override
418    public void setBody(String body)
419    {
420  215 this.body = body;
421    }
422   
 
423  355 toggle @Override
424    public Date getDate()
425    {
426  355 return this.date;
427    }
428   
 
429  216 toggle @Override
430    public void setDate(Date date)
431    {
432  216 this.date = date;
433    }
434   
 
435  256 toggle @Override
436    public String getStream()
437    {
438  256 return this.stream;
439    }
440   
 
441  215 toggle @Override
442    public void setApplication(String application)
443    {
444  215 this.application = application;
445    }
446   
 
447  0 toggle @Override
448    public void setParameters(Map<String, String> parameters)
449    {
450  0 this.parameters = parameters;
451    }
452   
 
453  0 toggle @Override
454    public Map<String, String> getParameters()
455    {
456  0 return this.parameters;
457    }
458   
459    /**
460    * @return True if the event has been triggered by an action performed on a document marked as hidden.
461    */
 
462  128 toggle public boolean isHidden()
463    {
464  128 return this.hidden;
465    }
466   
467    /**
468    * @param hidden the event hidden flag.
469    * @see #isHidden()
470    */
 
471  215 toggle public void setHidden(Boolean hidden)
472    {
473  215 if (hidden != null) {
474  215 this.hidden = hidden;
475    }
476    }
477    }