-
Notifications
You must be signed in to change notification settings - Fork 81
/
index.xsd
224 lines (219 loc) · 9.36 KB
/
index.xsd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
<?xml version="1.0"?>
<!--
The MIT License (MIT)
Copyright (c) 2017-2018 Yegor Bugayenko
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
-->
<!--
@todo #135:30min Index.xsd: add a reference to this schema from the generated
index.xml. Schemas from src/resources/org/jpeek/xsd must be referenced in
generated XMLs.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="index">
<xs:complexType>
<xs:sequence>
<xs:element name="metric" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
A concrete metric.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="html" type="xs:string" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The name of the html file of this metric.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="xml" type="xs:string" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The name of the .xml containing the metric.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="classes" type="xs:int" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The total amount of classes measured by this metric.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="elements" type="xs:int" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The total amount of elements measured by this metric.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="green" type="xs:int" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The total amount of classes that received "green".
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="yellow" type="xs:int" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The total amount of classes that received "yellow".
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="red" type="xs:int" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The total amount of classes that received "red".
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="score" type="xs:double" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>
A weighted average of the numbers from "green", "yellow"
and "red". The weight of green classes is 1.0, yellow
ones get 0.25 and red ones get 0.05.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="reverse" type="xs:boolean" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>The metric is reversed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="min" type="xs:double" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The minimum score measured by this metric.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="max" type="xs:double" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The maximum score measured by this metric.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="defects" type="xs:float" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The percentage of defects (classes that fall out of one-sigma
standard deviation interval).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="sigma" type="xs:float" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
The standard deviation.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mean" type="xs:float" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Mathematical average of all measurements.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="bars" minOccurs="1" maxOccurs="1">
<!--
@todo #199:30min Index.xsd: add `xsd:documentation` as per #199 to the
`bars` element. The element seems to describe the graph on the index.html
Tests that might help you implement this by showing you .xml files and
the resulting html:
* org.jpeek.IndexTest
* org.jpeek.AppTest#createsIndexHtml
* org.jpeek.web.TkIndexTest#rendersIndexPage
-->
<xs:complexType>
<xs:sequence>
<xs:element name="bar" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:int">
<xs:attribute name="x" use="required" type="xs:double"/>
<xs:attribute name="color" use="required" type="xs:string"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:all>
<xs:attribute name="name" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of the metric.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="diff" type="xs:float" use="required"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="artifact" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The name of the analyzed artifact.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="defects" type="xs:float" use="required">
<xs:annotation>
<xs:documentation>
The average defects rate.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="diff" type="xs:float" use="required">
<xs:annotation>
<xs:documentation>
The average mistake of individual scores.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="score" type="xs:float" use="required">
<xs:annotation>
<xs:documentation>
The overall score.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="date" use="required" type="xs:dateTime">
<xs:annotation>
<xs:documentation>
The date the analysis took place in ISO 8601,
e.g. 2018-11-29T12:17:30.990Z.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="version" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>
The version of jPeek that analyzed the artifact, e.g. 1.0-SNAPSHOT.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:schema>