Presentation (container-search 6.274.30 API)

java.lang.Object
- com.yahoo.search.query.Presentation

All Implemented Interfaces:

Cloneable
```
public class Presentation
extends Object
implements Cloneable
```
Parameters deciding how the result of a query should be presented

Author:

Arne Bergene Fossaa

Field Summary

Fields
Modifier and Type	Field and Description
`private static QueryProfileType`	`argumentType` The type representing the property arguments consumed by this
`private boolean`	`bolding` Whether or not to do highlighting
`static String`	`BOLDING`
`private List<IndexedItem>`	`boldingData` The terms to highlight in the result (only used by BoldingSearcher, may be removed later).
`private static com.google.common.base.Splitter`	`COMMA_SPLITTER`
`private com.yahoo.component.ComponentSpecification`	`format` The name of the renderer to use for rendering the hits.
`static String`	`FORMAT` The (short) name of the parameter holding the name of the return format to use
`private Highlight`	`highlight` How the result should be highlighted
`static String`	`PRESENTATION`
`static String`	`REPORT_COVERAGE`
`private String`	`summary` The summary class to be shown
`static String`	`SUMMARY`
`static String`	`SUMMARY_FIELDS`
`private Set<String>`	`summaryFields` Set of explicitly requested summary fields, instead of summary classes
`private boolean`	`timing` Whether optional timing data should be rendered
`static String`	`TIMING`

Constructor Summary

Constructors
Constructor and Description

Presentation(Query parent)

Constructors
Constructor and Description
`Presentation(Query parent)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - argumentType
```
private static QueryProfileType argumentType
```
    The type representing the property arguments consumed by this
  - PRESENTATION
```
public static final String PRESENTATION
```
    See Also:
    
    Constant Field Values
  - BOLDING
```
public static final String BOLDING
```
    See Also:
    
    Constant Field Values
  - TIMING
```
public static final String TIMING
```
    See Also:
    
    Constant Field Values
  - SUMMARY
```
public static final String SUMMARY
```
    See Also:
    
    Constant Field Values
  - REPORT_COVERAGE
```
public static final String REPORT_COVERAGE
```
    See Also:
    
    Constant Field Values
  - SUMMARY_FIELDS
```
public static final String SUMMARY_FIELDS
```
    See Also:
    
    Constant Field Values
  - FORMAT
```
public static final String FORMAT
```
    The (short) name of the parameter holding the name of the return format to use
    
    See Also:
    
    Constant Field Values
  - highlight
```
private Highlight highlight
```
    How the result should be highlighted
  - boldingData
```
private List<IndexedItem> boldingData
```
    The terms to highlight in the result (only used by BoldingSearcher, may be removed later).
  - bolding
```
private boolean bolding
```
    Whether or not to do highlighting
  - summary
```
private String summary
```
    The summary class to be shown
  - format
```
private com.yahoo.component.ComponentSpecification format
```
    The name of the renderer to use for rendering the hits.
  - timing
```
private boolean timing
```
    Whether optional timing data should be rendered
  - summaryFields
```
@NonNull
private Set<String> summaryFields
```
    Set of explicitly requested summary fields, instead of summary classes
  - COMMA_SPLITTER
```
private static final com.google.common.base.Splitter COMMA_SPLITTER
```
- Constructor Detail
  - Presentation
```
public Presentation(Query parent)
```
- Method Detail
  - getArgumentType
```
public static QueryProfileType getArgumentType()
```
  - getHighlight
```
public Highlight getHighlight()
```
    Returns how terms in this result should be highlighted, or null if not set
  - setHighlight
```
public void setHighlight(Highlight highlight)
```
    Sets how terms in this result should be highlighted. Set to null to turn highlighting off
  - getSummary
```
public String getSummary()
```
    Returns the name of the summary class to be used to present hits from this query, or null if not set
  - setSummary
```
public void setSummary(String summary)
```
    Sets the name of the summary class to be used to present hits from this query
  - getBolding
```
public boolean getBolding()
```
    Returns whether matching query terms should be bolded in the result. Default is true.
  - setBolding
```
public void setBolding(boolean bolding)
```
    Sets whether matching query terms should be bolded in the result
  - getReportCoverage
```
@Deprecated
public boolean getReportCoverage()
```
    Deprecated. coverage information is always returned
  - setReportCoverage
```
@Deprecated
public void setReportCoverage(boolean ignored)
```
    Deprecated. coverage information is always returned
  - getRenderer
```
@NonNull
public com.yahoo.component.ComponentSpecification getRenderer()
```
    Get the name of the format desired for result rendering.
  - setRenderer
```
public void setRenderer(@Nullable
                        com.yahoo.component.ComponentSpecification format)
```
    Set the desired format for result rendering. If null, use the default renderer.
  - getFormat
```
@NonNull
public String getFormat()
```
    Get the name of the format desired for result rendering.
  - setFormat
```
public void setFormat(@Nullable
                      String format)
```
    Set the desired format for result rendering. If null, use the default renderer.
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getTiming
```
public boolean getTiming()
```
    Returns:
    
    whether to add optional timing data to the rendered result
  - setTiming
```
public void setTiming(boolean timing)
```
  - getSummaryFields
```
@NonNull
public Set<String> getSummaryFields()
```
    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.
    
    Returns:
    
    the set of names of requested fields, never null
  - prepare
```
public void prepare()
```
    Prepares this for binary serialization. For internal use - see Query.prepare()
  - setSummaryFields
```
public void setSummaryFields(String asString)
```
    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 getSummaryFields() and modify the returned set.
    
    Parameters:
    
    asString - the summary fields requested, e.g. "price,author,title"

Class Presentation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

argumentType

PRESENTATION

BOLDING

TIMING

SUMMARY

REPORT_COVERAGE

SUMMARY_FIELDS

FORMAT

highlight

boldingData

bolding

summary

format

timing

summaryFields

COMMA_SPLITTER

Constructor Detail

Presentation

Method Detail

getArgumentType

getHighlight

setHighlight

getSummary

setSummary

getBolding

setBolding

getReportCoverage

setReportCoverage

getRenderer

setRenderer

getFormat

setFormat

clone

equals

hashCode

getTiming

setTiming

getSummaryFields

prepare

setSummaryFields