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
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.query;
import com.google.common.base.Splitter;
import com.yahoo.collections.LazySet;
import com.yahoo.component.ComponentSpecification;
import com.yahoo.processing.request.CompoundName;
import com.yahoo.prelude.query.*;
import com.yahoo.search.Query;
import com.yahoo.search.query.profile.types.FieldDescription;
import com.yahoo.search.query.profile.types.QueryProfileType;
import com.yahoo.search.rendering.RendererRegistry;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
/**
* Parameters deciding how the result of a query should be presented
*
* @author Arne Bergene Fossaa
*/
public class Presentation implements Cloneable {
/** The type representing the property arguments consumed by this */
private static QueryProfileType argumentType;
public static final String PRESENTATION = "presentation";
public static final String BOLDING = "bolding";
public static final String TIMING = "timing";
public static final String SUMMARY = "summary";
public static final String REPORT_COVERAGE = "reportCoverage";
public static final String SUMMARY_FIELDS = "summaryFields";
/** The (short) name of the parameter holding the name of the return format to use */
public static final String FORMAT = "format";
static {
argumentType=new QueryProfileType(PRESENTATION);
argumentType.setStrict(true);
argumentType.setBuiltin(true);
argumentType.addField(new FieldDescription(BOLDING, "boolean", "bolding"));
argumentType.addField(new FieldDescription(TIMING, "boolean", "timing"));
argumentType.addField(new FieldDescription(SUMMARY, "string", "summary"));
argumentType.addField(new FieldDescription(REPORT_COVERAGE, "string", "reportcoverage"));
argumentType.addField(new FieldDescription(FORMAT, "string", "format template"));
argumentType.addField(new FieldDescription(SUMMARY_FIELDS, "string", "summaryFields"));
argumentType.freeze();
}
public static QueryProfileType getArgumentType() { return argumentType; }
/** How the result should be highlighted */
private Highlight highlight= null;
/** The terms to highlight in the result (only used by BoldingSearcher, may be removed later). */
private List<IndexedItem> boldingData = null;
/** Whether or not to do highlighting */
private boolean bolding = true;
/** The summary class to be shown */
private String summary = null;
/** The name of the renderer to use for rendering the hits. */
private ComponentSpecification format = RendererRegistry.defaultRendererId.toSpecification();
/** Whether optional timing data should be rendered */
private boolean timing = false;
/** Set of explicitly requested summary fields, instead of summary classes */
@NonNull
private Set<String> summaryFields = LazySet.newHashSet();
private static final Splitter COMMA_SPLITTER = Splitter.on(',').omitEmptyStrings().trimResults();
public Presentation(Query parent) { }
/** Returns how terms in this result should be highlighted, or null if not set */
public Highlight getHighlight() { return highlight; }
/** Sets how terms in this result should be highlighted. Set to null to turn highlighting off */
public void setHighlight(Highlight highlight) { this.highlight = highlight; }
/** Returns the name of the summary class to be used to present hits from this query, or null if not set */
public String getSummary() { return summary; }
/** Sets the name of the summary class to be used to present hits from this query */
public void setSummary(String summary) { this.summary = summary; }
/** Returns whether matching query terms should be bolded in the result. Default is true. */
public boolean getBolding() { return bolding; }
/** Sets whether matching query terms should be bolded in the result */
public void setBolding(boolean bolding) { this.bolding = bolding; }
/** @deprecated coverage information is always returned */
@Deprecated // OK
// TODO: Remove on Vespa 7
public boolean getReportCoverage() { return true; }
/** @deprecated coverage information is always returned */
@Deprecated // OK
// TODO: Remove on Vespa 7
public void setReportCoverage(boolean ignored) { }
/** Get the name of the format desired for result rendering. */
@NonNull
public ComponentSpecification getRenderer() { return format; }
/** Set the desired format for result rendering. If null, use the default renderer. */
public void setRenderer(@Nullable ComponentSpecification format) {
this.format = (format != null) ? format : RendererRegistry.defaultRendererId.toSpecification();
}
/**
* Get the name of the format desired for result rendering.
*/
@NonNull
public String getFormat() { return format.getName(); }
/**
* Set the desired format for result rendering. If null, use the default renderer.
*/
public void setFormat(@Nullable String format) {
setRenderer(ComponentSpecification.fromString(format));
}
@Override
public Object clone() {
try {
Presentation clone = (Presentation)super.clone();
if (boldingData != null)
clone.boldingData = new ArrayList<>(boldingData);
if (highlight != null)
clone.highlight = highlight.clone();
if (summaryFields != null) {
clone.summaryFields = LazySet.newHashSet();
clone.summaryFields.addAll(this.summaryFields);
}
return clone;
}
catch (CloneNotSupportedException e) {
throw new RuntimeException("Someone inserted a noncloneable superclass",e);
}
}
@Override
public boolean equals(Object o) {
if (o == null || !(o instanceof Presentation)) return false;
Presentation p = (Presentation) o;
return QueryHelper.equals(bolding,p.bolding) && QueryHelper.equals(summary,p.summary);
}
@Override
public int hashCode() {
return QueryHelper.combineHash(bolding, summary);
}
/**
* @return whether to add optional timing data to the rendered result
*/
public boolean getTiming() {
return timing;
}
public void setTiming(boolean timing) {
this.timing = timing;
}
/**
* Return the set of explicitly requested fields. Returns an empty set if no
* fields are specified outside of summary classes. The returned set is
* mutable and fields may be added or removed before passing on the query.
*
* @return the set of names of requested fields, never null
*/
@NonNull
public Set<String> getSummaryFields() {
return summaryFields;
}
/** Prepares this for binary serialization. For internal use - see {@link Query#prepare} */
public void prepare() {
if (highlight != null)
highlight.prepare();
}
/**
* Parse the given string as a comma delimited set of field names and
* overwrite the set of summary fields. Whitespace will be trimmed. If you
* want to add or remove fields programmatically, use
* {@link #getSummaryFields()} and modify the returned set.
*
* @param asString
* the summary fields requested, e.g. "price,author,title"
*/
public void setSummaryFields(String asString) {
summaryFields.clear();
for (String field : COMMA_SPLITTER.split(asString)) {
summaryFields.add(field);
}
}
}
|
