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
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.storage.searcher;
import com.yahoo.document.DataType;
import com.yahoo.document.Document;
import com.yahoo.document.Field;
import com.yahoo.document.datatypes.FieldValue;
import com.yahoo.document.datatypes.Raw;
import com.yahoo.io.ByteWriter;
import com.yahoo.text.XML;
import java.io.IOException;
import java.io.Writer;
/**
* Template used to render a single field for a single Document. Fields
* that are either of type CONTENT or RAW are written directly, while
* all other fields are wrapped in Vespa XML and escaped.
*
* @deprecated use a renderer instead
*/
@Deprecated // OK
// TODO: Remove on Vespa 7
@SuppressWarnings("deprecation")
public class DocumentFieldTemplate extends com.yahoo.prelude.templates.UserTemplate<Writer> {
Field field;
String contentType;
String encoding;
boolean wrapXml;
public DocumentFieldTemplate(Field field, String contentType, String encoding, boolean wrapXml) {
super("documentfield", contentType, encoding);
this.field = field;
this.contentType = contentType;
this.encoding = encoding;
this.wrapXml = wrapXml;
}
@Override
public void error(com.yahoo.prelude.templates.Context context, Writer writer) throws IOException {
// Error shouldn't be handled by this template, but rather
// delegated to the searcher
}
@Override
public Writer wrapWriter(Writer writer) {
/* TODO: uncomment
if (!(writer instanceof ByteWriter)) {
throw new IllegalArgumentException("ByteWriter required, but got " + writer.getClass().getName());
}
*/
return writer;
}
@Override
public void header(com.yahoo.prelude.templates.Context context, Writer writer) throws IOException {
if (wrapXml) {
// XML wrapping should only be used for default field rendering
writer.write("<?xml version=\"1.0\" encoding=\"" + encoding + "\"?>\n");
writer.write("<result>");
}
}
@Override
public void footer(com.yahoo.prelude.templates.Context context, Writer writer) throws IOException {
if (wrapXml) {
writer.write("</result>\n");
}
}
@Override
public void hit(com.yahoo.prelude.templates.Context context, Writer writer) throws IOException {
DocumentHit hit = (DocumentHit)context.get("hit");
Document doc = hit.getDocument();
// Assume field existence has been checked before we ever get here.
// Also assume that relevant encoding/content type is set
// appropriately according to the request and the field's content
// type, as this is immutable in the template set.
FieldValue value = doc.getFieldValue(field);
if (field.getDataType() == DataType.RAW) {
ByteWriter bw = (ByteWriter)writer;
bw.append(((Raw) value).getByteBuffer().array());
} else {
writer.write(XML.xmlEscape(value.toString(), false));
}
}
@Override
public void hitFooter(com.yahoo.prelude.templates.Context context, Writer writer) throws IOException {
}
@Override
public void noHits(com.yahoo.prelude.templates.Context context, Writer writer) throws IOException {
}
}
|
