Modifier and Type | Field and Description |
---|---|
static String |
BOLDING |
static String |
FORMAT
The (short) name of the parameter holding the name of the return format to use
|
static String |
PRESENTATION |
static String |
REPORT_COVERAGE |
static String |
SUMMARY |
static String |
SUMMARY_FIELDS |
static String |
TIMING |
Constructor and Description |
---|
Presentation(Query parent) |
Modifier and Type | Method and Description |
---|---|
Object |
clone() |
boolean |
equals(Object o) |
static QueryProfileType |
getArgumentType() |
boolean |
getBolding()
Returns whether matching query terms should be bolded in the result.
|
String |
getFormat()
Get the name of the format desired for result rendering.
|
Highlight |
getHighlight()
Returns how terms in this result should be highlighted, or null if not set
|
com.yahoo.component.ComponentSpecification |
getRenderer()
Get the name of the format desired for result rendering.
|
boolean |
getReportCoverage()
Deprecated.
coverage information is always returned
|
String |
getSummary()
Returns the name of the summary class to be used to present hits from this query, or null if not set
|
Set<String> |
getSummaryFields()
Return the set of explicitly requested fields.
|
boolean |
getTiming() |
int |
hashCode() |
void |
prepare()
Prepares this for binary serialization.
|
void |
setBolding(boolean bolding)
Sets whether matching query terms should be bolded in the result
|
void |
setFormat(String format)
Set the desired format for result rendering.
|
void |
setHighlight(Highlight highlight)
Sets how terms in this result should be highlighted.
|
void |
setRenderer(com.yahoo.component.ComponentSpecification format)
Set the desired format for result rendering.
|
void |
setReportCoverage(boolean ignored)
Deprecated.
coverage information is always returned
|
void |
setSummary(String summary)
Sets the name of the summary class to be used to present hits from this query
|
void |
setSummaryFields(String asString)
Parse the given string as a comma delimited set of field names and
overwrite the set of summary fields.
|
void |
setTiming(boolean timing) |
public static final String PRESENTATION
public static final String BOLDING
public static final String TIMING
public static final String SUMMARY
public static final String REPORT_COVERAGE
public static final String SUMMARY_FIELDS
public static final String FORMAT
public Presentation(Query parent)
public static QueryProfileType getArgumentType()
public Highlight getHighlight()
public void setHighlight(Highlight highlight)
public String getSummary()
public void setSummary(String summary)
public boolean getBolding()
public void setBolding(boolean bolding)
@Deprecated public boolean getReportCoverage()
@Deprecated public void setReportCoverage(boolean ignored)
@NonNull public com.yahoo.component.ComponentSpecification getRenderer()
public void setRenderer(@Nullable com.yahoo.component.ComponentSpecification format)
@NonNull public String getFormat()
public void setFormat(@Nullable String format)
public boolean getTiming()
public void setTiming(boolean timing)
@NonNull public Set<String> getSummaryFields()
public void prepare()
Query.prepare()
public void setSummaryFields(String asString)
getSummaryFields()
and modify the returned set.asString
- the summary fields requested, e.g. "price,author,title"Copyright © 2018. All rights reserved.