Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
AnnotationClassDocumentInitializer	47	16	0%	4	2	0.904761990.5%	Show methods

Class AnnotationClassDocumentInitializer

Class AnnotationClassDocumentInitializer	Line # 47	Total Statements 16	% Filtered 0%	Complexity 4	Uncovered Elements 2	TOTAL Coverage 0.904761990.5%
AnnotationClassDocumentInitializer()   AnnotationClassDocumentInitializer()	6060	1.01	0.00%	1.01	0.00	1.0 1.0100%
getDocumentReference() : EntityReference   getDocumentReference() : EntityReference	6565	1.01	0.00%	1.01	0.00	1.0 1.0100%
updateDocument(XWikiDocument) : boolean   updateDocument(XWikiDocument) : boolean	7171	14.014	0.00%	2.02	2.02	0.875 0.87587.5%

 

Contributing tests

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.annotation.internal;
21
22		import javax.inject.Inject;
23		import javax.inject.Named;
24		import javax.inject.Singleton;
25
26		import org.xwiki.annotation.Annotation;
27		import org.xwiki.annotation.AnnotationConfiguration;
28		import org.xwiki.component.annotation.Component;
29		import org.xwiki.model.reference.EntityReference;
30
31		import com.xpn.xwiki.doc.XWikiDocument;
32		import com.xpn.xwiki.internal.mandatory.AbstractMandatoryDocumentInitializer;
33		import com.xpn.xwiki.objects.classes.BaseClass;
34		import com.xpn.xwiki.objects.classes.TextAreaClass.ContentType;
35
36		/**
37		* When the wiki is initialized, make sure that the configured annotation class contains the minimum required properties
38		* for the Annotation Application to function properly.
39		*
40		* @version $Id: 8d75b62cee549ad8ba4ecc8e5d847f4786000c01 $
41		* @since 6.2RC1
42		*/
43		@Component
44		// The role hint is not a document name since it can change based the configuration
45		@Named(AnnotationClassDocumentInitializer.HINT)
46		@Singleton
		90.5% Uncovered Elements: 2 (21) Complexity: 4 Complexity Density: 0.25
47		public class AnnotationClassDocumentInitializer extends AbstractMandatoryDocumentInitializer
48		{
49		static final String HINT = "annotationclass";
50
51		/**
52		* The Annotation Application's configuration.
53		*/
54		@Inject
55		protected AnnotationConfiguration configuration;
56
57		/**
58		* Default constructor.
59		*/
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
60	1	public AnnotationClassDocumentInitializer()...
61		{
62	1	super(null);
63		}
64
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
65	1	@Override...
66		public EntityReference getDocumentReference()
67		{
68	1	return this.configuration.getAnnotationClassReference();
69		}
70
		87.5% Uncovered Elements: 2 (16) Complexity: 2 Complexity Density: 0.14
71	1	@Override...
72		public boolean updateDocument(XWikiDocument document)
73		{
74	1	if (!this.configuration.isInstalled()) {
75		// If the Annotations Application is not installed on the current wiki, do nothing.
76	0	return false;
77		}
78
79	1	BaseClass annotationClass = document.getXClass();
80
81	1	boolean needsUpdate = false;
82
83	1	needsUpdate |= annotationClass.addTextField(Annotation.AUTHOR_FIELD, "Author", 30);
84	1	needsUpdate |= annotationClass.addDateField(Annotation.DATE_FIELD, "Date");
85
86	1	needsUpdate |=
87		annotationClass.addTextAreaField(Annotation.SELECTION_FIELD, "Selection", 40, 5, ContentType.PURE_TEXT);
88	1	needsUpdate |= annotationClass.addTextAreaField(Annotation.SELECTION_LEFT_CONTEXT_FIELD,
89		"Selection Left Context", 40, 5, ContentType.PURE_TEXT);
90	1	needsUpdate |= annotationClass.addTextAreaField(Annotation.SELECTION_RIGHT_CONTEXT_FIELD,
91		"Selection Right Context", 40, 5, ContentType.PURE_TEXT);
92	1	needsUpdate |= annotationClass.addTextAreaField(Annotation.ORIGINAL_SELECTION_FIELD, "Original Selection", 40,
93		5, ContentType.PURE_TEXT);
94	1	needsUpdate |= annotationClass.addTextField(Annotation.TARGET_FIELD, "Target", 30);
95	1	needsUpdate |= annotationClass.addTextField(Annotation.STATE_FIELD, "State", 30);
96
97	1	needsUpdate |= setClassDocumentFields(document, "Annotation Class");
98
99	1	return needsUpdate;
100		}
101		}