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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.document.annotation;
import com.yahoo.document.ArrayDataType;
import com.yahoo.document.DocumentTypeManager;
import com.yahoo.document.Field;
import com.yahoo.document.StructDataType;
import com.yahoo.document.datatypes.Array;
import com.yahoo.document.datatypes.FieldValue;
import com.yahoo.document.datatypes.StringFieldValue;
import com.yahoo.document.datatypes.Struct;
import org.junit.Test;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
/**
* Contains code snippets that are used in the documentation. Not really a test case.
*
* @author Einar M R Rosenvinge
*/
public class DocTestCase {
private class Processing {
private Service getService() {
return null;
}
}
private class Service {
private DocumentTypeManager getDocumentTypeManager() {
return null;
}
}
private Processing processing = null;
@Test
public void testSimple1() {
StringFieldValue text = new StringFieldValue("<html><head><title>Diary</title></head><body>I live in San Francisco</body></html>");
//012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
SpanList root = new SpanList();
root.add(new Span(0, 19))
.add(new Span(19, 5))
.add(new Span(24, 21))
.add(new Span(45, 23))
.add(new Span(68, 14));
SpanTree tree = new SpanTree("html", root);
text.setSpanTree(tree);
}
public void simple2() {
//the following line works inside process(Document, Arguments, Processing) in a DocumentProcessor
AnnotationTypeRegistry atr = processing.getService().getDocumentTypeManager().getAnnotationTypeRegistry();
StringFieldValue text = new StringFieldValue("<html><head><title>Diary</title></head><body>I live in San Francisco</body></html>");
//012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
AnnotationType textType = atr.getType("text");
AnnotationType markup = atr.getType("markup");
SpanList root = new SpanList();
SpanTree tree = new SpanTree("html", root);
Span span1 = new Span(0, 19);
root.add(span1);
tree.annotate(span1, markup);
Span span2 = new Span(19, 5);
root.add(span2);
tree.annotate(span2, textType);
Span span3 = new Span(24, 21);
root.add(span3);
tree.annotate(span3, markup);
Span span4 = new Span(45, 23);
root.add(span4);
tree.annotate(span4, textType);
Span span5 = new Span(68, 14);
root.add(span5);
tree.annotate(span5, markup);
text.setSpanTree(tree);
}
public void simple3() {
//the following line works inside process(Document, Arguments, Processing) in a DocumentProcessor
AnnotationTypeRegistry atr = processing.getService().getDocumentTypeManager().getAnnotationTypeRegistry();
StringFieldValue text = new StringFieldValue("<html><head><title>Diary</title></head><body>I live in San Francisco</body></html>");
//012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
SpanList root = new SpanList();
SpanTree tree = new SpanTree("html", root);
AnnotationType textType = atr.getType("text");
AnnotationType beginTag = atr.getType("begintag");
AnnotationType endTag = atr.getType("endtag");
AnnotationType bodyType = atr.getType("body");
AnnotationType headerType = atr.getType("header");
SpanList header = new SpanList();
{
Span span1 = new Span(6, 6);
Span span2 = new Span(12, 7);
Span span3 = new Span(19, 5);
Span span4 = new Span(24, 8);
Span span5 = new Span(32, 7);
header.add(span1)
.add(span2)
.add(span3)
.add(span4)
.add(span5);
tree.annotate(span1, beginTag)
.annotate(span2, beginTag)
.annotate(span3, textType)
.annotate(span4, endTag)
.annotate(span5, endTag)
.annotate(header, headerType);
}
SpanList body = new SpanList();
{
Span span1 = new Span(39, 6);
Span span2 = new Span(45, 23);
Span span3 = new Span(68, 7);
body.add(span1)
.add(span2)
.add(span3);
tree.annotate(span1, beginTag)
.annotate(span2, textType)
.annotate(span3, endTag)
.annotate(body, bodyType);
}
{
Span span1 = new Span(0, 6);
Span span2 = new Span(75, 7);
root.add(span1)
.add(header)
.add(body)
.add(span2);
tree.annotate(span1, beginTag)
.annotate(span2, endTag);
}
text.setSpanTree(tree);
}
public void simple4() {
//the following line works inside process(Document, Arguments, Processing) in a DocumentProcessor
AnnotationTypeRegistry atr = processing.getService().getDocumentTypeManager().getAnnotationTypeRegistry();
StringFieldValue text = new StringFieldValue("<html><head><title>Diary</title></head><body>I live in San Francisco</body></html>");
//012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
SpanList root = new SpanList();
SpanTree tree = new SpanTree("html", root);
AnnotationType textType = atr.getType("text");
AnnotationType beginTag = atr.getType("begintag");
AnnotationType endTag = atr.getType("endtag");
AnnotationType bodyType = atr.getType("body");
AnnotationType headerType = atr.getType("header");
AnnotationType cityType = atr.getType("city");
Struct position = (Struct) cityType.getDataType().createFieldValue();
position.setFieldValue("latitude", 37.774929);
position.setFieldValue("longitude", -122.419415);
Annotation city = new Annotation(cityType, position);
SpanList header = new SpanList();
{
Span span1 = new Span(6, 6);
Span span2 = new Span(12, 7);
Span span3 = new Span(19, 5);
Span span4 = new Span(24, 8);
Span span5 = new Span(32, 7);
header.add(span1)
.add(span2)
.add(span3)
.add(span4)
.add(span5);
tree.annotate(span1, beginTag)
.annotate(span2, beginTag)
.annotate(span3, textType)
.annotate(span4, endTag)
.annotate(span4, endTag)
.annotate(header, headerType);
}
SpanList textNode = new SpanList();
{
Span span1 = new Span(45, 10);
Span span2 = new Span(55, 13);
textNode.add(span1)
.add(span2);
tree.annotate(span2, city)
.annotate(textNode, textType);
}
SpanList body = new SpanList();
{
Span span1 = new Span(39, 6);
Span span2 = new Span(68, 7);
body.add(span1)
.add(textNode)
.add(span2);
tree.annotate(span1, beginTag)
.annotate(span2, endTag)
.annotate(body, bodyType);
}
{
Span span1 = new Span(0, 6);
Span span2 = new Span(75, 7);
root.add(span1)
.add(header)
.add(body)
.add(span2);
tree.annotate(span1, beginTag)
.annotate(span2, endTag);
}
text.setSpanTree(tree);
}
public void simple5() {
//the following two lines work inside process(Document, Arguments, Processing) in a DocumentProcessor
DocumentTypeManager dtm = processing.getService().getDocumentTypeManager();
AnnotationTypeRegistry atr = dtm.getAnnotationTypeRegistry();
StringFieldValue text = new StringFieldValue("<body><p>I live in San </p>Francisco</body>");
//012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
SpanList root = new SpanList();
SpanTree tree = new SpanTree("html", root);
var docType = dtm.getDocumentType("blogpost");
StructDataType positionType = docType.getDeclaredStructType("position");
AnnotationType textType = atr.getType("text");
AnnotationType beginTag = atr.getType("begintag");
AnnotationType endTag = atr.getType("endtag");
AnnotationType bodyType = atr.getType("body");
AnnotationType paragraphType = atr.getType("paragraph");
AnnotationType cityType = atr.getType("city");
Struct position = new Struct(positionType);
position.setFieldValue("latitude", 37.774929);
position.setFieldValue("longitude", -122.419415);
Annotation sanAnnotation = new Annotation(textType);
Annotation franciscoAnnotation = new Annotation(textType);
Struct positionWithRef = (Struct) cityType.getDataType().createFieldValue();
positionWithRef.setFieldValue("position", position);
Field referencesField = ((StructDataType) cityType.getDataType()).getField("references");
Array<FieldValue> refList = new Array<FieldValue>(referencesField.getDataType());
AnnotationReferenceDataType annRefType = (AnnotationReferenceDataType) ((ArrayDataType) referencesField.getDataType()).getNestedType();
refList.add(new AnnotationReference(annRefType, sanAnnotation));
refList.add(new AnnotationReference(annRefType, franciscoAnnotation));
positionWithRef.setFieldValue(referencesField, refList);
Annotation city = new Annotation(cityType, positionWithRef);
SpanList paragraph = new SpanList();
{
Span span1 = new Span(6, 3);
Span span2 = new Span(9, 10);
Span span3 = new Span(19, 4);
Span span4 = new Span(23, 4);
paragraph.add(span1)
.add(span2)
.add(span3)
.add(span4);
tree.annotate(span1, beginTag)
.annotate(span2, textType)
.annotate(span3, sanAnnotation)
.annotate(span4, endTag)
.annotate(paragraph, paragraphType);
}
{
Span span1 = new Span(0, 6);
Span span2 = new Span(27, 9);
Span span3 = new Span(36, 8);
root.add(span1)
.add(paragraph)
.add(span2)
.add(span3);
tree.annotate(span1, beginTag)
.annotate(span2, franciscoAnnotation)
.annotate(span3, endTag)
.annotate(root, bodyType)
.annotate(city);
}
text.setSpanTree(tree);
}
public void simple6() {
StringFieldValue text = new StringFieldValue("<html><head><title>Diary</title></head><body>I live in San Francisco</body></html>");
//012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
SpanTree tree = text.getSpanTree("html");
SpanList root = (SpanList) tree.getRoot();
//TODO: Note that the above could have been a Span or an AlternateSpanList!
ListIterator<SpanNode> nodeIt = root.childIterator();
AnnotationType beginTag = new AnnotationType("begintag");
AnnotationType endTag = new AnnotationType("endtag");
while (nodeIt.hasNext()) {
SpanNode node = nodeIt.next();
boolean nodeHadMarkupAnnotation = removeMarkupAnnotation(tree, node);
if (nodeHadMarkupAnnotation) {
nodeIt.remove();
List<Span> replacementNodes = analyzeMarkup(tree, node, text, beginTag, endTag);
for (SpanNode repl : replacementNodes) {
nodeIt.add(repl);
}
}
}
}
/**
* Removes annotations of type 'markup' from the given node.
*
* @param tree the tree to remove annotations from
* @param node the node to remove annotations of type 'markup' from
* @return true if the given node had 'markup' annotations, false otherwise
*/
private boolean removeMarkupAnnotation(SpanTree tree, SpanNode node) {
//get iterator over all annotations on this node:
Iterator<Annotation> annotationIt = tree.iterator(node);
while (annotationIt.hasNext()) {
Annotation annotation = annotationIt.next();
if (annotation.getType().getName().equals("markup")) {
//this node has an annotation of type markup, remove it:
annotationIt.remove();
//return true, this node had a markup annotation:
return true;
}
}
//this node did not have a markup annotation:
return false;
}
/**
* NOTE: This method is provided only for completeness. It analyzes spans annotated with
* "markup", and splits them into several shorter spans annotated with "begintag"
* and "endtag".
*
* @param tree the span tree to annotate into
* @param input a SpanNode that is annotated with "markup".
* @param text the text that the SpanNode covers
* @param beginTag the type to use for begintag annotations
* @param endTagType the type to use for endtag annotations
* @return a list of new spans to replace the input
*/
private List<Span> analyzeMarkup(SpanTree tree, SpanNode input, StringFieldValue text,
AnnotationType beginTag, AnnotationType endTagType) {
//we know that this node is annotated with "markup"
String coveredText = input.getText(text.getString()).toString();
int spanOffset = input.getFrom();
int tagStart = -1;
boolean endTag = false;
List<Span> tags = new ArrayList<Span>();
for (int i = 0; i < coveredText.length(); i++) {
if (coveredText.charAt(i) == '<') {
//we're in a tag
tagStart = i;
continue;
}
if (coveredText.charAt(i) == '>' && tagStart > -1) {
Span span = new Span(spanOffset + tagStart, (i + 1) - tagStart);
tags.add(span);
if (endTag) {
tree.annotate(span, endTagType);
} else {
tree.annotate(span, beginTag);
}
tagStart = -1;
}
if (tagStart > -1 && i == (tagStart + 1)) {
if (coveredText.charAt(i) == '/') {
endTag = true;
} else {
endTag = false;
}
}
}
return tags;
}
public void simple7() {
StringFieldValue text = new StringFieldValue("<html><head><title>Diary</title></head><body>I live in San Francisco</body></html>");
//012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
SpanTree tree = text.getSpanTree("html");
Iterator<Annotation> annotationIt = tree.iterator();
while (annotationIt.hasNext()) {
Annotation annotation = annotationIt.next();
if (annotation.getType().getName().equals("markup")) {
//we have an annotation of type markup, remove it:
annotationIt.remove();
}
}
}
}
|
