1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.ratings.internal

File AverageRatingClassDocumentInitializer.java

 

Coverage histogram

../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

0
8
2
1
72
35
2
0.25
4
2
1

Classes

Class Line # Actions
AverageRatingClassDocumentInitializer 42 8 0% 2 0
1.0100%
 

Contributing tests

No tests hitting this source file were found.

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 org.xwiki.ratings.internal;
21   
22    import javax.inject.Named;
23    import javax.inject.Singleton;
24   
25    import org.xwiki.component.annotation.Component;
26    import org.xwiki.ratings.RatingsManager;
27   
28    import com.xpn.xwiki.XWiki;
29    import com.xpn.xwiki.doc.XWikiDocument;
30    import com.xpn.xwiki.internal.mandatory.AbstractMandatoryDocumentInitializer;
31    import com.xpn.xwiki.objects.classes.BaseClass;
32   
33    /**
34    * Initialize average rating class.
35    *
36    * @version $Id: c9b1be8fd4db3671df5663bfc76710d54a610279 $
37    * @since 6.4M3
38    */
39    @Component
40    @Named(RatingsManager.AVERAGE_RATINGS_CLASSNAME)
41    @Singleton
 
42    public class AverageRatingClassDocumentInitializer extends AbstractMandatoryDocumentInitializer
43    {
44    /**
45    * Default constructor.
46    */
 
47  2 toggle public AverageRatingClassDocumentInitializer()
48    {
49  2 super(XWiki.SYSTEM_SPACE, RatingsManager.AVERAGE_RATINGS_CLASSPAGE);
50    }
51   
 
52  2 toggle @Override
53    public boolean updateDocument(XWikiDocument document)
54    {
55  2 boolean needsUpdate = false;
56   
57  2 BaseClass bclass = document.getXClass();
58   
59  2 needsUpdate |=
60    bclass
61    .addNumberField(RatingsManager.AVERAGERATING_CLASS_FIELDNAME_NBVOTES, "Number of Votes", 5, "integer");
62  2 needsUpdate |=
63    bclass.addNumberField(RatingsManager.AVERAGERATING_CLASS_FIELDNAME_AVERAGEVOTE, "Average Vote", 5, "float");
64  2 needsUpdate |=
65    bclass.addTextField(RatingsManager.AVERAGERATING_CLASS_FIELDNAME_AVERAGEVOTE_METHOD, "Average Vote method",
66    10);
67   
68  2 needsUpdate = setClassDocumentFields(document, "XWiki Average Ratings Class");
69   
70  2 return needsUpdate;
71    }
72    }